| Package | com.gestureworks.cml.element |
| Class | public class Menu |
| Inheritance | Menu  Container ContainerFactory ElementFactory flash.display.Sprite |
| Subclasses | OrbMenu |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| autoHide : Boolean
Specifies whether the menu automatically hides when not in use
| Menu | ||
| autoHideTime : Number
Specifies the auto-hide time
| Menu | ||
| blur : Boolean
Sets the drop shadow effect
| ElementFactory | |
| bottom : Number
sets the bottom value
| ElementFactory | |
| buttonArray : Array | Menu | ||
| childList : ChildList [read-only]
store the child list
| ContainerFactory | |
| class_ : String
Object's css class;
| ElementFactory | |
| className : String
sets the class name of displayobject
| ElementFactory | |
| cmlIndex : int
sets the cml index
| ElementFactory | |
| debugStyle : *
sets the debug style
| ElementFactory | |
| dimensionsTo : String
sets the dimensions of the container
| ContainerFactory | |
| displayEvents : String
Use for dispatch completes. | ElementFactory | |
| dropShadow : Boolean
Sets the drop shadow effect
| ElementFactory | |
| height : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| heightPercent : String
sets the height percent of display object
| ElementFactory | |
| horizontalCenter : Number
sets the horizontal center of display object
| ElementFactory | |
| id : String
sets the id of child
| ElementFactory | |
| index : int
sets the index of display object
| ElementFactory | |
| infoSource : String
sets info source
| ContainerFactory | |
| layout : *
Sets the layout of the container
| Container | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| Container | |
| layoutList : Dictionary
Defines the layoutlist
| Container | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| Container | |
| left : Number
sets left value
| ElementFactory | |
| paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | Container | |
| paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | Container | |
| paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | Container | |
| paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | Container | |
| position : String [override]
Specifies the position alogorithm of the menu. | Menu | ||
| propertyStates : Array Deprecated: Please Use state | ElementFactory | |
| right : Number
sets the right value
| ElementFactory | |
| scale : Number
Sets both the x and y scale values
| ElementFactory | |
| scaleX : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| scaleY : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| slider : Slider | Menu | ||
| state : Array
property states array
| ElementFactory | |
| top : Number
sets top value
| ElementFactory | |
| verticalCenter : Number
sets the vertical center of display object
| ElementFactory | |
| width : Number [override]
Sets width of the display object in pixels
| ElementFactory | |
| widthPercent : String
sets the percent of width of display object
| ElementFactory | |
| Method | Defined By | ||
|---|---|---|---|
Menu()
Constructor
| Menu | ||
| addAllChildren():void
This method searches the childlist and add the children
| ContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
TODO: This mechanism should be abstracted to better syncrhonize child and display lists
| Container | |
| applyLayout(value:* = null):void
Apply the containers layout
| Container | |
| childToList(id:String, child:*):void
this method append to the childlist
| ContainerFactory | |
clone():* [override]
Returns clone of self
| Menu | ||
displayComplete():void [override]
CML Initialisation call back
| Menu | ||
dispose():void [override]
Dispose method
| Menu | ||
| getIndex(index:int):*
returns childlist index
| Container | |
| getKey(key:String):*
returns the childlist key
| Container | |
| hideIndex(index:int):void
hides the childlist index
| Container | |
| hideKey(key:String):void
hides the childlist key
| Container | |
init():void [override]
Initialisation method
| Menu | ||
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | Container | |
| postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | |
reset():void | Menu | ||
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | Container | |
| setDimensionsToChild():void
This method sets the dimensions of childlist
| ContainerFactory | |
| showIndex(index:int):void
shows the childlist index
| Container | |
| showKey(key:String):void
shows the childlist key
| Container | |
startTimer():void
if autohide on, adds the listener
| Menu | ||
updateLayout(containerWidth:Number, containerHeight:Number):void
sets the layout depending on the position
| Menu | ||
| updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory | |
| autoHide | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesautoHide:BooleanSpecifies whether the menu automatically hides when not in use
public function get autoHide():Boolean public function set autoHide(value:Boolean):void| autoHideTime | property |
autoHideTime:NumberSpecifies 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:String[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():String public function set position(value:String):void| slider | property |
public var slider:Slider| Menu | () | Constructor |
public function Menu()Constructor
| clone | () | method |
override public function clone():*Returns clone of self
Returns* |
| displayComplete | () | method |
override public function displayComplete():voidCML Initialisation call back
| dispose | () | method |
override public function dispose():voidDispose method
| init | () | method |
override public function init():voidInitialisation method
| reset | () | method |
public function reset():void| startTimer | () | method |
public function startTimer():voidif autohide on, adds the listener
| updateLayout | () | method |
public function updateLayout(containerWidth:Number, containerHeight:Number):voidsets the layout depending on the position
Parameters
containerWidth:Number | |
containerHeight:Number |