Determines how the drawers container will set its own size when its dimensions (width and height) aren't set explicitly.

In the following example, the drawers container will be sized to match its content:

drawers.autoSizeMode = AutoSizeMode.CONTENT;

The default value is feathers.controls.AutoSizeMode.STAGE.

See also

The drawer that appears below the primary content.

In the following example, a List is added as the bottom drawer:

var list:List = new List();
// set data provider and other properties here
drawers.bottomDrawer = list;

The default value is null.

See also

Determines if the bottom drawer is docked in all, some, or no stage orientations. The current stage orientation is determined by calculating the aspect ratio of the stage.

In the following example, the bottom drawer is docked in the landscape stage orientation:

drawers.bottomDrawerDockMode = Orientation.LANDSCAPE;

The default value is feathers.layout.Orientation.NONE.

See also

When this event is dispatched by the content event dispatcher, the bottom drawer will toggle open and closed.

In the following example, the bottom drawer is toggled when the content dispatches an event of type Event.OPEN:

drawers.bottomDrawerToggleEventType = Event.OPEN;

The default value is null.

See also

Determines if the drawers are clipped while opening or closing. If the content does not have a background, the drawers should generally be clipped so that the drawer does not show under the content. If the content has a fully opaque background that will conceal the drawers, then clipping may be disabled to potentially improve performance.

In the following example, clipping will be disabled:

navigator.clipDrawers = false;

The default value is true.

See also

The primary content displayed in the center of the container.

If the primary content is a container where you'd prefer to listen to events from its children, you may need to use properties like contentEventDispatcherField, contentEventDispatcherFunction, and contentEventDispatcherChangeEventType to ensure that open and close events for drawers are correctly mapped to the correct event dispatcher. If the content is dispatching the events, then those properties should be set to null.

In the following example, a StackScreenNavigator is added as the content:

var navigator:StackScreenNavigator = new StackScreenNavigator();
// additional code to add the screens can go here
drawers.content = navigator;

The default value is null.

See also

The event dispatcher that controls opening and closing drawers with events. Often, the event dispatcher is the content itself, but you may specify a contentEventDispatcherField to access a property of the content instead, or you may specify a contentEventDispatcherFunction to run some more complex code to access the event dispatcher.

See also

The event dispatched by the content to indicate that the content event dispatcher has changed. When this event is dispatched by the content, the drawers container will listen for the drawer toggle events from the new dispatcher that discovered using contentEventDispatcherField or contentEventDispatcherFunction.

For StackScreenNavigator and ScreenNavigator components, this value is automatically set to Event.CHANGE.

In the following example, the drawers container will update its content event dispatcher when the content dispatches an event of type Event.CHANGE:

drawers.contentEventDispatcherChangeEventType = Event.CHANGE;

The default value is null.

See also

A property of the content that references an event dispatcher that dispatches events to toggle drawers open and closed.

For StackScreenNavigator and ScreenNavigator components, this value is automatically set to "activeScreen" to listen for events from the currently active/visible screen.

In the following example, the content event dispatcher field is customized:

drawers.contentEventDispatcherField = "selectedChild";

The default value is null.

See also

A function that returns an event dispatcher that dispatches events to toggle drawers open and closed.

The function is expected to have the following signature:

function( content:DisplayObject ):EventDispatcher

In the following example, the content event dispatcher function is customized:

drawers.contentEventDispatcherField = function( content:CustomView ):void
{
    return content.selectedChild;
};

The default value is null.

See also

The default IStyleProvider for all Drawers components.

The default value is null.

See also

Indicates if the bottom drawer is currently docked. Docking behavior of the bottom drawer is controlled with the bottomDrawerDockMode property. To check if the bottom drawer is open, but not docked, use the isBottomDrawerOpen property.

See also

Indicates if the bottom drawer is currently open. If you want to check if the bottom drawer is docked, check isBottomDrawerDocked instead.

To animate the bottom drawer open or closed, call toggleBottomDrawer(). Setting isBottomDrawerOpen will open or close the bottom drawer without animation.

In the following example, we check if the bottom drawer is open:

if( drawers.isBottomDrawerOpen )
{
    // do something
}

The default value is false.

See also

Indicates if the left drawer is currently docked. Docking behavior of the left drawer is controlled with the leftDrawerDockMode property. To check if the left drawer is open, but not docked, use the isLeftDrawerOpen property.

See also

Indicates if the left drawer is currently open. If you want to check if the left drawer is docked, check isLeftDrawerDocked instead.

To animate the left drawer open or closed, call toggleLeftDrawer(). Setting isLeftDrawerOpen will open or close the left drawer without animation.

In the following example, we check if the left drawer is open:

if( drawers.isLeftDrawerOpen )
{
    // do something
}

The default value is false.

See also

Indicates if the right drawer is currently docked. Docking behavior of the right drawer is controlled with the rightDrawerDockMode property. To check if the right drawer is open, but not docked, use the isRightDrawerOpen property.

See also

Indicates if the right drawer is currently open. If you want to check if the right drawer is docked, check isRightDrawerDocked instead.

To animate the right drawer open or closed, call toggleRightDrawer(). Setting isRightDrawerOpen will open or close the right drawer without animation.

In the following example, we check if the right drawer is open:

if( drawers.isRightDrawerOpen )
{
    // do something
}

The default value is false.

See also

Indicates if the top drawer is currently docked. Docking behavior of the top drawer is controlled with the topDrawerDockMode property. To check if the top drawer is open, but not docked, use the isTopDrawerOpen property.

See also

Indicates if the top drawer is currently open. If you want to check if the top drawer is docked, check isTopDrawerDocked instead.

To animate the top drawer open or closed, call toggleTopDrawer(). Setting isTopDrawerOpen will open or close the top drawer without animation.

In the following example, we check if the top drawer is open:

if( drawers.isTopDrawerOpen )
{
    // do something
}

The default value is false.

See also

The drawer that appears below the primary content.

In the following example, a List is added as the left drawer:

var list:List = new List();
// set data provider and other properties here
drawers.leftDrawer = list;

The default value is null.

See also

Determines if the left drawer is docked in all, some, or no stage orientations. The current stage orientation is determined by calculating the aspect ratio of the stage.

In the following example, the left drawer is docked in the landscape stage orientation:

drawers.leftDrawerDockMode = Orientation.LANDSCAPE;

The default value is feathers.layout.Orientation.NONE.

See also

When this event is dispatched by the content event dispatcher, the left drawer will toggle open and closed.

In the following example, the left drawer is toggled when the content dispatches and event of type Event.OPEN:

drawers.leftDrawerToggleEventType = Event.OPEN;

The default value is null.

See also

The minimum physical distance (in inches) that a touch must move before a drag gesture begins.

In the following example, the minimum drag distance is customized:

drawers.minimumDragDistance = 0.1;

The default value is 0.04.

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. Otherwise, it will settle open or closed based on which state is closer when the touch ends.

In the following example, the minimum drawer throw velocity is customized:

drawers.minimumDrawerThrowVelocity = 2;

The default value is 5.

An optional touch gesture used to open a drawer.

In the following example, the drawers are opened by dragging anywhere inside the content:

drawers.openGesture = DragGesture.CONTENT;

The default value is feathers.controls.DragGesture.EDGE.

See also

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.

In the following example, the open gesture edge size is customized:

drawers.openGestureEdgeSize = 0.25;

The default value is 0.1.

See also

The drawer that appears to the right of the primary content.

In the following example, a List is added as the right drawer:

var list:List = new List();
// set data provider and other properties here
drawers.rightDrawer = list;

The default value is null.

See also

Determines if the right drawer is docked in all, some, or no stage orientations. The current stage orientation is determined by calculating the aspect ratio of the stage.

In the following example, the right drawer is docked in the landscape stage orientation:

drawers.rightDrawerDockMode = Orientation.LANDSCAPE;

The default value is feathers.layout.Orientation.NONE.

See also

When this event is dispatched by the content event dispatcher, the right drawer will toggle open and closed.

In the following example, the right drawer is toggled when the content dispatches an event of type Event.OPEN:

drawers.rightDrawerToggleEventType = Event.OPEN;

The default value is null.

See also

The drawer that appears above the primary content.

In the following example, a List is added as the top drawer:

var list:List = new List();
// set data provider and other properties here
drawers.topDrawer = list;

The default value is null.

See also

Determines if the top drawer is docked in all, some, or no stage orientations. The current stage orientation is determined by calculating the aspect ratio of the stage.

In the following example, the top drawer is docked in the landscape stage orientation:

drawers.topDrawerDockMode = Orientation.LANDSCAPE;

The default value is feathers.layout.Orientation.NONE.

See also

When this event is dispatched by the content event dispatcher, the top drawer will toggle open and closed.

In the following example, the top drawer is toggled when the content dispatches an event of type Event.OPEN:

drawers.topDrawerToggleEventType = Event.OPEN;

The default value is null.

See also

Constructor.

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Uses the content event dispatcher fields and functions to generate a content event dispatcher icon for the content.

All of the content event dispatcher fields and functions, ordered by priority:

1. contentEventDispatcherFunction
2. contentEventDispatcherField

See also

Positions and sizes the children.

Opens or closes the bottom drawer. If the duration argument is NaN, the default openOrCloseDuration is used. The default value of the duration argument is NaN. Otherwise, this value is the duration of the animation, in seconds.

To open or close the bottom drawer without animation, set the isBottomDrawerOpen property.

Parameters

See also

Opens or closes the left drawer. If the duration argument is NaN, the default openOrCloseDuration is used. The default value of the duration argument is NaN. Otherwise, this value is the duration of the animation, in seconds.

To open or close the left drawer without animation, set the isLeftDrawerOpen property.

Parameters

See also

Opens or closes the right drawer. If the duration argument is NaN, the default openOrCloseDuration is used. The default value of the duration argument is NaN. Otherwise, this value is the duration of the animation, in seconds.

To open or close the right drawer without animation, set the isRightDrawerOpen property.

Parameters

See also

Opens or closes the top drawer. If the duration argument is NaN, the default openOrCloseDuration is used. The default value of the duration argument is NaN. Otherwise, this value is the duration of the animation, in seconds.

To open or close the top drawer without animation, set the isTopDrawerOpen property.

Parameters

See also

Dispatched when the user starts dragging the content to open or close a drawer.

The properties of the event object have the following values:

See also

Dispatched when a drawer has completed closing. The data property of the event indicates which drawer was closed.

The properties of the event object have the following values:

See also

Dispatched when the user stops dragging the content to open or close a drawer. The drawer may continue opening or closing after this event is dispatched if the user interaction has also triggered an animation.

The properties of the event object have the following values:

Depending on the control, the result of the interaction may continue after the interaction ends. For instance, a Scroller may be "thrown", and the scrolling will continue animating after the user has finished interacting with it.

See also

Dispatched when a drawer has completed opening. The data property of the event indicates which drawer is open.

The properties of the event object have the following values:

See also

The divider between the top drawer and the content when the top drawer is docked.

In the following example, a Quad is added as the top drawer divider:

var divider:Quad = new Quad( 2, 2, 0x999999 );
drawers.topDrawerDivider = quad;
drawers.topDrawerDockMode = Orientation.BOTH

The default value is null.

See also

The divider between the right drawer and the content when the right drawer is docked.

In the following example, a Quad is added as the right drawer divider:

var divider:Quad = new Quad( 2, 2, 0x999999 );
drawers.rightDrawerDivider = quad;
drawers.rightDrawerDockMode = Orientation.BOTH

The default value is null.

See also

An optional display object that appears above the content when a drawer is open.

In the following example, a Quad is added as the overlay skin:

var skin:Quad = new Quad( 10, 10, 0x000000 );
skin.alpha = 0.75;
drawers.overlaySkin = skin;

The default value is null.

The easing function used for opening or closing the drawers.

In the following example, the ease of the animation that opens and closes a drawer is customized:

drawers.openOrCloseEase = Transitions.EASE_IN_OUT;

The default value is starling.animation.Transitions.EASE_OUT.

See also

The duration, in seconds, of the animation when a drawer opens or closes.

In the following example, the duration of the animation that opens or closes a drawer is set to 500 milliseconds:

drawers.openOrCloseDuration = 0.5;

The default value is 0.25.

See also

Determines whether the drawer opens above the content or below it.

In the following example, the drawers are opened above the content:

drawers.openMode = RelativeDepth.ABOVE;

The default value is feathers.layout.RelativeDepth#BELOW.

See also

The divider between the left drawer and the content when the left drawer is docked.

In the following example, a Quad is added as the left drawer divider:

var divider:Quad = new Quad( 2, 2, 0x999999 );
drawers.leftDrawerDivider = quad;
drawers.leftDrawerDockMode = Orientation.BOTH

The default value is null.

See also

The divider between the bottom drawer and the content when the bottom drawer is docked.

In the following example, a Quad is added as the bottom drawer divider:

var divider:Quad = new Quad( 2, 2, 0x999999 );
drawers.bottomDrawerDivider = quad;
drawers.bottomDrawerDockMode = Orientation.BOTH

The default value is null.

See also

The field used to access the "content event dispatcher" of a ScreenNavigator component, which happens to be the currently active screen.

See also