Packagecom.gestureworks.cml.elements
Classpublic class Accordion
InheritanceAccordion Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The Accordion is an interactive container which holds display objects in a collapsible menu. The Accordion takes a string of labels and a number of children to create containers separated by tabs that can be tapped or dragged to be expanded or collapsed.



Public Properties
 PropertyDefined By
  autoLayout : Boolean
Set whether to automatically lay out labels, or to use padding properties that have been set.
Accordion
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
  collapsed : Boolean
[read-only]
Accordion
  color : uint
The flat fill color
Accordion
  current : int
[read-only]
Accordion
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
  fill : String
Choose whether to use a solid fill color or gradient.
Accordion
  font : String
Set the font of the tabs.
Accordion
  fontColor : uint
Set the font color.
Accordion
  fontSize : Number
Set the font size.
Accordion
  gradientAlphas : String
Input the gradient alphas as a comma separated string.
Accordion
  gradientColors : String
Input the gradient colors as a comma-separated list.
Accordion
  gradientRatios : String
Accordion
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
  labels : String
Accordion
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
  selectedIndex : int
The index of the currently selected tab.
Accordion
  snapping : Boolean
Set whether or not the accordion menus snap on release.
Accordion
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  twirlIconHeight : Number
Set the height of the twirl icon if it's turned on.
Accordion
  twirlIndicator : Boolean
Set whether or not to display triangles that twirl when a menu is opened.
Accordion
  twirlStroke : Number
Set the thickness of the twirl triangle.
Accordion
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Constructor
Accordion
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
collapseMenu(immediately:Boolean = false):void
Accordion
  
dispose():void
[override] Destructor
Accordion
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
init():void
[override] Initialization call
Accordion
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
  
select(index:Number):void
Accordion
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
autoLayoutproperty
autoLayout:Boolean

Set whether to automatically lay out labels, or to use padding properties that have been set.


Implementation
    public function get autoLayout():Boolean
    public function set autoLayout(value:Boolean):void
collapsedproperty 
collapsed:Boolean  [read-only]


Implementation
    public function get collapsed():Boolean
colorproperty 
color:uint

The flat fill color


Implementation
    public function get color():uint
    public function set color(value:uint):void
currentproperty 
current:int  [read-only]


Implementation
    public function get current():int
fillproperty 
fill:String

Choose whether to use a solid fill color or gradient.

The default value is "gradient".


Implementation
    public function get fill():String
    public function set fill(value:String):void
fontproperty 
font:String

Set the font of the tabs.


Implementation
    public function get font():String
    public function set font(value:String):void
fontColorproperty 
fontColor:uint

Set the font color.


Implementation
    public function get fontColor():uint
    public function set fontColor(value:uint):void
fontSizeproperty 
fontSize:Number

Set the font size.


Implementation
    public function get fontSize():Number
    public function set fontSize(value:Number):void
gradientAlphasproperty 
gradientAlphas:String

Input the gradient alphas as a comma separated string.


Implementation
    public function get gradientAlphas():String
    public function set gradientAlphas(value:String):void
gradientColorsproperty 
gradientColors:String

Input the gradient colors as a comma-separated list.


Implementation
    public function get gradientColors():String
    public function set gradientColors(value:String):void
gradientRatiosproperty 
gradientRatios:String


Implementation
    public function get gradientRatios():String
    public function set gradientRatios(value:String):void
labelsproperty 
labels:String


Implementation
    public function get labels():String
    public function set labels(value:String):void
selectedIndexproperty 
selectedIndex:int

The index of the currently selected tab.


Implementation
    public function get selectedIndex():int
    public function set selectedIndex(value:int):void
snappingproperty 
snapping:Boolean

Set whether or not the accordion menus snap on release.


Implementation
    public function get snapping():Boolean
    public function set snapping(value:Boolean):void
twirlIconHeightproperty 
twirlIconHeight:Number

Set the height of the twirl icon if it's turned on.


Implementation
    public function get twirlIconHeight():Number
    public function set twirlIconHeight(value:Number):void
twirlIndicatorproperty 
twirlIndicator:Boolean

Set whether or not to display triangles that twirl when a menu is opened.


Implementation
    public function get twirlIndicator():Boolean
    public function set twirlIndicator(value:Boolean):void
twirlStrokeproperty 
twirlStroke:Number

Set the thickness of the twirl triangle. Everything else is based on font size.


Implementation
    public function get twirlStroke():Number
    public function set twirlStroke(value:Number):void
Constructor Detail
Accordion()Constructor
public function Accordion()

Constructor

Method Detail
collapseMenu()method
public function collapseMenu(immediately:Boolean = false):void

Parameters

immediately:Boolean (default = false)

dispose()method 
override public function dispose():void

Destructor

init()method 
override public function init():void

Initialization call

select()method 
public function select(index:Number):void

Parameters

index:Number