class BaseNavigator
package feathers.controls.navigators
extends FeathersControl › MeasureSprite › ValidatingSprite
implements IFocusContainer
extended by PageNavigator, RouterNavigator, StackNavigator, TabNavigator
Base class for navigator components.
Events:
openfl.events.Event.CLEAR | Dispatched when the
|
---|---|
openfl.events.Event.CHANGE | Dispatched when the
|
feathers.events.TransitionEvent.TRANSITION_START | Dispatched at the beginning of a transition. |
feathers.events.TransitionEvent.TRANSITION_COMPLETE | Dispatched at the end of a transition. |
feathers.events.TransitionEvent.TRANSITION_CANCEL | Dispatched when a transition is cancelled without completing. |
1.0.0
.Variables
read onlyactiveItemID:String
The string identifier for the currently active item, or null
if
there is no active item.
1.0.0
.read onlyactiveItemView:DisplayObject
A reference to the currently active item's view, or null
if there is
no active item.
1.0.0
.autoSizeMode:AutoSizeMode
Determines how the navigator will set its own size when its dimensions (width and height) aren't set explicitly.
In the following example, the navigator will be sized to match its content:
navigator.autoSizeMode = CONTENT;
1.0.0
.See also:
backgroundSkin:DisplayObject
The default background skin to display behind all content added to the navigator. The background skin is resized to fill the complete width and height of the navigator.
The following example passes a bitmap for the navigator to use as a background skin:
navigator.backgroundSkin = new Bitmap(bitmapData);
1.4.0
.See also:
disabledBackgroundSkin:DisplayObject
The background skin to display behind all content added to the navigator when it is disabled. The background skin is resized to fill the complete width and height of the navigator.
The following example gives the navigator a disabled background skin:
navigator.disabledBackgroundSkin = new Bitmap(bitmapData);
navigator.enabled = false;
1.4.0
.See also:
read onlytransitionActive:Bool
Indicates whether the navigator is currently transitioning between views or not.
1.0.0
.Methods
privatedisposeView(id:String, view:DisplayObject):Void
To be overridden by subclasses to clean up a view
1.0.0
.getItemIDs(?result:Array<String>):Array<String>
Returns a list of all item identifiers that have been added with
addItem()
.
1.0.0
.privategetView(id:String):DisplayObject
To be overridden by subclasses to create a view for the active item.
1.0.0
.hasItem(id:String):Bool
Determines if an item with the specified identifier has been added with
addItem()
.
1.0.0
.privatetransitionCancel():Void
To be optionally overridden by subclasses to handle a completed transition.
1.0.0
.privatetransitionComplete():Void
To be optionally overridden by subclasses to handle a completed transition.
1.0.0
.