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.
_addStdModContentnode
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.
node
Node
The section Node to be updated.
children
Node | NodeList | String
The new content Node, NodeList or String to be added to section Node provided.
where
String
Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the Node.
_afterBodyChangee
Default attribute change listener for the bodyContent attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_afterFillHeightChangee
Default attribute change listener for the fillHeight attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_afterHeaderChangee
Default attribute change listener for the headerContent attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_applyStdModParsedConfigThis method is injected before the _applyParsedConfig step in the application of HTML_PARSER, 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
_bindUIStdModBinds 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.
_eraseStdModsection
Removes the DOM node for the given section.
section
String
The section to remove. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
_fillHeightUpdates 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").
_findStdModSectionsection
Helper method to to find the rendered node for the given section, if it exists.
section
String
The section for which the render Node is to be found. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
The rendered node for the given section, or null if not found.
_getPreciseHeightnode
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.
node
Node
The node for which the precise height is required.
The height of the Node including borders and padding, possibly a float.
_getStdModContentsection
Retrieves the child nodes (content) of a standard module section
section
String
The standard module section whose child nodes are to be retrieved. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
The child node collection of the standard module section.
_getStdModTemplatesection
Gets a new Node reference for the given standard module section, by cloning the stored template node.
section
String
The section to create a new node for. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
The new Node instance for the section
_insertStdModSectioncontentBox
section
sectionNode
Helper method to insert the Node for the given section into the correct location in the contentBox.
_parseStdModHTMLsection
Utility method, used by WidgetStdMods HTML_PARSER implementation to extract data for each section from markup.
section
String
Inner HTML string with the contents of the section
_renderStdModsection
Creates the DOM node for the given section, and inserts it into the correct location in the contentBox.
section
String
The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
A reference to the added section node
_renderUIStdModCreates/Initializes the DOM for standard module support.
This method is invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.
_syncUIStdModSynchronizes 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.
_uiSetFillHeightfillSection
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.
fillSection
String
A valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER
_uiSetStdModsection
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.
section
String
The section to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
content
String | Node
The new content (either as an HTML string, or Node reference) to add to the section
where
String
Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the section.
_validateFillHeightval
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.
val
String
The section which should be setup to fill height, or false/null to disable fillHeight
true if valid, false if not
fillHeightnode
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.
node
Node
The 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.
getStdModNodesection
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.
The node reference for the section, or null if not set.
setStdModContentsection
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.
section
String
The standard module section whose content is to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.
content
String | Node
The content to be added, either an HTML string or a Node reference.
where
String
Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE. If not provided, the content will replace existing content in the section.
AFTERConstant 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.
ATTRSStatic property used to define the default attribute configuration introduced by WidgetStdMod.
BEFOREConstant 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.
BODYConstant used to refer the the standard module body, in methods which expect a section specifier
FOOTERConstant used to refer the the standard module footer, in methods which expect a section specifier
HEADERConstant used to refer the the standard module header, in methods which expect a section specifier
REPLACEConstant 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_NAMESStatic hash of default class names used for the header, body and footer sections of the standard module, keyed by the section identifier (WidgetStdMod.STD_HEADER, WidgetStdMod.STD_BODY, WidgetStdMod.STD_FOOTER)
TEMPLATESThe 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>'
}
bodyContentThe 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
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.
e
EventFacade
fillHeightThe 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
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.
e
EventFacade
headerContentThe 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
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.
e
EventFacade