View source

class StackNavigator

package feathers.controls.navigators

extends BaseNavigator › FeathersControl › MeasureSprite › ValidatingSprite

@:directlyUsed@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())@:build(feathers.macros.StyleContextMacro.build())@:autoBuild(feathers.macros.StyleContextMacro.build())@:build(feathers.macros.StyleMacro.build())@:autoBuild(feathers.macros.StyleMacro.build())@:access(feathers.controls.navigators.StackItem)@:styleContext

A "view stack"-like container that supports navigation between items with history. New items are pushed to the top of a stack, and popping the active item will navigate to the previous item.

This component is designed for use in native apps. For web browser apps, consider using RouterNavigator instead.

The following example creates a stack navigator, adds an item, and displays it as the root of the history:

var navigator = new StackNavigator();
navigator.addItem("mainMenu", new StackItem(MainMenuScreen));
this.addChild(navigator);

navigator.rootItemID = "mainMenu";
Available since

1.0.0

.

See also:

Constructor

new()

Creates a new StackNavigator object.

Available since

1.0.0

.

Variables

popSwipeActiveEdgeSize:Float

The size, measured in pixels, of the region where a pop swipe gesture may begin.

Available since

1.0.0

.

See also:

popSwipeEnabled:Bool

If true, a swipe left with touch may be used to pop the current view.

Available since

1.0.0

.

See also:

rootItemID:String

Sets the first item at the bottom of the history stack, known as the root item. When this item is shown, there will be no transition.

If the history stack currently contains items when you set this property, they will all be popped from the stack without a transition. In other words, setting this property will completely erase the current history.

In the following example, the root item ID is set:

navigator.rootItemID = "my-item-id";
Available since

1.0.0

.

See also:

simulateTouch:Bool

Determines if mouse events should be treated like touch events when detecting a pop swipe.

Available since

1.0.0

.

See also:

read onlystackSize:Int

The number of items that appear in the history stack, including the root item and the currently active item.

Available since

1.0.0

.

@:style@:flash.propertypopTransition:(DisplayObject, DisplayObject) ‑> IEffectContext

The default transition to use for pop actions, if not overridden in the call to popItem().

Available since

1.0.0

.

See also:

@:style@:flash.propertypushTransition:(DisplayObject, DisplayObject) ‑> IEffectContext

The default transition to use for push actions, if not overridden in the call to pushItem().

Available since

1.0.0

.

See also:

@:style@:flash.propertyreplaceTransition:(DisplayObject, DisplayObject) ‑> IEffectContext

The default transition to use for replace actions, if not overridden in the call to replaceItem().

Available since

1.0.0

.

See also:

Methods

addItem(item:StackItem):Void

Registers a new item. The id property of the item should be used to reference the same item in other method calls, like pushItem() or removeItem().

Available since

1.0.0

.

See also:

getItem(id:String):StackItem

Returns the StackItem that was registered by passing the specified identifier to addItem().

Available since

1.0.0

.

popAll(?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):Void

Pops all items from the history stack, leaving the StackNavigator completely empty, with no active item.

An optional transition may be specified. If null, the value of the popTransition property will be used instead.

Available since

1.0.0

.

See also:

popItem(?returnedObject:Dynamic, ?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Pops the current item from the top of the history stack, restoring the previous item from the history as the new active item. If the "root" item is visible, popping has no effect and the root item will remain visible. To remove all items from the history stack, including the root item, use popAll() instead.

An optional transition may be specified. If null, the value of the popTransition property will be used instead.

Returns a reference to the new view, unless a transition is already active when popItem() is called. In that case, the new item will be queued until the previous transition has completed, and popItem() will return null.

Available since

1.0.0

.

See also:

popToRootItem(?returnedObject:Dynamic, ?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Pops all items from the history stack, except the root item. The root item will become the new active item.

An optional transition may be specified. If null, the value of the popTransition property will be used instead.

Returns a reference to the new view, unless a transition is already active when popToRootItem() is called. In that case, the new item will be queued until the previous transition has completed, and popToRootItem() will return null.

Available since

1.0.0

.

See also:

popToRootItemAndReplace(id:String, ?inject:Dynamic ‑> Void, ?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Returns to the root of the history stack, but replaces the root item with a different item instead.

An optional transition may be specified. If null, the value of the popTransition property will be used instead.

Returns a reference to the new view, unless a transition is already active when popToRootItemAndReplace() is called. In that case, the new item will be queued until the previous transition has completed, and popToRootItemAndReplace() will return null.

Available since

1.0.0

.

See also:

pushItem(id:String, ?inject:Dynamic ‑> Void, ?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Pushes an item onto the top of the history stack to become the new active item.

Note: Multiple instances of the same item are allowed to be added to the history stack, if desired.

An optional transition may be specified. If null, the value of the pushTransition property will be used instead.

Returns a reference to the new view, unless a transition is already active when pushItem() is called. In that case, the new item will be queued until the previous transition has completed, and pushItem() will return null.

Available since

1.0.0

.

See also:

removeItem(id:String):StackItem

Removes an existing item using the identifier assigned to it in the call to addItem().

Available since

1.0.0

.

See also:

replaceItem(id:String, ?inject:Dynamic ‑> Void, ?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Replaces the current item on the top of the history stack with a new item, making the new item the active item. May be used in the case where you want to navigate from item A to item B and then to item C, but when popping item C, you want to skip item B and return to item A instead.

An optional transition may be specified. If null, the value of the replaceTransition property will be used instead.

Returns a reference to the new view, unless a transition is already active when replaceItem() is called. In that case, the new item will be queued until the previous transition has completed, and replaceItem() will return null.

Available since

1.0.0

.

See also:

Inherited Variables

Defined by BaseNavigator

read onlyactiveItemID:String

The string identifier for the currently active item, or null if there is no active item.

Available since

1.0.0

.

read onlyactiveItemView:DisplayObject

A reference to the currently active item's view, or null if there is no active item.

Available since

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;
Available since

1.0.0

.

See also:

childFocusEnabled:Bool

See also:

read onlytransitionActive:Bool

Indicates whether the navigator is currently transitioning between views or not.

Available since

1.0.0

.

Defined by FeathersControl

read onlycreated:Bool

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}

See also:

@:value(null)@:styledisabledAlpha:Null<Float> = null

When disabledAlpha is not null, sets the alpha property to this value when the the enabled property is set to false.

Available since

1.0.0

.

enabled:Bool

See also:

focusEnabled:Bool

See also:

focusManager:IFocusManager

See also:

focusOwner:IFocusObject

See also:

@stylefocusPaddingBottom:Float

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingLeft:Float

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingRight:Float

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingTop:Float

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

includeInLayout:Bool

See also:

read onlyinitialized:Bool

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See also:

@stylelayoutData:ILayoutData

See also:

read onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

styleProvider:IStyleProvider

When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.

You can set or replace an existing style provider at any time before a component initializes without immediately affecting the component's visual appearance. After the component initializes, the style provider may still be changed, and any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

Available since

1.0.0

.

See also:

themeEnabled:Bool

See also:

toolTip:String

See also:

variant:String

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

Defined by ValidatingSprite

read onlydepth:Int

See also:

read onlyvalidating:Bool

Indicates if the display object is currently validating.

Available since

1.0.0

.

Inherited Methods

Defined by BaseNavigator

private@:dox(show)disposeView(id:String, view:DisplayObject):Void

To be overridden by subclasses to clean up a view

Available since

1.0.0

.

getItemIDs(?result:Array<String>):Array<String>

Returns a list of all item identifiers that have been added with addItem().

Available since

1.0.0

.

private@:dox(show)getView(id:String):DisplayObject

To be overridden by subclasses to create a view for the active item.

Available since

1.0.0

.

hasItem(id:String):Bool

Determines if an item with the specified identifier has been added with addItem().

Available since

1.0.0

.

private@:dox(show)transitionCancel():Void

To be optionally overridden by subclasses to handle a completed transition.

Available since

1.0.0

.

private@:dox(show)transitionComplete():Void

To be optionally overridden by subclasses to handle a completed transition.

Available since

1.0.0

.

Defined by FeathersControl

private@:dox(show)initialize():Void

Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. Do things like create children and set up event listeners. After this function is called, Event.INIT is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

initializeNow():Void

See also:

move(x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.x

  • DisplayObject.y

setFocusPadding(value:Float):Void

Sets all four padding properties to the same value.

Available since

1.0.0

.

See also:

setSize(width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.width

  • DisplayObject.height

private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

showFocus(show:Bool):Void

See also:

Defined by MeasureSprite

resetHeight():Void

See also:

resetMaxHeight():Void

See also:

resetMaxWidth():Void

See also:

resetMinHeight():Void

See also:

resetMinWidth():Void

See also:

resetWidth():Void

See also:

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

isInvalid(?flag:InvalidationFlag):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

runWithoutInvalidation(callback:() ‑> Void):Void

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Available since

1.0.0

.

setInvalid(?flag:InvalidationFlag):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See also:

private@:dox(show)update():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.