PageLayout Class
Manages header (layout-hd), body (layout-bd), footer (layout-ft) stacked vertically to either fit inside the viewport (fit-to-viewport) or adjust to the size of the body content (fit-to-content).
The body content is sub-divided into modules, arranged either in rows or columns. The layout is automatically detected based on the marker classes attached to the two layers of divs inside layout-bd: either layout-module-row > layout-module or layout-module-col > layout-module
Each module has an optional header (layout-m-hd), a body (layout-m-bd),
and an optional footer (layout-m-ft). You can have multiple
layout-m-bd's, but only one can be visible at a time. If you change the
DOM in any way that affects the height of any module header, body, or
footer, or if you switch bodies, you must call elementResized()
to
reflow the layout. (Technically, you do not have to call
elementResized()
if you modify a module body in fit-to-viewport mode,
but if you later decide to switch to fit-to-content, your optimization
will cause trouble.)
If you want a row, column, or module to have a fixed size, add the class layout-not-managed to the layout-module-row, layout-module-column, or layout-module. Then use CSS to set the width of layout-module (for a row) or layout-module-col (for a col), or the height of layout-m-bd.
If the body content is a single module, it expands as the content expands (fit-to-content) until it would push the footer below the fold. Then it switches to fit-to-viewport so the scrollbar appears on the module instead of the entire viewport. (If you do not want this behavior in a particular case, add the class FORCE_FIT to layout-bd.)
Note that a non-zero margin-top on the top element or a non-zero margin-bottom on the bottom element inside any container will break the layout because browsers lie about the total height of the container in this case. Use padding instead of margin on elements inside headers and footers.
If you wish to display a loading message that automatically disappears
after the first time the layout is calculated, add the class
layout-loading
to the div containing the message. (To be visible,
this div must not be inside the div with class layout-bd
, since that
has visibility:hidden
.)
Constructor
PageLayout
-
config
Parameters:
-
config
Object
Item Index
Methods
- _addAttrs
- _addLazyAttr
- _addOutOfOrder
- _aggregateAttrs
- _analyzeModule
- _attrCfgHash
- _baseDestroy
- _baseInit
- _cloneDefaultValue
- _defAttrChangeFn
- _defDestroyFn
- _defInitFn
- _destroyHierarchy
- _filterAdHocAttrs
- _fireAttrChange
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getFullType
- _getInstanceAttrCfgs
- _getStateVal
- _getType
- _hasPotentialSubscribers
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _isLazyAttr
- _monitor
- _normAttrVals
- _parseType
- _preInitEventCfg
- _protectAttrs deprecated
- _publish
- _set
- _setAttr
- _setAttrs
- _setAttrVal
- _setStateVal
- _setWidth
- addAttr
- addAttrs
- addTarget
- after
- attrAdded
- before
- bubble
- collapseModule
- destroy
- detach
- detachAll
- elementResized
- expandModule
- fire
- get
- getAttrs
- getBodyContainer
- getBodyHeight
- getEvent
- getFooterContainer
- getFooterHeight
- getHeaderContainer
- getHeaderHeight
- getTargets
- init
- modifyAttr
- moduleIsCollapsed
- on
- once
- onceAfter
- parseType
- publish
- removeAttr
- removeTarget
- rescanBody
- reset
- set
- setAttrs
- subscribe deprecated
- toggleModule
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
Properties
- _allowAdHocAttrs
- collapse_left_nub_class static
- collapse_right_nub_class static
- collapse_vert_nub_class static
- collapsed_horiz_class static
- collapsed_vert_class static
- expand_left_nub_class static
- expand_right_nub_class static
- expand_vert_nub_class static
- FIT_TO_CONTENT static
- fit_to_content_class static
- FIT_TO_VIEWPORT static
- fit_to_viewport_class static
- force_fit_class static
- min_module_height static
- module_body_class static
- module_class static
- module_cols_class static
- module_footer_class static
- module_header_class static
- module_rows_class static
- name deprecated
- not_managed_class static
- page_body_class static
- page_footer_class static
- page_header_class static
Methods
_addAttrs
-
cfgs
-
values
-
lazy
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only. -
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
_addLazyAttr
-
name
-
[lazyCfg]
Parameters:
-
name
ObjectThe name of the attribute -
[lazyCfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.
_addOutOfOrder
-
name
-
cfg
Parameters:
-
name
Stringattribute name -
cfg
Objectattribute configuration
_aggregateAttrs
-
allAttrs
Parameters:
-
allAttrs
ArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_analyzeModule
-
root
Returns the components of the module.
Parameters:
-
root
Node.layout-module
Returns:
root,hd,bd,ft
_attrCfgHash
()
private
_baseDestroy
()
private
_baseInit
()
private
_cloneDefaultValue
-
cfg
Parameters:
-
cfg
Object
_defAttrChangeFn
-
e
-
eventFastPath
Parameters:
-
e
EventFacadeThe event object for attribute change events. -
eventFastPath
BooleanWhether or not we're using this as a fast path in the case of no listeners or not
_defInitFn
-
e
Parameters:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_destroyHierarchy
()
private
_filterAdHocAttrs
-
allAttrs
-
userVals
Parameters:
-
allAttrs
ObjectThe set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty. -
userVals
ObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
_fireAttrChange
-
attrName
-
subAttrName
-
currVal
-
newVal
-
opts
-
[cfg]
Parameters:
-
attrName
StringThe name of the attribute -
subAttrName
StringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null. -
currVal
AnyThe current value of the attribute -
newVal
AnyThe new value of the attribute -
opts
ObjectAny additional event data to mix into the attribute change event's event facade. -
[cfg]
Object optionalThe attribute config stored in State, if already available.
_getAttr
-
name
Parameters:
-
name
StringThe name of the attribute.
Returns:
_getAttrCfg
-
name
Parameters:
-
name
StringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
_getAttrCfgs
()
Object
protected
Returns:
_getAttrInitVal
-
attr
-
cfg
-
initValues
Parameters:
-
attr
StringThe name of the attribute -
cfg
ObjectThe attribute configuration object -
initValues
ObjectThe object with simple and complex attribute name/value pairs returned from _normAttrVals
Returns:
_getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
_getClasses
()
Function
protected
Returns:
_getFullType
-
type
Parameters:
-
type
StringThe short type to prefix
Returns:
_getInstanceAttrCfgs
-
allCfgs
addAttrs
,
from the static cached ATTRS for the class.
Parameters:
-
allCfgs
ObjectThe set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
Returns:
addAttrs
.
_getStateVal
-
name
-
[cfg]
Parameters:
-
name
StringThe name of the attribute -
[cfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
Returns:
_getType
()
private
_hasPotentialSubscribers
-
fullType
Parameters:
-
fullType
StringThe fully prefixed type name
Returns:
_initAttrHost
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor. -
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required. -
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initAttribute
()
private
_initAttrs
-
attrs
-
values
-
lazy
Parameters:
-
attrs
ObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor. -
values
ObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required. -
lazy
BooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Parameters:
-
config
ObjectThe constructor configuration object
_initHierarchy
-
userVals
Parameters:
-
userVals
ObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
_isLazyAttr
-
name
Parameters:
-
name
StringThe name of the attribute
Returns:
_monitor
-
what
-
eventType
-
o
Parameters:
-
what
String'attach', 'detach', 'fire', or 'publish' -
eventType
String | CustomEventThe prefixed name of the event being monitored, or the CustomEvent object. -
o
ObjectInformation about the event interaction, such as fire() args, subscription category, publish config
_normAttrVals
-
valueHash
Parameters:
-
valueHash
ObjectAn object with attribute name/value pairs
Returns:
_parseType
()
private
_preInitEventCfg
-
config
Parameters:
-
config
ObjectThe user configuration object
_protectAttrs
-
attrs
Parameters:
-
attrs
ObjectA hash of attribute to configuration object pairs.
Returns:
_publish
-
fullType
-
etOpts
-
ceOpts
type
to fullType
conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
Parameters:
-
fullType
StringThe prefixed type of the event to publish. -
etOpts
ObjectThe EventTarget specific configuration to mix into the published event. -
ceOpts
ObjectThe publish specific configuration to mix into the published event.
Returns:
etOpts
or ceOpts
, this will
be the default CustomEvent
instance, and can be configured independently.
_set
-
name
-
val
-
[opts]
Parameters:
-
name
StringThe name of the attribute. -
val
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
_setAttr
-
name
-
value
-
[opts]
-
force
Parameters:
-
name
StringThe name of the attribute. -
value
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change. -
force
BooleanIf true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
Returns:
_setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs. -
[opts]
Object optionalOptional data providing the circumstances for the change
Returns:
_setAttrVal
-
attrName
-
subAttrName
-
prevVal
-
newVal
-
[opts]
-
[attrCfg]
Parameters:
-
attrName
StringThe attribute name. -
subAttrName
StringThe sub-attribute name, if setting a sub-attribute property ("x.y.z"). -
prevVal
AnyThe currently stored value of the attribute. -
newVal
AnyThe value which is going to be stored. -
[opts]
Object optionalOptional data providing the circumstances for the change. -
[attrCfg]
Object optionalOptional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
Returns:
_setStateVal
-
name
-
value
Parameters:
-
name
StringThe name of the attribute -
value
AnyThe value of the attribute
_setWidth
-
children
-
w
Set the width of a module.
Parameters:
-
children
Objectroot,hd,bd,ft
-
w
Numberwidth in pixels
addAttr
-
name
-
config
-
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
- value <Any>
- The initial value to set on the attribute
- valueFn <Function | String>
-
A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.
valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
- readOnly <boolean>
- Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
- writeOnce <boolean> or <string>
-
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
can only have their values set once, be it through the default configuration,
constructor configuration arguments, or by invoking set.
The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)
- setter <Function | String>
-
The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.
setter can also be set to a string, representing the name of the instance method to be used as the setter function.
- getter <Function | String>
-
The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.
getter can also be set to a string, representing the name of the instance method to be used as the getter function.
- validator <Function | String>
-
The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.
validator can also be set to a string, representing the name of the instance method to be used as the validator function.
- lazyAdd <boolean>
- Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
Parameters:
-
name
StringThe name of the attribute. -
config
ObjectAn object with attribute configuration property/value pairs, specifying the configuration for the attribute.NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
-
lazy
Boolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
addAttrs
-
cfgs
-
values
-
lazy
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
Parameters:
-
cfgs
ObjectAn object with attribute name/configuration pairs. -
values
ObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only. -
lazy
BooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
Returns:
addTarget
-
o
Parameters:
-
o
EventTargetthe target to add
after
-
type
-
fn
-
[context]
-
[arg*]
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
attrAdded
-
name
Parameters:
-
name
StringThe name of the attribute to check.
Returns:
before
()
Returns:
bubble
-
evt
Parameters:
-
evt
CustomEventthe custom event to propagate
Returns:
collapseModule
-
node
Collapse the specified module.
Parameters:
-
node
String | Node.layout-module
destroy
()
BaseCore
chainable
Returns:
A reference to this object
detach
-
type
-
fn
-
context
Parameters:
-
type
String | ObjectEither the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events. -
fn
FunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed. -
context
ObjectThe custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)
Returns:
detachAll
-
type
Parameters:
-
type
StringThe type, or name of the event
elementResized
-
el
Call this when something changes size, to request a reflow of the layout.
Parameters:
-
el
String | Nodeelement that changed size
Returns:
true if the element is inside the managed containers
fire
-
type
-
arguments
Parameters:
-
type
String | ObjectThe type of the event, or an object that contains a 'type' property. -
arguments
Objectan arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.
Returns:
get
-
name
Parameters:
-
name
StringThe name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g.get("x.y.z")
)
Returns:
getAttrs
-
attrs
Parameters:
-
attrs
String | BooleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
getEvent
-
type
-
prefixed
Parameters:
-
type
Stringthe type, or name of the event -
prefixed
Stringif true, the type is prefixed already
Returns:
getHeaderContainer
()
Node
Returns:
the header container (layout-hd) or null if there is no header
getTargets
()
Returns:
init
-
cfg
Parameters:
-
cfg
ObjectObject with configuration property name/value pairs
Returns:
modifyAttr
-
name
-
config
The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute:
- readOnly;
- writeOnce;
- broadcast; and
- getter.
Note: New attributes cannot be added using this interface. New attributes must be added using {{#crossLink "AttributeCore/addAttr:method"}}addAttr{{/crossLink}}, or an appropriate manner for a class which utilises Attributes (e.g. the {{#crossLink "Base/ATTRS:property"}}ATTRS{{/crossLink}} property in {{#crossLink "Base"}}Base{{/crossLink}}).
Parameters:
-
name
StringThe name of the attribute whose configuration is to be updated. -
config
ObjectAn object with configuration property/value pairs, specifying the configuration properties to modify.
moduleIsCollapsed
-
node
Parameters:
-
node
String | Node.layout-module
Returns:
true if module is collapsed
on
-
type
-
fn
-
[context]
-
[arg*]
emitFacade = true
will
receive an EventFacade
as the first argument (typically named "e").
These callbacks can then call e.preventDefault()
to disable the
behavior published to that event's defaultFn
. See the EventFacade
API for all available properties and methods. Subscribers to
non-emitFacade
events will receive the arguments passed to fire()
after the event name.
To subscribe to multiple events at once, pass an object as the first
argument, where the key:value pairs correspond to the eventName:callback.
this.on({
"attrChange" : this._onAttrChange,
"change" : this._onChange
});
You can also pass an array of event names as the first argument to
subscribe to all listed events with the same callback.
this.on([ "change", "attrChange" ], this._onChange);
Returning false
from a callback is supported as an alternative to
calling e.preventDefault(); e.stopPropagation();
. However, it is
recommended to use the event methods whenever possible.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
once
-
type
-
fn
-
[context]
-
[arg*]
on
except the
listener is immediatelly detached when it is executed.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
onceAfter
-
type
-
fn
-
[context]
-
[arg*]
after
except the
listener is immediatelly detached when it is executed.
Parameters:
-
type
StringThe name of the event -
fn
FunctionThe callback to execute in response to the event -
[context]
Object optionalOverridethis
object in callback -
[arg*]
Any optional0..n additional arguments to supply to the subscriber
Returns:
parseType
-
type
-
[pre]
Parameters:
-
type
Stringthe type -
[pre]
String optionalThe prefix. Defaults to this._yuievt.config.prefix
Returns:
publish
-
type
-
opts
Parameters:
-
type
Stringthe type, or name of the event -
opts
Objectoptional config params. Valid properties are:-
[broadcast=false]
Boolean optionalwhether or not the YUI instance and YUI global are notified when the event is fired.
-
[bubbles=true]
Boolean optionalWhether or not this event bubbles. Events can only bubble if
emitFacade
is true. -
[context=this]
Object optionalthe default execution context for the listeners.
-
[defaultFn]
Function optionalthe default function to execute when this event fires if preventDefault was not called.
-
[emitFacade=false]
Boolean optionalwhether or not this event emits a facade.
-
[prefix]
String optionalthe prefix for this targets events, e.g., 'menu' in 'menu:click'.
-
[fireOnce=false]
Boolean optionalif an event is configured to fire once, new subscribers after the fire will be notified immediately.
-
[async=false]
Boolean optionalfireOnce event listeners will fire synchronously if the event has already fired unless
async
istrue
. -
[preventable=true]
Boolean optionalwhether or not
preventDefault()
has an effect. -
[preventedFn]
Function optionala function that is executed when
preventDefault()
is called. -
[queuable=false]
Boolean optionalwhether or not this event can be queued during bubbling.
-
[silent]
Boolean optionalif silent is true, debug messages are not provided for this event.
-
[stoppedFn]
Function optionala function that is executed when stopPropagation is called.
-
[monitored]
Boolean optionalspecifies whether or not this event should send notifications about when the event has been attached, detached, or published.
-
[type]
String optionalthe event type (valid option if not provided as the first parameter to publish).
-
Returns:
removeAttr
-
name
Parameters:
-
name
StringThe name of the attribute to be removed.
rescanBody
()
Call this after manually adding or removing modules on the page.
reset
-
name
Parameters:
-
name
StringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
set
-
name
-
value
-
[opts]
Parameters:
-
name
StringThe name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g.set("x.y.z", 5)
). -
value
AnyThe value to set the attribute to. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
setAttrs
-
attrs
-
[opts]
Parameters:
-
attrs
ObjectAn object with attributes name/value pairs. -
[opts]
Object optionalOptional data providing the circumstances for the change.
Returns:
subscribe
()
deprecated
toggleModule
-
module
Toggle the collapsed state of the specified layout-module.
Parameters:
-
module
String | Node.layout-module
toString
()
String
Returns:
String representation for this object
unsubscribe
()
deprecated
unsubscribeAll
-
type
Parameters:
-
type
StringThe type, or name of the event
Properties
_allowAdHocAttrs
Boolean
protected
Default: undefined (false)
collapse_left_nub_class
String
static
Default: "layout-left-collapse-nub"
collapse_right_nub_class
String
static
Default: "layout-right-collapse-nub"
collapse_vert_nub_class
String
static
Default: "layout-vert-collapse-nub"
collapsed_horiz_class
String
static
Default: "layout-collapsed-horiz"
collapsed_vert_class
String
static
Default: "layout-collapsed-vert"
expand_left_nub_class
String
static
Default: "layout-left-expand-nub"
expand_right_nub_class
String
static
Default: "layout-right-expand-nub"
expand_vert_nub_class
String
static
Default: "layout-vert-expand-nub"
FIT_TO_CONTENT
Unknown
static
fit_to_content_class
String
static
Default: "FIT_TO_CONTENT"
FIT_TO_VIEWPORT
Unknown
static
fit_to_viewport_class
String
static
Default: "FIT_TO_VIEWPORT"
force_fit_class
String
static
Default: "FORCE_FIT"
module_body_class
String
static
Default: "layout-m-bd"
module_class
String
static
Default: "layout-module"
module_cols_class
String
static
module_header_class
String
static
Default: "layout-m-hd"
module_rows_class
String
static
name
String
deprecated
not_managed_class
String
static
Default: "layout-not-managed"
page_body_class
String
static
Default: "layout-bd"
page_header_class
String
static
Default: "layout-hd"
Attributes
body
String | Node
Selector identifying the element which contains layout-(hd|bd|ft). This cannot be used to attach PageLayout to only part of the page. It should only be used when the page content is unavoidably embedded inside an element which fills the page.
Default: "body"
destroyed
Boolean
readonly
Default: false
initialized
Boolean
readonly
Default: false
matchColumnHeights
Boolean
When organizing modules into columns in FIT_TO_CONTENT mode, set this to false to allow each column to be a different height.
Default: true
minHeight
Number em's
Minimum page height in FIT_TO_VIEWPORT mode, measured in em's. The page content will not collapse lower than this height. If the viewport is smaller, the brower's vertical scrollbar will appear.
Default: 44 (em) 570px @ 13px font
minWidth
Number em's
Minimum page width, measured in em's. The page content will not collapse narrower than this width. If the viewport is smaller, the brower's horizontal scrollbar will appear.
Default: 73 (em) 950px @ 13px font
mode
PageLayout.FIT_TO_VIEWPORT or PageLayout.FIT_TO_CONTENT
FIT_TO_VIEWPORT sizes the rows to fit everything inside the browser's viewport. FIT_TO_CONTENT sizes the rows to eliminate all scrollbars on module bodies. Note that you can configure this property by putting the CSS class "FIT_TO_VIEWPORT" or "FIT_TO_CONTENT" on layout-bd.
Default: PageLayout.FIT_TO_VIEWPORT
Events
afterCollapseModule
Fires after a module is collapsed.
Event Payload:
-
bd
Nodethe module body (layout-m-bd)
afterExpandModule
Fires after a module is expanded.
Event Payload:
-
bd
Nodethe module body (layout-m-bd)
afterReflow
Fires after the layout is completely reflowed, including viewport scrollbar changes.
afterResizeModule
Fires after a module is resized.
beforeCollapseModule
Fires before a module is collapsed.
Event Payload:
-
bd
Nodethe module body (layout-m-bd)
beforeExpandModule
Fires before a module is expanded.
Event Payload:
-
bd
Nodethe module body (layout-m-bd)
beforeReflow
Fires before the layout is reflowed.
beforeResizeModule
Fires before a module is resized.
destroy
Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.
Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).
Event Payload:
-
e
EventFacadeEvent object
init
Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.
Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).
Event Payload:
-
e
EventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.