feathers.controls.PageIndicator

Public Properties

	Property		Defined By
		addedEffect : Function An optional effect that is activated when the component is added to the stage.	FeathersControl
		defaultTextEditorFactory : Function [static] A function used by all UI controls that support text editor to create an ITextEditor instance.	FeathersControl
		defaultTextRendererFactory : Function [static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.	FeathersControl
		depth : int [read-only] The component's depth in the display list, relative to the stage.	FeathersControl
		effectsSuspended : Boolean [read-only] Indicates if effects have been suspended.	FeathersControl
		explicitHeight : Number [read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.	FeathersControl
		explicitMaxHeight : Number [read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.	FeathersControl
		explicitMaxWidth : Number [read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.	FeathersControl
		explicitMinHeight : Number [read-only] The minimum height value explicitly set by passing a value to the minHeight setter.	FeathersControl
		explicitMinWidth : Number [read-only] The minimum width value explicitly set by passing a value to the minWidth setter.	FeathersControl
		explicitWidth : Number [read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.	FeathersControl
		focusInEffect : Function An optional effect that is activated when the component receives focus.	FeathersControl
		focusManager : IFocusManager The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.	FeathersControl
		focusOutEffect : Function An optional effect that is activated when the component loses focus.	FeathersControl
		focusOwner : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.	FeathersControl
		globalStyleProvider : IStyleProvider [static] The default IStyleProvider for all PageIndicator components.	PageIndicator
		height : Number [override] The height of the component, in pixels.	FeathersControl
		hideEffect : Function An optional effect that is activated when the component is hidden.	FeathersControl
		includeInLayout : Boolean Determines if the ILayout should use this object or ignore it.	FeathersControl
		isCreated : Boolean [read-only] Determines if the component has been initialized and validated for the first time.	FeathersControl
		isEnabled : Boolean Indicates whether the control is interactive or not.	FeathersControl
		isFocusEnabled : Boolean The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.	FeathersControl
		isInitialized : Boolean [read-only] Determines if the component has been initialized yet.	FeathersControl
		isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list.	FeathersControl
		isShowingFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Indicates if the showFocus() method has been called on the object when it has focus.	FeathersControl
		layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm.	FeathersControl
		maintainTouchFocus : Boolean [read-only] The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. If true, the display object should remain in focus, even if something else is touched.	FeathersControl
		maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		minTouchHeight : Number If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.	FeathersControl
		minTouchWidth : Number If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.	FeathersControl
		minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.	FeathersControl
		moveEffect : Function An optional effect that is activated when the component is moved to a new position.	FeathersControl
		nextDownFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.DOWN is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextLeftFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.LEFT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextRightFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.RIGHT is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		nextTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.	FeathersControl
		nextUpFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when Keyboard.UP is pressed at KeyLocation.D_PAD and a focus manager is enabled.	FeathersControl
		pageCount : int The number of available pages.	PageIndicator
		previousTabFocus : IFocusDisplayObject The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.	FeathersControl
		resizeEffect : Function An optional effect that is activated when the component is resized with new dimensions.	FeathersControl
		selectedIndex : int The currently selected index.	PageIndicator
		showEffect : Function An optional effect that is activated when the component is shown.	FeathersControl
		styleName : String The concatenated styleNameList, with values separated by spaces.	FeathersControl
		styleNameList : TokenList [read-only] Contains a list of all "styles" assigned to this control.	FeathersControl
		styleProvider : IStyleProvider When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.	FeathersControl
		toolTip : String Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.	FeathersControl
		width : Number [override] The width of the component, in pixels.	FeathersControl

	Property	Defined By
		actualHeight : Number = 0 The final height value that should be used for layout.	FeathersControl
		actualMinHeight : Number = 0 The final minimum height value that should be used for layout.	FeathersControl
		actualMinWidth : Number = 0 The final minimum width value that should be used for layout.	FeathersControl
		actualWidth : Number = 0 The final width value that should be used for layout.	FeathersControl
		defaultStyleProvider : IStyleProvider [read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.	FeathersControl

	Method	Defined By
		PageIndicator() Constructor.	PageIndicator
		getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.	FeathersControl
		hideFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		initializeNow():void If the component has not yet initialized, initializes immediately.	FeathersControl
		invalidate(flag:String):void Call this function to tell the UI control that a redraw is pending.	FeathersControl
		isInvalid(flag:String = null):Boolean Indicates whether the control is pending validation or not.	FeathersControl
		move(x:Number, y:Number):void Sets both the x and the y positions of the control in a single function call.	FeathersControl
		removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void Plays an effect before removing the component from its parent.	FeathersControl
		resetStyleProvider():void Resets the styleProvider property to its default value, which is usually the global style provider for the component.	FeathersControl
		resumeEffects():void Indicates that effects should be re-activated after being suspended.	FeathersControl
		setSize(width:Number, height:Number):void Sets both the width and the height of the control in a single function call.	FeathersControl
		showFocus():void The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.	FeathersControl
		suspendEffects():void Indicates that effects should not be activated temporarily.	FeathersControl
		validate():void Immediately validates the display object, if it is invalid.	FeathersControl

	Method	Defined By
		clearInvalidationFlag(flag:String):void Clears an invalidation flag.	FeathersControl
		draw():void Override to customize layout and to adjust properties of children.	FeathersControl
		focusInHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.	FeathersControl
		focusOutHandler(event:Event):void Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.	FeathersControl
		ignoreNextStyleRestriction():void The next style that is set will not be restricted.	FeathersControl
		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.	FeathersControl
		processStyleRestriction(key:Object):Boolean Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.	FeathersControl
		refreshFocusIndicator():void Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.	FeathersControl
		saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean Saves the dimensions and minimum dimensions calculated for the component.	FeathersControl
		setInvalidationFlag(flag:String):void Sets an invalidation flag.	FeathersControl
		setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not.	FeathersControl

Summary	Defined By
change	Dispatched when the selected item changes.	PageIndicator
creationComplete	Dispatched after the component has validated for the first time.	FeathersControl
initialize	Dispatched after initialize() has been called, but before the first time that draw() has been called.	FeathersControl
resize	Dispatched when the width or height of the control changes.	FeathersControl

	Style	Defined By
		direction : String The symbols may be positioned vertically or horizontally.	PageIndicator
		focusIndicatorSkin : DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.	FeathersControl
		focusPadding : Number Quickly sets all focus padding properties to the same value.	FeathersControl
		focusPaddingBottom : Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.	FeathersControl
		focusPaddingLeft : Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.	FeathersControl
		focusPaddingRight : Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.	FeathersControl
		focusPaddingTop : Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.	FeathersControl
		gap : Number The spacing, in pixels, between symbols.	PageIndicator
		horizontalAlign : String The alignment of the symbols on the horizontal axis.	PageIndicator
		interactionMode : String Determines how the selected index changes on touch.	PageIndicator
		normalSymbolFactory : Function A function used to create a normal symbol.	PageIndicator
		padding : Number Quickly sets all padding properties to the same value.	PageIndicator
		paddingBottom : Number The minimum space, in pixels, between the bottom edge of the component and the bottom edge of the content.	PageIndicator
		paddingLeft : Number The minimum space, in pixels, between the left edge of the component and the left edge of the content.	PageIndicator
		paddingRight : Number The minimum space, in pixels, between the right edge of the component and the right edge of the content.	PageIndicator
		paddingTop : Number The minimum space, in pixels, between the top edge of the component and the top edge of the content.	PageIndicator
		selectedSymbolFactory : Function A function used to create a selected symbol.	PageIndicator
		verticalAlign : String The alignment of the symbols on the vertical axis.	PageIndicator

	Constant	Defined By
		INVALIDATION_FLAG_ALL : String = "all" [static] Flag to indicate that everything is invalid and should be redrawn.	FeathersControl
		INVALIDATION_FLAG_DATA : String = "data" [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_FOCUS : String = "focus" [static] Invalidation flag to indicate that the focus of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_LAYOUT : String = "layout" [static] Invalidation flag to indicate that the layout of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SCROLL : String = "scroll" [static] Invalidation flag to indicate that the scroll position of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SELECTED : String = "selected" [static] Invalidation flag to indicate that the selection of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_SIZE : String = "size" [static] Invalidation flag to indicate that the dimensions of the UI control have changed.	FeathersControl
		INVALIDATION_FLAG_SKIN : String = "skin" [static] Invalidation flag to indicate that the skin of the UI control has changed.	FeathersControl
		INVALIDATION_FLAG_STATE : String = "state" [static] Invalidation flag to indicate that the state has changed.	FeathersControl
		INVALIDATION_FLAG_STYLES : String = "styles" [static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.	FeathersControl

Property Detail

globalStyleProvider

property

public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all PageIndicator components.

The default value is null.

pageCount

property

pageCount:int

The number of available pages.

In the following example, the page count is changed:

pages.pageCount = 5;

The default value is 1.

Implementation
public function get pageCount():int
public function set pageCount(value:int):void

selectedIndex

property

selectedIndex:int

The currently selected index.

In the following example, the page indicator's selected index is changed:

pages.selectedIndex = 2;

The following example listens for when selection changes and requests the selected index:

function pages_changeHandler( event:Event ):void
{
    var pages:PageIndicator = PageIndicator( event.currentTarget );
    var index:int = pages.selectedIndex;
}
pages.addEventListener( Event.CHANGE, pages_changeHandler );

The default value is 0.

Implementation
public function get selectedIndex():int
public function set selectedIndex(value:int):void

Constructor Detail

PageIndicator

()

Constructor

public function PageIndicator()

Constructor.

Event Detail

change

Event

Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CHANGE

Dispatched when the selected item changes.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`data`	null
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

See also

selectedIndex

Style Detail

verticalAlign

style

verticalAlign:String

The alignment of the symbols on the vertical axis.

In the following example, the symbols are vertically aligned to the bottom:

pages.verticalAlign = VerticalAlign.BOTTOM;

Note: The VerticalAlign.JUSTIFY constant is not supported.

The default value is feathers.layout.VerticalAlign.MIDDLE.

selectedSymbolFactory

style

selectedSymbolFactory:Function

A function used to create a selected symbol. May be any Starling display object.

This function should have the following signature:

function():DisplayObject

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

pages.selectedSymbolFactory = function():DisplayObject
{
    return new Image( texture );
};

paddingLeft

style

paddingLeft:Number

The minimum space, in pixels, between the left edge of the component and the left edge of the content.

In the following example, the left padding is set to 20 pixels:

pages.paddingLeft = 20;

The default value is 0.

See also

padding

paddingBottom

style

paddingBottom:Number

The minimum space, in pixels, between the bottom edge of the component and the bottom edge of the content.

In the following example, the bottom padding is set to 20 pixels:

pages.paddingBottom = 20;

The default value is 0.

See also

padding

paddingRight

style

paddingRight:Number

The minimum space, in pixels, between the right edge of the component and the right edge of the content.

In the following example, the right padding is set to 20 pixels:

pages.paddingRight = 20;

The default value is 0.

See also

padding

paddingTop

style

paddingTop:Number

The minimum space, in pixels, between the top edge of the component and the top edge of the content.

In the following example, the top padding is set to 20 pixels:

pages.paddingTop = 20;

The default value is 0.

See also

padding

style

padding:Number

Quickly sets all padding properties to the same value. The padding getter always returns the value of paddingTop, but the other padding values may be different.

In the following example, the padding is set to 20 pixels:

pages.padding = 20;

The default value is 0.

normalSymbolFactory

style

normalSymbolFactory:Function

A function used to create a normal symbol. May be any Starling display object.

This function should have the following signature:

function():DisplayObject

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

pages.normalSymbolFactory = function():DisplayObject
{
    return new Image( texture );
};

interactionMode

style

interactionMode:String

Determines how the selected index changes on touch.

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

pages.interactionMode = PageIndicatorInteractionMode.PRECISE;

The default value is feathers.controls.PageIndicatorInteractionMode.PREVIOUS_NEXT.

horizontalAlign

style

horizontalAlign:String

The alignment of the symbols on the horizontal axis.

In the following example, the symbols are horizontally aligned to the right:

pages.horizontalAlign = HorizontalAlign.RIGHT;

Note: The HorizontalAlign.JUSTIFY constant is not supported.

The default value is feathers.layout.HorizontalAlign.CENTER.

gap

style

gap:Number

The spacing, in pixels, between symbols.

In the following example, the gap between symbols is set to 20 pixels:

pages.gap = 20;

The default value is 0.

direction

style

direction:String

The symbols may be positioned vertically or horizontally.

In the following example, the direction is changed to vertical:

pages.direction = Direction.VERTICAL;

Note: The Direction.NONE constant is not supported.

The default value is feathers.layout.Direction.HORIZONTAL.

Sat Jun 18 2022, 02:58 PM -07:00

Feathers (Starling) 4.1.1 API Reference	All Packages All Classes Index Frames No Frames
PageIndicator	Properties Methods Events Styles Constants

Package	feathers.controls
Class	public class PageIndicator
Inheritance	PageIndicator FeathersControl starling.display.Sprite