| Package | com.gestureworks.cml.element |
| Class | public class Drawer |
| Inheritance | Drawer  Container ContainerFactory ElementFactory flash.display.Sprite |
| Subclasses | Dock |
Drawer is a container that animates down to conceal its contents (closed state) and animates up to
reveal its contents (open state). The open and closed states are toggled by tapping the top of the drawer (handle).
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| applyMask : Boolean
Flag indicating the application of a mask to the drawer to prevent
content from exceeding the drawer's boundaries
| Drawer | ||
| background : *
The DisplayObject representing the drawer's content area
| Drawer | ||
| bkgColor : uint
The color of the drawer's content area
| Drawer | ||
| blur : Boolean
Sets the drop shadow effect
| ElementFactory | |
| bottom : Number
sets the bottom value
| ElementFactory | |
| 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 | |
| handle : *
The top mounted TouchContainer used to close/open the drawer when tapped. | Drawer | ||
| handleColor : uint
The color of the drawer's handle
| Drawer | ||
| handleHeight : Number
The height of the drawer's handle
| Drawer | ||
| handleLineColor : uint
The color the handle's border
| Drawer | ||
| handleLineStroke : Number
The width of the handle's border in pixels
| Drawer | ||
| handleWidth : Number
The width of the drawer's handle
| Drawer | ||
| height : Number [override]
Sets the height of the drawer and drawer's UI components
| Drawer | ||
| 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 | |
| initializeOpen : Boolean
Flag indicating whether the initial state of the drawer is open or closed
| Drawer | ||
| label : *
The Text component that displays the drawer's title
| Drawer | ||
| labelColor : uint
The color of the handle's label
| Drawer | ||
| labelFont : String
The font of the handle's label
| Drawer | ||
| labelFontSize : Number
The font size of the handle's label
| Drawer | ||
| 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 | |
| leftCornerRadius : Number
The radius of the upper left corner of the handle
| Drawer | ||
| leftHandle : *
The left mounted TouchContainer used to close the drawer when tapped. | Drawer | ||
| 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
Sets the position
| Container | |
| propertyStates : Array Deprecated: Please Use state | ElementFactory | |
| right : Number
sets the right value
| ElementFactory | |
| rightCornerRadius : Number
The radius of the upper right corner of the handle
| Drawer | ||
| rightHandle : *
The right mounted TouchContainer used to close the drawer when tapped. | Drawer | ||
| 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 | |
| state : Array
property states array
| ElementFactory | |
| title : String
The text of the handle's label
| Drawer | ||
| top : Number
sets top value
| ElementFactory | |
| useLeftHandle : Boolean
A flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the
close operation to the left handle. | Drawer | ||
| useRightHandle : Boolean
A flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the
close operation to the right handle. | Drawer | ||
| useSideHandles : Boolean
A flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the
close operation to the side handles. | Drawer | ||
| verticalCenter : Number
sets the vertical center of display object
| ElementFactory | |
| width : Number [override]
Sets the width of the drawer and drawer's UI components
| Drawer | ||
| widthPercent : String
sets the percent of width of display object
| ElementFactory | |
| Method | Defined By | ||
|---|---|---|---|
Drawer()
Constructor
| Drawer | ||
| addAllChildren():void
This method searches the childlist and add the children
| ContainerFactory | |
addChild(child:DisplayObject):DisplayObject [override]
Reroutes child additions to the drawer's content holder
| Drawer | ||
addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Reroutes child additions to the drawer's content holder
| Drawer | ||
| applyLayout(value:* = null):void
Apply the containers layout
| Container | |
| childToList(id:String, child:*):void
this method append to the childlist
| ContainerFactory | |
| clone():*
Returns clone of self
| ElementFactory | |
displayComplete():void [override]
CML init
| Drawer | ||
dispose():void [override]
Destructor
| Drawer | ||
| 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]
Initialization function
| Drawer | ||
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | Container | |
| postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | |
| 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 | |
| updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory | |
| applyMask | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesapplyMask:BooleanFlag indicating the application of a mask to the drawer to prevent content from exceeding the drawer's boundaries
The default value is true.
public function get applyMask():Boolean public function set applyMask(value:Boolean):void| background | property |
background:*
The DisplayObject representing the drawer's content area
public function get background():* public function set background(value:any):void| bkgColor | property |
bkgColor:uintThe color of the drawer's content area
The default value is 0x424141.
public function get bkgColor():uint public function set bkgColor(value:uint):void| handle | property |
handle:*
The top mounted TouchContainer used to close/open the drawer when tapped. The handle must contain a DisplayObject
to target.
public function get handle():* public function set handle(value:any):void| handleColor | property |
handleColor:uintThe color of the drawer's handle
The default value is 0x2E2D2D.
public function get handleColor():uint public function set handleColor(value:uint):void| handleHeight | property |
handleHeight:NumberThe height of the drawer's handle
The default value is 60.
public function get handleHeight():Number public function set handleHeight(value:Number):void| handleLineColor | property |
handleLineColor:uintThe color the handle's border
public function get handleLineColor():uint public function set handleLineColor(value:uint):void| handleLineStroke | property |
handleLineStroke:NumberThe width of the handle's border in pixels
public function get handleLineStroke():Number public function set handleLineStroke(value:Number):void| handleWidth | property |
handleWidth:NumberThe width of the drawer's handle
The default value is 500.
public function get handleWidth():Number public function set handleWidth(value:Number):void| height | property |
height:Number[override] Sets the height of the drawer and drawer's UI components
The default value is 420.
public function get height():Number public function set height(value:Number):void| initializeOpen | property |
initializeOpen:BooleanFlag indicating whether the initial state of the drawer is open or closed
The default value is false.
public function get initializeOpen():Boolean public function set initializeOpen(value:Boolean):void| label | property |
label:*
The Text component that displays the drawer's title
public function get label():* public function set label(value:any):void| labelColor | property |
labelColor:uintThe color of the handle's label
The default value is 0xFFFFFF.
public function get labelColor():uint public function set labelColor(value:uint):void| labelFont | property |
labelFont:StringThe font of the handle's label
The default value is OpenSansRegular.
public function get labelFont():String public function set labelFont(value:String):void| labelFontSize | property |
labelFontSize:NumberThe font size of the handle's label
The default value is 30.
public function get labelFontSize():Number public function set labelFontSize(value:Number):void| leftCornerRadius | property |
leftCornerRadius:NumberThe radius of the upper left corner of the handle
The default value is 15.
public function get leftCornerRadius():Number public function set leftCornerRadius(value:Number):void| leftHandle | property |
leftHandle:*
The left mounted TouchContainer used to close the drawer when tapped. The handle must contain a DisplayObject
to target.
public function get leftHandle():* public function set leftHandle(value:any):void| rightCornerRadius | property |
rightCornerRadius:NumberThe radius of the upper right corner of the handle
The default value is 15.
public function get rightCornerRadius():Number public function set rightCornerRadius(value:Number):void| rightHandle | property |
rightHandle:*
The right mounted TouchContainer used to close the drawer when tapped. The handle must contain a DisplayObject
to target.
public function get rightHandle():* public function set rightHandle(value:any):void| title | property |
title:StringThe text of the handle's label
public function get title():String public function set title(value:String):void| useLeftHandle | property |
useLeftHandle:BooleanA flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the close operation to the left handle.
public function get useLeftHandle():Boolean public function set useLeftHandle(value:Boolean):void| useRightHandle | property |
useRightHandle:BooleanA flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the close operation to the right handle.
public function get useRightHandle():Boolean public function set useRightHandle(value:Boolean):void| useSideHandles | property |
useSideHandles:BooleanA flag indicating the hiding of the top mounted handle when the drawer is in the open state and transferring the close operation to the side handles.
public function get useSideHandles():Boolean public function set useSideHandles(value:Boolean):void| width | property |
width:Number[override] Sets the width of the drawer and drawer's UI components
The default value is 500.
public function get width():Number public function set width(value:Number):void| Drawer | () | Constructor |
public function Drawer()Constructor
| addChild | () | method |
override public function addChild(child:DisplayObject):DisplayObjectReroutes child additions to the drawer's content holder
Parameters
child:DisplayObject — the child to add to the content holder
|
DisplayObject — the child added to the content holder
|
| addChildAt | () | method |
override public function addChildAt(child:DisplayObject, index:int):DisplayObjectReroutes child additions to the drawer's content holder
Parameters
child:DisplayObject — the child to add to the content holder
| |
index:int |
DisplayObject — the child added to the content holder
|
| displayComplete | () | method |
override public function displayComplete():voidCML init
| dispose | () | method |
override public function dispose():voidDestructor
| init | () | method |
override public function init():voidInitialization function