A container that supports navigation between views using a PageIndicator.

The following example creates a page navigator and adds some items:

var navigator = new PageNavigator();
navigator.dataProvider = new ArrayCollection([
	PageItem.withClass(WizardView1),
	PageItem.withClass(WizardView1),
	PageItem.withClass(WizardView3)
]);
addChild(this.navigator);
Available since

1.0.0

.

See also:

Static variables

@:value("pageNavigator_pageIndicator")staticfinalread onlyCHILD_VARIANT_PAGE_INDICATOR:String = "pageNavigator_pageIndicator"

The variant used to style the PageIndicator child component.

To override this default variant, set the PageNavigator.customPageIndicatorVariant property.

Available since

1.0.0

.

See also:

Constructor

new(?dataProvider:IFlatCollection<PageItem>)

Creates a new PageNavigator object.

Available since

1.0.0

.

Variables

@:style@:flash.propertycustomPageIndicatorVariant:String

An optional custom variant to use for the page indicator sub-component, instead of PageNavigator.CHILD_VARIANT_PAGE_INDICATOR.

The customPageIndicatorVariant will be not be used if the result of pageIndicatorFactory already has a variant set.

Available since

1.0.0

.

See also:

dataProvider:IFlatCollection<PageItem>

The collection of PageItem data displayed by the navigator.

All PageItem instances in the collection must be unique. Do not add the same instance to the collection more than once because a runtime exception may be thrown.

Available since

1.0.0

.

@:style@:flash.propertygap:Float

The space, measured in pixels, between the navigator's active view and its page indicator.

Available since

1.0.0

.

pageIndicatorFactory:AbstractDisplayObjectFactory<Dynamic, PageIndicator>

Creates the page indicator, which must be of type feathers.controls.PageIndicator.

In the following example, a custom page indicator factory is provided:

navigator.pageIndicatorFactory = () ->
{
	return new PageIndicator();
};
Available since

1.0.0

.

See also:

@:style@:flash.propertypageIndicatorPosition:RelativePosition

The position of the navigator's page indicator.

Available since

1.0.0

.

simulateTouch:Bool

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

Available since

1.0.0

.

See also:

swipeEnabled:Bool

If true, a swipe left or right with touch may be used to navigate to the previous or next page.

Available since

1.0.0

.

See also:

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

The default transition to use for navigating to the next page.

Available since

1.0.0

.

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

The default transition to use for navigating to the previous page.

Available since

1.0.0

.

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:

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

.

@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

.

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:

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

Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.

When a component initializes, its style provider sets properties that affect the component's visual appearance. If the style provider dispatches StyleProviderEvent.STYLES_CHANGE after the component has initialized, the original properties set by the style provider will be reset to their default values and before applying the new property values.

Setting the style provider or replacing an existing style provider before a component initializes will queue up the style changes until after initialization. Once a component initializes, the style provider may be changed, but the changes will be applied immediately. Similarly to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE, any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

If the themeEnabled property is false, the current theme's style provider will be ignored. However, if a custom style provider was provided from outside of the theme, it will still be used.

Available since

1.0.0

.

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 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

.

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

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

.

Defined by MeasureSprite

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

.