| Package | feathers.core |
| Class | public class DrawersApplication |
| Inheritance | DrawersApplication  Drawers FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Implements | IApplication |
Drawers as the root display object.
| Property | Defined By | ||
|---|---|---|---|
 | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
| alpha : Number The opacity of the object. | DisplayObject | |
| autoSizeMode : String
Determines how the drawers container will set its own size when its
dimensions (width and height) aren't set explicitly. | Drawers | |
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bottomDrawer : IFeathersControl
The drawer that appears below the primary content. | Drawers | |
| bottomDrawerDockMode : String
Determines if the bottom drawer is docked in all, some, or no stage
orientations. | Drawers | |
| bottomDrawerToggleEventType : String
When this event is dispatched by the content event dispatcher, the
bottom drawer will toggle open and closed. | Drawers | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipDrawers : Boolean
Determines if the drawers are clipped while opening or closing. | Drawers | |
| content : IFeathersControl
The primary content displayed in the center of the container. | Drawers | |
| contentEventDispatcherChangeEventType : String
The event dispatched by the content to indicate that the content
event dispatcher has changed. | Drawers | |
| contentEventDispatcherField : String
A property of the content that references an event
dispatcher that dispatches events to toggle drawers open and closed. | Drawers | |
| contentEventDispatcherFunction : Function
A function that returns an event dispatcher that dispatches events to
toggle drawers open and closed. | Drawers | |
| context3DProfile : String
The profile used by Starling when creating its Context3D. | DrawersApplication | ||
| defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
| defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
| depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
| effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
| explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
| explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
| explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
| explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
| explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
| explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
| focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
| focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
| focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
| globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all Drawers
components. | Drawers | |
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
| isBottomDrawerDocked : Boolean [read-only]
Indicates if the bottom drawer is currently docked. | Drawers | |
| isBottomDrawerOpen : Boolean
Indicates if the bottom drawer is currently open. | Drawers | |
| isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFocusEnabled : Boolean
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isLeftDrawerDocked : Boolean [read-only]
Indicates if the left drawer is currently docked. | Drawers | |
| isLeftDrawerOpen : Boolean
Indicates if the left drawer is currently open. | Drawers | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| isRightDrawerDocked : Boolean [read-only]
Indicates if the right drawer is currently docked. | Drawers | |
| isRightDrawerOpen : Boolean
Indicates if the right drawer is currently open. | Drawers | |
| isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
| isTopDrawerDocked : Boolean [read-only]
Indicates if the top drawer is currently docked. | Drawers | |
| isTopDrawerOpen : Boolean
Indicates if the top drawer is currently open. | Drawers | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| leftDrawer : IFeathersControl
The drawer that appears below the primary content. | Drawers | |
| leftDrawerDockMode : String
Determines if the left drawer is docked in all, some, or no stage
orientations. | Drawers | |
| leftDrawerToggleEventType : String
When this event is dispatched by the content event dispatcher, the
left drawer will toggle open and closed. | Drawers | |
| maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
| mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
| maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minimumDragDistance : Number
The minimum physical distance (in inches) that a touch must move
before a drag gesture begins. | Drawers | |
| minimumDrawerThrowVelocity : Number
The minimum physical velocity (in inches per second) that a touch
must move before the a drawern can be "thrown" to open or close it. | Drawers | |
| minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
| minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
| minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
| name : String The name of the display object (default: null). | DisplayObject | |
| nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
| nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| openGesture : String
An optional touch gesture used to open a drawer. | Drawers | |
| openGestureEdgeSize : Number
The size (in inches) of the region near the edge of the content that
can be dragged when the openGesture property is set to
DragGesture.EDGE. | Drawers | |
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
| requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
| resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
| rightDrawer : IFeathersControl
The drawer that appears to the right of the primary content. | Drawers | |
| rightDrawerDockMode : String
Determines if the right drawer is docked in all, some, or no stage
orientations. | Drawers | |
| rightDrawerToggleEventType : String
When this event is dispatched by the content event dispatcher, the
right drawer will toggle open and closed. | Drawers | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| shareContext : Boolean
Indicates if another Starling instance (or another Stage3D framework
altogether) uses the same render context. | DrawersApplication | ||
| showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
| showStats : Boolean
Indicates if a small statistics box (with FPS, memory usage and draw
count) is displayed. | DrawersApplication | ||
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| skipUnchangedFrames : Boolean
When enabled, Starling will skip rendering the stage if it hasn't
changed since the last frame. | DrawersApplication | ||
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
| styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
| styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
| theme : Class
The fully-qualified class name of the application's theme, to be
instantiated by Feathers once Starling has created its context, but
before the application root class is created. | DrawersApplication | ||
| toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
| topDrawer : IFeathersControl
The drawer that appears above the primary content. | Drawers | |
| topDrawerDockMode : String
Determines if the top drawer is docked in all, some, or no stage
orientations. | Drawers | |
| topDrawerToggleEventType : String
When this event is dispatched by the content event dispatcher, the
top drawer will toggle open and closed. | Drawers | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | DrawersApplication | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
| alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | DisplayObjectContainer | |
| drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
| hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
| hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
| hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
| hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
| initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
| invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
| isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
| local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
| removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
| [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
| resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
| resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
| showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| toggleBottomDrawer(duration:Number):void
Opens or closes the bottom drawer. | Drawers | |
| toggleLeftDrawer(duration:Number):void
Opens or closes the left drawer. | Drawers | |
| toggleRightDrawer(duration:Number):void
Opens or closes the right drawer. | Drawers | |
| toggleTopDrawer(duration:Number):void
Opens or closes the top drawer. | Drawers | |
| validate():void
Immediately validates the display object, if it is invalid. | FeathersControl | |
| context3DProfile | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescontext3DProfile:StringThe profile used by Starling when creating its Context3D.
Must be set in MXML and cannot be set after initialization.
.Warning: When using
[Frame] metadata to customize the initialization of
Starling, this property will be ignored. You will need to pass in
the Context3D profile manually in your custom bootstrap class.
public function get context3DProfile():String public function set context3DProfile(value:String):void| shareContext | property |
shareContext:BooleanIndicates if another Starling instance (or another Stage3D framework altogether) uses the same render context.
Must be set in MXML and cannot be set after initialization.
.Warning: When using
[Frame] metadata to customize the initialization of
Starling, this property will be ignored. You will need to set the
shareContext property manually in your custom bootstrap class.
public function get shareContext():Boolean public function set shareContext(value:Boolean):void| showStats | property |
showStats:BooleanIndicates if a small statistics box (with FPS, memory usage and draw count) is displayed.
Warning: When using
[Frame] metadata to customize the initialization of
Starling, this property will be ignored. You will need to set the
showStats property manually in your custom bootstrap class.
public function get showStats():Boolean public function set showStats(value:Boolean):void| skipUnchangedFrames | property |
skipUnchangedFrames:BooleanWhen enabled, Starling will skip rendering the stage if it hasn't changed since the last frame.
This property defaults to true, and it may need to
be disabled if using video or render textures.
Warning: When using
[Frame] metadata to customize the initialization of
Starling, this property will be ignored. You will need to set the
skipUnchangedFrames property manually in your custom bootstrap class.
public function get skipUnchangedFrames():Boolean public function set skipUnchangedFrames(value:Boolean):void| theme | property |
theme:ClassThe fully-qualified class name of the application's theme, to be instantiated by Feathers once Starling has created its context, but before the application root class is created.
Must be set in MXML and cannot be set after initialization.
.Warning: When using
[Frame] metadata to customize the initialization of
Starling, this property will be ignored. You will need to instantiate
the theme manually in your custom bootstrap class.
public function get theme():Class public function set theme(value:Class):void| DrawersApplication | () | Constructor |
public function DrawersApplication()Constructor.