Package | com.gestureworks.cml.elements |
Class | public class Menu |
Inheritance | Menu ![]() ![]() |
Subclasses | OrbMenu |
See also
Property | Defined By | ||
---|---|---|---|
autohide : Boolean | Menu | ||
autoHide : Boolean
Specifies whether the menu automatically hides when not in use
| Menu | ||
autoHideTime : Number
Specifies the auto-hide time
| Menu | ||
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
buttonArray : Array | Menu | ||
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
![]() | cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
![]() | cmlIndex : int
Returns the index created by the CML parser. | TouchContainer | |
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | group : String | TouchContainer | |
![]() | height : Number [override]
sets the height of the container
| TouchContainer | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | id : String
Returns the object's id. | TouchContainer | |
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | TouchContainer | |
![]() | paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | TouchContainer | |
![]() | paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | TouchContainer | |
![]() | paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | TouchContainer | |
position : * [override]
Specifies the position alogorithm of the menu. | Menu | ||
![]() | relativeX : Boolean
When set true this containers children's x position will be laid out relatively
to each other. | TouchContainer | |
![]() | relativeY : Boolean
When set true this containers children's y position will be laid out relatively
to each other. | TouchContainer | |
slider : Slider | Menu | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | toBitmap : Boolean | TouchContainer | |
![]() | width : Number [override]
sets the width of the container
| TouchContainer | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
Menu()
Constructor
| Menu | ||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
clone():* [override]
Returns clone of self
| Menu | ||
dispose():void [override]
Dispose method
| Menu | ||
![]() | getElementById(id:String):*
Searches CML childList by id. | TouchContainer | |
![]() | getElementsByClassName(className:String):Array
Searches the CML childList by className. | TouchContainer | |
![]() | getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class. | TouchContainer | |
init():void [override]
Initialisation method
| Menu | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
![]() | parseCML(cml:XMLList):XMLList
Parse cml for local layouts. | TouchContainer | |
![]() | postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine. | TouchContainer | |
![]() | querySelector(selector:String):*
Searches the CML childList by selector. | TouchContainer | |
![]() | querySelectorAll(selector:*):Array
Search the CML childList by selector. | TouchContainer | |
![]() | removeChild(child:DisplayObject):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildAt(index:int):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void [override]
Removes children from display list and, if not already removed, the child list
| TouchContainer | |
reset():void | Menu | ||
![]() | saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number. | TouchContainer | |
![]() | searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
startTimer():void
if autohide on, adds the listener
| Menu | ||
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
updateLayout(containerWidth:Number, containerHeight:Number):void
sets the layout depending on the position
| Menu | ||
![]() | updatePadding():void
Updates child padding within this container
| TouchContainer | |
![]() | updatePercentDim():void
Updates child percent dimensions within this container
| TouchContainer | |
![]() | updateProperties(state:* = 0):void
Updates properties from state. | TouchContainer | |
![]() | updateRelativePos():void
Updates child relative positions within this container
| TouchContainer |
autohide | property |
autohide:Boolean
public function get autohide():Boolean
public function set autohide(value:Boolean):void
autoHide | property |
autoHide:Boolean
Specifies whether the menu automatically hides when not in use
public function get autoHide():Boolean
public function set autoHide(value:Boolean):void
autoHideTime | property |
autoHideTime:Number
Specifies the auto-hide time
public function get autoHideTime():Number
public function set autoHideTime(value:Number):void
buttonArray | property |
public var buttonArray:Array
position | property |
position:*
[override] Specifies the position alogorithm of the menu. This includes the position of the buttons with in the menu. The button must be a child of the menu.
The default value is bottom
.
public function get position():*
public function set position(value:any):void
slider | property |
public var slider:Slider
Menu | () | Constructor |
public function Menu()
Constructor
clone | () | method |
override public function clone():*
Returns clone of self
Returns* |
dispose | () | method |
override public function dispose():void
Dispose method
init | () | method |
override public function init():void
Initialisation method
reset | () | method |
public function reset():void
startTimer | () | method |
public function startTimer():void
if autohide on, adds the listener
updateLayout | () | method |
public function updateLayout(containerWidth:Number, containerHeight:Number):void
sets the layout depending on the position
Parameters
containerWidth:Number | |
containerHeight:Number |