Yahoo! UI Library

Accordion  1.0

Yahoo! UI Library > Accordion > Accordion
Search:
 
Filters

Class Accordion - extends Widget - uses WidgetParent, MakeNode

A collection of vertically aligned collapsible panels

Properties

_ATTRS_2_UI - protected static object

Defines the attributes that MakeNode should link to _uiSetXxxx methods to reflect them in the UI.

_EVENTS - protected static Object

Defines events that are to be associated to listeners by MakeNode. Here it links a couple of events from the items, expandedChange to ensure only one panel is open at a time and panelClose to destroy and remove a panel

Methods

private void ( ev )
Listens to the panelClose and destroys the panel and removes it from the collection of panels.
Parameters:
ev <EventFacade> uses ev.target to locate the panel requesting the close

_afterChildExpanded

private void _afterChildExpanded ( ev )
Event listener for child expansion/collapse, ensures that only one is expanded at a time if multiExpand is not set.
Parameters:
ev <EventFacade>

_uiSetCloseable

private void _uiSetCloseable ( value )
Sets the closeable attribute of all panels to the value set for the whole accordion
Parameters:
value <Boolean> new value of the closeable attribute

_uiSetResizeable

private void _uiSetResizeable ( value )
Sets the resizeable attribute of all panels to the value set for the whole accordion
Parameters:
value <Boolean> new value of the resizeable attribute

Events

closeableChange

closeableChange ( event )
Fires when the value for the configuration attribute 'closeable' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

defaultChildTypeChange

defaultChildTypeChange ( event )
Fires when the value for the configuration attribute 'defaultChildType' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

multiExpandChange

multiExpandChange ( event )
Fires when the value for the configuration attribute 'multiExpand' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

resizeableChange

resizeableChange ( event )
Fires when the value for the configuration attribute 'resizeable' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

Configuration Attributes

closeable - Boolean

Helper attribute to set all panels closeable attribute at once. May be overriden in each panel separately.
Default Value: true

defaultChildType - protected WidgetChild

Default type of children to create. Used by WidgetParent.
Default Value: AccordionPanel

multiExpand - Boolean

Whether several panels may be expanded at once.
Default Value: true

resizeable - Boolean

Helper attribute to set all panels resizeable attribute at once. May be overriden in each panel separately. Requires the optional resize-plugin module to be loaded.
Default Value: true


Copyright © 2011 Yahoo! Inc. All rights reserved.