class Drawer
package feathers.controls
extends FeathersControl › MeasureSprite › ValidatingSprite
implements IFocusExclusions, IOpenCloseToggle
A container that displays primary content
in the center with a drawer
that opens and closes from one of the four edges of the container.
Events:
openfl.events.Event.OPEN | Dispatched when the drawer has completely opened. |
---|---|
openfl.events.Event.CLOSE | Dispatched when the drawer has completely closed. |
openfl.events.Event.CANCEL | Dispatched when an open or close action is cancelled before completing. |
feathers.events.FeathersEvent.OPENING | Dispatched when the drawer starts opening. This event may be cancelled. |
feathers.events.FeathersEvent.CLOSING | Dispatched when the drawer starts closing. This event may be cancelled. |
1.0.0
.See also:
Constructor
Variables
animateOpenedProperty:Bool
Indicates if setting the opened
property causes the drawer to animate
open and closed, or if it causes the drawer to open and close instantly.
1.3.0
.See also:
autoSizeMode:AutoSizeMode
Determines how the drawer container will set its own size when its dimensions (width and height) aren't set explicitly.
In the following example, the drawer container will be sized to match the stage:
drawer.autoSizeMode = STAGE;
1.0.0
.See also:
clickOverlayToClose:Bool
Determines if the drawer may be closed by clicking the modal overlay.
1.0.0
.read onlyfocusExclusions:Array<DisplayObject>
overlaySkin:DisplayObject
A display object to display below the drawer and above the primary content when the drawer is opened. Blocks mouse and touch events from reaching the primary content.
1.0.0
.pullableEdge:RelativePosition
The edge of the container where the drawer is attached.
1.0.0
.See also:
simulateTouch:Bool
Determines if mouse events should be treated like touch events when detecting a pull gesture that opens or closes a drawer.
1.0.0
.swipeCloseEnabled:Bool
Determines if the drawer may be closed by swiping it.
1.0.0
.See also:
swipeOpenEnabled:Bool
Determines if the drawer may be opened by swiping it.
1.0.0
.See also:
Methods
closeDrawer(animate:Bool = true):Void
Closes the drawer, if it is currently open.
1.3.0
.openDrawer(animate:Bool = true):Void
Opens the drawer, if it is currently closed.
1.3.0
.