From 635ed0932324a2253835919ef977ac1f97a1d0dd Mon Sep 17 00:00:00 2001 From: Caridy Patino Date: Tue, 1 Mar 2011 11:40:26 -0500 Subject: [PATCH] updating gallery-node-accordion documentation. adding a formal doc generator to the api folder. --- .../plugin.NodeAccordion.html | 1167 ----------------- 1 file changed, 1167 deletions(-) delete mode 100644 api/gallery-node-accordion/plugin.NodeAccordion.html diff --git a/api/gallery-node-accordion/plugin.NodeAccordion.html b/api/gallery-node-accordion/plugin.NodeAccordion.html deleted file mode 100644 index 8964303..0000000 --- a/api/gallery-node-accordion/plugin.NodeAccordion.html +++ /dev/null @@ -1,1167 +0,0 @@ - - - - - API: gallery-node-accordion plugin.NodeAccordion (YUI Library) - - - - - - - - - - -
-
-

Yahoo! UI Library

-

gallery-node-accordion  3.0.0

- Yahoo! UI Library - > gallery-node-accordion - > plugin.NodeAccordion - -
-
- Search: -
-   -
-
-
-
- -
-
-
-
-
- Filters - - - -
-
- -

- - - - - Class plugin.NodeAccordion - - - -

- - - - - -
- The NodeAccordion class is a plugin for a Node instance. The class is used via -the plug method of Node and -should not be instantiated directly. -
- - -
-
-

Properties

-
-
-

_root - - protected Node -

-
-
- Node instance representing the root node in the accordion. -
-
- - -
- Default Value: null -
- - -
-
-
-
- -
- -
-
-

Methods

-
-
-

- _animate

-
- - protected - - - Object - _animate - ( - - - id - - - , - conf - - - , - fn - - - ) - - -
- Using Y.Anim to expand or collapse an item. -
- -
- -
-
Parameters:
-
- id - <String> - - Global Unique ID for the animation. -
-
- conf - <Object> - - Configuration object for the animation. -
-
- fn - <Function> - - callback function that should be executed after the end of the anim. -
-
- -
-
Returns: - - Object -
-
Animation handler.
-
- - - - -
- -
-
-
-
-

- _closeItem

-
- - protected - - - void - _closeItem - ( - - - item - - - ) - - -
- Closes the specified item. -
- -
- -
-
Parameters:
-
- item - <Node> - - Node instance representing an item. -
-
- -
-
Returns: - - void -
-
-
- - - - -
- -
-
-
-
-

- _getItem

-
- - protected - - - Node - _getItem - ( - - - node - - - ) - - -
- Searching for an item based on a node reference or an index order. -
- -
- -
-
Parameters:
-
- node - <Node|Number> - - Node reference or Node index. -
-
- -
-
Returns: - - Node -
-
The matching DOM node or null if none found.
-
- - - - -
- -
-
-
-
-

- _openItem

-
- - protected - - - void - _openItem - ( - - - item - - - ) - - -
- Open an item. -
- -
- -
-
Parameters:
-
- item - <Node> - - Node instance representing an item. -
-
- -
-
Returns: - - void -
-
-
- - - - -
- -
-
-
-
-

- collapseAllItems

-
- - - - - object - collapseAllItems - ( - ) - - -
- Collapsing all items. -
- -
- - -
-
Returns: - - object -
-
Plugin reference for chaining
-
- - - - -
- -
-
-
-
-

- collapseItem

-
- - - - - object - collapseItem - ( - - - node - - - ) - - -
- Collapse a certain item. -
- -
- -
-
Parameters:
-
- node - <Node> - - Node reference -
-
- -
-
Returns: - - object -
-
Plugin reference for chaining
-
- - - - -
- -
-
-
-
-

- expandAllItems

-
- - - - - object - expandAllItems - ( - ) - - -
- Expanding all items. -
- -
- - -
-
Returns: - - object -
-
Plugin reference for chaining
-
- - - - -
- -
-
-
-
-

- expandItem

-
- - - - - object - expandItem - ( - - - node - - - ) - - -
- Expand a certain item. -
- -
- -
-
Parameters:
-
- node - <Node> - - Node reference -
-
- -
-
Returns: - - object -
-
Plugin reference for chaining
-
- - - - -
- -
-
-
-
-

- toggleItem

-
- - - - - object - toggleItem - ( - - - node - - - ) - - -
- toggle a certain item. -
- -
- -
-
Parameters:
-
- node - <object> - - Node reference -
-
- -
-
Returns: - - object -
-
Plugin reference for chaining
-
- - - - -
- -
-
-
-
-
- -
- -
-
-

Events

-
-
-

- activeItemsChange

-
- - - - - activeItemsChange - - ( - - - event - - - ) - - - -
- Fires when the value for the configuration attribute 'activeItems' 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
 -
- -
- - -
- -
-
-
-
-

- animChange

-
- - - - - animChange - - ( - - - event - - - ) - - - -
- Fires when the value for the configuration attribute 'anim' 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
 -
- -
- - -
- -
-
-
-
-

- fadeChange

-
- - - - - fadeChange - - ( - - - event - - - ) - - - -
- Fires when the value for the configuration attribute 'fade' 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
 -
- -
- - -
- -
-
-
-
-

- itemsChange

-
- - - - - itemsChange - - ( - - - event - - - ) - - - -
- Fires when the value for the configuration attribute 'items' 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
 -
- -
- - -
- -
-
-
-
-

- multipleChange

-
- - - - - multipleChange - - ( - - - event - - - ) - - - -
- Fires when the value for the configuration attribute 'multiple' 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
 -
- -
- - -
- -
-
-
-
-

- orientationChange

-
- - - - - orientationChange - - ( - - - event - - - ) - - - -
- Fires when the value for the configuration attribute 'orientation' 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
 -
- -
- - -
- -
-
-
-
-

- persistentChange

-
- - - - - persistentChange - - ( - - - event - - - ) - - - -
- Fires when the value for the configuration attribute 'persistent' 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
 -
- -
- - -
- -
-
-
-
-

- speedChange

-
- - - - - speedChange - - ( - - - event - - - ) - - - -
- Fires when the value for the configuration attribute 'speed' 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

-
-
-

activeItems - - Y.NodeList -

-
-
- Nodes representing the list of active items. -
-
- - - -
-
-
-

anim - - {boolean|function} -

-
-
- Boolean indicating that Y.Anim should be used to expand and collapse items. -It also supports a function with an specific effect. -

- -<script type="text/javascript">
-
-// Call the "use" method, passing in "anim" and "gallery-node-accordion".
-
-YUI().use("anim", "gallery-node-accordion", function(Y) {
-
-Y.one("#myaccordion").plug(Y.Plugin.NodeAccordion, {
-anim: Y.Easing.backIn
-});
-
-</script>
- -

-
-
- - -
- Default Value: false -
- -
-
-
-

fade - - boolean -

-
-
- Boolean indicating that animation should include opacity to fade in/out the content of the item. -
-
- - -
- Default Value: false -
- -
-
-
-

items - - Y.NodeList -

-
-
- Nodes representing the list of items. -
-
- - - -
-
-
-

multiple - - boolean -

-
-
- Boolean indicating that more than one item can be opened at the same time. -
-
- - -
- Default Value: true -
- -
-
-
-

orientation - - writeonce string -

-
-
- orientation defines if the accordion will use width or height to expand and collapse items. -
-
- - -
- Default Value: height -
- -
-
-
-

persistent - - boolean -

-
-
- Boolean indicating that one of the items should be open at any given time. -
-
- - -
- Default Value: false -
- -
-
-
-

speed - - numeric -

-
-
- Numeric value indicating the speed in mili-seconds for the animation process. -Also support three predefined strings in lowercase: -
    -
  1. fast = 0.1
    2. -
  2. normal = 0.4
    3. -
  3. slow = 0.6
    4. -
-
-
- - -
- Default Value: 0.4 -
- -
-
- -
-
- -
- -
-
-
-
- -
-

Modules

- -
- -
-

Classes

- -
- -
-

Files

- -
- -
-

Properties

- -
- - - - - -
-

Configuration Attributes

- -
- -
-
-
-
-
- Copyright © 2009 Yahoo! Inc. All rights reserved. -
-
- - -