Displays a series of dots or other symbols, usually corresponding to a page index in another UI control, such as PageNavigator.

The following example creates a page indicator, sets its range and selected index, and lsitens for when the selection changes:

var pages = new PageIndicator();

pages.maxSelectedIndex = 5;
pages.selectedIndex = 1;

pages.addEventListener(Event.CHANGE, (event:Event) -> {
	var pages = cast(event.currentTarget, PageIndicator);
	trace("PageIndicator changed: " + pages.selectedIndex);
});

Events:

openfl.events.Event.CHANGE

Dispatched when PageIndicator.selectedIndex changes.

Available since

1.0.0

.

See also:

Static variables

@:value("pageIndicator_toggleButton")staticfinalread onlyCHILD_VARIANT_TOGGLE_BUTTON:String = "pageIndicator_toggleButton"

The variant used to style the toggle button child components in a theme.

To override this default variant, set the PageIndicator.customToggleButtonVariant property.

Available since

1.0.0

.

See also:

Constructor

@:value({ maxSelectedIndex : -1 })new(maxSelectedIndex:Int = -1, ?changeListener:Event ‑> Void)

Creates a new PageIndicator object.

Available since

1.0.0

.

Variables

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin to display behind the buttons.

The following example passes a bitmap for the page indicator to use as a background skin:

pages.backgroundSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

See also:

@:style@:flash.propertycustomToggleButtonVariant:String

A custom variant to set on all toggle buttons, instead of PageIndicator.CHILD_VARIANT_TOGGLE_BUTTON.

The customToggleButtonVariant will be not be used if the result of toggleButtonRecycler.create() already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertydisabledBackgroundSkin:DisplayObject

A background skin to display behind the buttons when the page indicator is disabled.

The following example gives the page indicator a disabled background skin:

pages.disabledBackgroundSkin = new Bitmap(bitmapData);
pages.enabled = false;
Available since

1.0.0

.

See also:

interactionMode:PageIndicatorInteractionMode

Determines how the selected index changes when the page indicator is clicked or tapped. If precise, the exact page must be chosen. If previous/next, the selection increases or decreases by one. Previous/next interaction is recommended on mobile, due to the low precision of touches.

In the following example, the interaction mode is changed to precise:

pages.interactionMode = PRECISE;
Available since

1.0.0

.

@:style@:flash.propertylayout:ILayout

The layout algorithm used to position and size the buttons.

By default, if no layout is provided by the time that the page indicator initializes, a default layout that displays items horizontally will be created.

The following example tells the page indicator to use a custom layout:

var layout = new HorizontalDistributedLayout();
layout.maxItemWidth = 300.0;
pages.layout = layout;
Available since

1.0.0

.

toggleButtonRecycler:AbstractDisplayObjectRecycler<Dynamic, PageIndicatorItemState, ToggleButton>

Manages toggle buttons used by the page indicator.

In the following example, the page indicator uses a custom toggle button:

pages.toggleButtonRecycler = DisplayObjectRecycler.withClass(ToggleButtonSubClass);
Available since

1.0.0

.

Methods

indexToToggleButton(index:Int):ToggleButton

Returns the current toggle button used to render the item at the specified index in the data provider. May return null if an item doesn't currently have a toggle button.

Available since

1.0.0

.

Inherited Variables

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

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:

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

.