Class TogglePanel
TogglePanel
Defined in: togglePanel.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
TogglePanel(componentId, options)
|
| Method Attributes | Method Name and Description |
|---|---|
|
getItems()
|
|
|
getNextItem(name)
|
|
|
lastItem()
|
|
|
nextItem(itemName)
|
|
|
prevItem(itemName)
|
|
|
switchToItem(name)
|
Class Detail
TogglePanel(componentId, options)
- Parameters:
- {String} componentId
- - component id
- {Hash} options
- - params
Method Detail
{String}
firstItem()
- Returns:
- {String} name of first panel item
{TogglePanelItem[]}
getItems()
- Returns:
- {TogglePanelItem[]} all defined panel items
{String[]}
getItemsNames()
- Returns:
- {String[]} names of all defined items
{TogglePanelItem}
getNextItem(name)
- Parameters:
- {String} name
- of TogglePanelItem or meta name (@first | @prev | @next | @last)
- Returns:
- {TogglePanelItem} null if item not found
{String}
getSelectItem()
- Returns:
- {String} name of current selected panel item
{String}
lastItem()
- Returns:
- {String} name of last panel item
{String}
nextItem(itemName)
- Parameters:
- {String} itemName Optional, Default: activeItem
- Returns:
- {String} name of next panel item
{String}
prevItem(itemName)
- Parameters:
- {String} itemName
- Returns:
- {String} name of prev panel item null if it is first item
{Boolean}
switchToItem(name)
- Parameters:
- {String} name
- - panel item name to switch we can use meta names @first, @prev, @next and @last
- Returns:
- {Boolean} - false if something wrong and true if all is ok