View source

class RouterNavigator

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.Route)@:styleContext

Integrates with the HTML5 history API to allow navigation between views, including support for the browser's native back and forward buttons.

This component is designed for use in web browsers, but provides a decent implementation for native apps. Ideally, native apps should use StackNavigator instead, as it provides more advanced navigation capabilities that are impossible to integrate with the HTML5 history API.

Available since

1.0.0

.

See also:

Constructor

new()

Creates a new RouterNavigator object.

Available since

1.0.0

.

Variables

@:value(null)basePath:String = null

The base URL path where the project will be deployed.

For example, if your project will be deployed to https://www.example.com/my-project/, the base path will be /my-project.

Available since

1.0.0

.

read onlylocation:Location

Returns the current location.

Available since

1.0.0

.

read onlypathname:String

Returns the current pathname. If a basePath is defined, it will not be included in the returned value.

Available since

1.0.0

.

preferHashRouting:Bool

Indicates if hash routing should be preferred for the default pathname routing.

This property is used only on HTML/JS targets, and is ignored on other targets.

Available since

1.0.0

.

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

The default transition to use for back navigation actions.

Available since

1.0.0

.

See also:

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

The default transition to use for forward navigation actions.

Available since

1.0.0

.

See also:

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

The default transition to use for replace navigation actions.

Available since

1.0.0

.

Methods

addRoute(route:Route):Void

Adds a route to the navigator.

The following example adds a new route for the "/settings" URL path:

var route = Route.withClass("/settings", SettingsView);
navigator.addRoute(route);
Available since

1.0.0

.

go(n:Int, ?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Moves the pointer in the history stack by n entries.

The following examples goes back 2 entries in the history stack.

navigator.go(-2);
Available since

1.0.0

.

goBack(?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Navigates to the previous item on the history stack.

The following examples goes back in history by 1 entry.

navigator.goBack();
Available since

1.0.0

.

goForward(?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Navigates to the next item on the history stack.

The following examples goes forward in history by 1 entry.

navigator.goForward();
Available since

1.0.0

.

push(path:String, ?newHistoryState:Dynamic, ?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Pushes a new entry onto the history stack. The route to display will be determined automatically.

The following example navigates to the "/settings" URL path:

navigator.push("/settings");
Available since

1.0.0

.

See also:

replace(path:String, ?newHistoryState:Dynamic, ?transition:(DisplayObject, DisplayObject) ‑> IEffectContext):DisplayObject

Replaces the current entry onto the history stack. The route to display will be determined automatically.

The following example navigates to the "/settings" URL path without adding a new history entry:

navigator.replace("/settings");
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

.

removeAllItems():Void

Removes all items that were 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

.