WidgetStdMod Class
Widget extension, which can be used to add Standard Module support to the base Widget class, through the Base.build method.
The extension adds header, body and footer sections to the Widget's content box and provides the corresponding methods and attributes to modify the contents of these sections.
Item Index
Methods
- _addStdModContent
- _afterBodyChange
- _afterFillHeightChange
- _afterFooterChange
- _afterHeaderChange
- _applyStdModParsedConfig
- _bindUIStdMod
- _eraseStdMod
- _fillHeight
- _findStdModSection
- _getPreciseHeight
- _getStdModContent
- _getStdModTemplate
- _insertStdModSection
- _parseStdModHTML
- _renderStdMod
- _renderUIStdMod
- _syncUIStdMod
- _uiSetFillHeight
- _uiSetStdMod
- _validateFillHeight
- fillHeight
- getStdModNode
- setStdModContent
Properties
- AFTER static
- ATTRS static
- BEFORE static
- BODY static
- FOOTER static
- HEADER static
- HTML_PARSER static
- REPLACE static
- SECTION_CLASS_NAMES static
- TEMPLATES static
Attributes
Methods
_addStdModContent
-
node -
children -
where
Helper method to add content to a StdMod section node.
The content is added either before, after or replaces the existing node content
based on the value of the where argument.
Parameters:
-
nodeNodeThe section Node to be updated.
-
childrenNode | NodeList | StringThe new content Node, NodeList or String to be added to section Node provided.
-
whereStringOptional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the Node.
_afterBodyChange
-
e
Default attribute change listener for the bodyContent attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_afterFillHeightChange
-
e
Default attribute change listener for the fillHeight attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_afterHeaderChange
-
e
Default attribute change listener for the headerContent attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_applyStdModParsedConfig
()
private
This method is injected before the applyParsedConfig step in the application of HTMLPARSER, and sets up the state to identify whether or not we should remove the current DOM content or not, based on whether or not the current content attribute value was extracted from the DOM, or provided by the user configuration
_bindUIStdMod
()
protected
Binds event listeners responsible for updating the UI state in response to Widget standard module related state changes.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_eraseStdMod
-
section
Removes the DOM node for the given section.
Parameters:
-
sectionStringThe section to remove. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
_fillHeight
()
private
Updates the rendered UI, to resize the current section specified by the fillHeight attribute, so that the standard module fills out the Widget height. If a height has not been set on Widget, the section is not resized (height is set to "auto").
_findStdModSection
-
section
Helper method to to find the rendered node for the given section, if it exists.
Parameters:
-
sectionStringThe section for which the render Node is to be found. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
Returns:
_getPreciseHeight
-
node
Helper method to obtain the precise height of the node provided, including padding and border. The height could be a sub-pixel value for certain browsers, such as Firefox 3.
Parameters:
-
nodeNodeThe node for which the precise height is required.
Returns:
_getStdModContent
-
section
Retrieves the child nodes (content) of a standard module section
Parameters:
-
sectionStringThe standard module section whose child nodes are to be retrieved. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
Returns:
_getStdModTemplate
-
section
Gets a new Node reference for the given standard module section, by cloning the stored template node.
Parameters:
-
sectionStringThe section to create a new node for. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
Returns:
_insertStdModSection
-
contentBox -
section -
sectionNode
Helper method to insert the Node for the given section into the correct location in the contentBox.
_parseStdModHTML
-
section
Utility method, used by WidgetStdMods HTML_PARSER implementation to extract data for each section from markup.
Parameters:
-
sectionString
Returns:
_renderStdMod
-
section
Creates the DOM node for the given section, and inserts it into the correct location in the contentBox.
Parameters:
-
sectionStringThe section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
Returns:
_renderUIStdMod
()
protected
Creates/Initializes the DOM for standard module support.
This method is invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.
_syncUIStdMod
()
protected
Synchronizes the UI to match the Widgets standard module state.
This method is invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.
_uiSetFillHeight
-
fillSection
Updates the rendered UI, to resize the provided section so that the standard module fills out the specified widget height. Note: This method does not check whether or not a height is set on the Widget.
Parameters:
-
fillSectionStringA valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER
_uiSetStdMod
-
section -
content -
where
Updates the rendered UI, adding the provided content (either an HTML string, or node reference),
to the specified section. The content is either added before, after or replaces existing content
in the section, based on the value of the where argument.
Parameters:
-
sectionStringThe section to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
-
contentString | NodeThe new content (either as an HTML string, or Node reference) to add to the section
-
whereStringOptional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the section.
_validateFillHeight
-
val
Default validator for the fillHeight attribute. Verifies that the value set is a valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER, or a falsey value if fillHeight is to be disabled.
Parameters:
-
valStringThe section which should be setup to fill height, or false/null to disable fillHeight
Returns:
fillHeight
-
node
Sets the height on the provided header, body or footer element to fill out the height of the Widget. It determines the height of the widgets bounding box, based on it's configured height value, and sets the height of the provided section to fill out any space remaining after the other standard module section heights have been accounted for.
NOTE: This method is not designed to work if an explicit height has not been set on the Widget, since for an "auto" height Widget, the heights of the header/body/footer will drive the height of the Widget.
Parameters:
-
nodeNodeThe node which should be resized to fill out the height of the Widget bounding box. Should be a standard module section node which belongs to the widget.
getStdModNode
-
section -
forceCreate
Returns the node reference for the specified section.
Note: The DOM is not queried for the node reference. The reference
stored by the widget instance is returned if it was set. Passing a
truthy for forceCreate will create the section node if it does not
already exist.
Parameters:
Returns:
section, or null if not set.
setStdModContent
-
section -
content -
where
Updates the body section of the standard module with the content provided (either an HTML string, or node reference).
This method can be used instead of the corresponding section content attribute if you'd like to retain the current content of the section,
and insert content before or after it, by specifying the where argument.
Parameters:
-
sectionStringThe standard module section whose content is to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
-
contentString | NodeThe content to be added, either an HTML string or a Node reference.
-
whereStringOptional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the section.
Properties
AFTER
String
static
Constant used to specify insertion position, when adding content to sections of the standard module in methods which expect a "where" argument.
Inserts new content before the sections existing content.
ATTRS
Object
static
Static property used to define the default attribute configuration introduced by WidgetStdMod.
BEFORE
String
static
Constant used to specify insertion position, when adding content to sections of the standard module in methods which expect a "where" argument.
Inserts new content before the sections existing content.
BODY
String
static
Constant used to refer the the standard module body, in methods which expect a section specifier
FOOTER
String
static
Constant used to refer the the standard module footer, in methods which expect a section specifier
HEADER
String
static
Constant used to refer the the standard module header, in methods which expect a section specifier
REPLACE
String
static
Constant used to specify insertion position, when adding content to sections of the standard module in methods which expect a "where" argument.
Replaces the sections existing content, with new content.
SECTION_CLASS_NAMES
Object
static
Static hash of default class names used for the header, body and footer sections of the standard module, keyed by the section identifier (WidgetStdMod.STDHEADER, WidgetStdMod.STDBODY, WidgetStdMod.STD_FOOTER)
TEMPLATES
Object
static
The template HTML strings for each of the standard module sections. Section entries are keyed by the section constants, WidgetStdMod.HEADER, WidgetStdMod.BODY, WidgetStdMod.FOOTER, and contain the HTML to be added for each section. e.g.
{
header : '<div class="yui-widget-hd"></div>',
body : '<div class="yui-widget-bd"></div>',
footer : '<div class="yui-widget-ft"></div>'
}
Attributes
bodyContent
HTML
The content to be added to the body section. This will replace any existing content in the body. If you want to append, or insert new content, use the setStdModContent method.
Default: undefined
Fires event bodyContentChange
Fires when the value for the configuration attribute bodyContent is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
fillHeight
String
The section (WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER) which should be resized to fill the height of the standard module, when a height is set on the Widget. If a height is not set on the widget, then all sections are sized based on their content.
Default: WidgetStdMod.BODY
Fires event fillHeightChange
Fires when the value for the configuration attribute fillHeight is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
headerContent
HTML
The content to be added to the header section. This will replace any existing content in the header. If you want to append, or insert new content, use the setStdModContent method.
Default: undefined
Fires event headerContentChange
Fires when the value for the configuration attribute headerContent is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added: