Packagefeathers.controls
Classpublic class PageIndicator
InheritancePageIndicator Inheritance FeathersControl Inheritance starling.display.Sprite

Displays a selected index, usually corresponding to a page index in another UI control, using a highlighted symbol.

See also

How to use the Feathers PageIndicator component


Public Properties
 PropertyDefined By
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
  direction : String
The symbols may be positioned vertically or horizontally.
PageIndicator
 InheritedfocusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 InheritedfocusManager : IFocusManager
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
FeathersControl
 InheritedfocusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 InheritedfocusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 InheritedfocusPaddingTop : 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
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all PageIndicator components.
PageIndicator
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
  horizontalAlign : String
The alignment of the symbols on the horizontal axis.
PageIndicator
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
  interactionMode : String
Determines how the selected index changes on touch.
PageIndicator
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
FeathersControl
  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
  pageCount : int
The number of available pages.
PageIndicator
 InheritedpreviousTabFocus : IFocusDisplayObject
FeathersControl
  selectedIndex : int
The currently selected index.
PageIndicator
  selectedSymbolFactory : Function
A function used to create a selected symbol.
PageIndicator
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
  verticalAlign : String
The alignment of the symbols on the vertical axis.
PageIndicator
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the globalStyleProvider property is set to this value.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
Public Methods
 MethodDefined By
  
Constructor.
PageIndicator
 Inherited
hideFocus():void
If the visual indicator of focus has been displayed by showFocus(), call this function to hide it.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
If the object has focus, an additional visual indicator may optionally be displayed to highlight the object.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
  Dispatched when the selected item changes.PageIndicator
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
Public Constants
 ConstantDefined By
  DIRECTION_HORIZONTAL : String = horizontal
[static] The page indicator's symbols will be positioned horizontally, from left to right.
PageIndicator
  DIRECTION_VERTICAL : String = vertical
[static] The page indicator's symbols will be positioned vertically, from top to bottom.
PageIndicator
  HORIZONTAL_ALIGN_CENTER : String = center
[static] The symbols will be horizontally aligned to the center.
PageIndicator
  HORIZONTAL_ALIGN_LEFT : String = left
[static] The symbols will be horizontally aligned to the left.
PageIndicator
  HORIZONTAL_ALIGN_RIGHT : String = right
[static] The symbols will be horizontally aligned to the right.
PageIndicator
  INTERACTION_MODE_PRECISE : String = precise
[static] Touching the page indicator on a symbol will select that symbol's exact index.
PageIndicator
  INTERACTION_MODE_PREVIOUS_NEXT : String = previousNext
[static] Touching the page indicator on the left of the selected symbol will select the previous index and to the right of the selected symbol will select the next index.
PageIndicator
 InheritedINVALIDATION_FLAG_ALL : String = all
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = data
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = focus
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = layout
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = scroll
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = selected
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = size
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = skin
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = state
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = styles
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
  VERTICAL_ALIGN_BOTTOM : String = bottom
[static] The symbols will be vertically aligned to the bottom.
PageIndicator
  VERTICAL_ALIGN_MIDDLE : String = middle
[static] The symbols will be vertically aligned to the middle.
PageIndicator
  VERTICAL_ALIGN_TOP : String = top
[static] The symbols will be vertically aligned to the top.
PageIndicator
Property Detail
directionproperty
direction:String

The symbols may be positioned vertically or horizontally.

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

         pages.direction = PageIndicator.DIRECTION_VERTICAL;

The default value is PageIndicator.DIRECTION_HORIZONTAL.


Implementation
    public function get direction():String
    public function set direction(value:String):void

See also

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


Implementation
    public function get gap():Number
    public function set gap(value:Number):void
globalStyleProviderproperty 
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all PageIndicator components.

The default value is null.

See also

horizontalAlignproperty 
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 = PageIndicator.HORIZONTAL_ALIGN_RIGHT;

The default value is PageIndicator.HORIZONTAL_ALIGN_CENTER.


Implementation
    public function get horizontalAlign():String
    public function set horizontalAlign(value:String):void

See also

interactionModeproperty 
interactionMode:String

Determines how the selected index changes on touch.

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

         pages.direction = PageIndicator.INTERACTION_MODE_PRECISE;

The default value is PageIndicator.INTERACTION_MODE_PREVIOUS_NEXT.


Implementation
    public function get interactionMode():String
    public function set interactionMode(value:String):void

See also

normalSymbolFactoryproperty 
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 );
         };


Implementation
    public function get normalSymbolFactory():Function
    public function set normalSymbolFactory(value:Function):void

See also

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


Implementation
    public function get padding():Number
    public function set padding(value:Number):void

See also

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


Implementation
    public function get paddingBottom():Number
    public function set paddingBottom(value:Number):void
paddingLeftproperty 
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.


Implementation
    public function get paddingLeft():Number
    public function set paddingLeft(value:Number):void
paddingRightproperty 
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.


Implementation
    public function get paddingRight():Number
    public function set paddingRight(value:Number):void
paddingTopproperty 
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.


Implementation
    public function get paddingTop():Number
    public function set paddingTop(value:Number):void
pageCountproperty 
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
selectedIndexproperty 
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
selectedSymbolFactoryproperty 
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 );
         };


Implementation
    public function get selectedSymbolFactory():Function
    public function set selectedSymbolFactory(value:Function):void

See also

verticalAlignproperty 
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 = PageIndicator.VERTICAL_ALIGN_BOTTOM;

The default value is PageIndicator.VERTICAL_ALIGN_MIDDLE.


Implementation
    public function get verticalAlign():String
    public function set verticalAlign(value:String):void

See also

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:

PropertyValue
bubblesfalse
currentTargetThe 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.
datanull
targetThe 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.

Constant Detail
DIRECTION_HORIZONTALConstant
public static const DIRECTION_HORIZONTAL:String = horizontal

The page indicator's symbols will be positioned horizontally, from left to right.

See also

DIRECTION_VERTICALConstant 
public static const DIRECTION_VERTICAL:String = vertical

The page indicator's symbols will be positioned vertically, from top to bottom.

See also

HORIZONTAL_ALIGN_CENTERConstant 
public static const HORIZONTAL_ALIGN_CENTER:String = center

The symbols will be horizontally aligned to the center.

See also

HORIZONTAL_ALIGN_LEFTConstant 
public static const HORIZONTAL_ALIGN_LEFT:String = left

The symbols will be horizontally aligned to the left.

See also

HORIZONTAL_ALIGN_RIGHTConstant 
public static const HORIZONTAL_ALIGN_RIGHT:String = right

The symbols will be horizontally aligned to the right.

See also

INTERACTION_MODE_PRECISEConstant 
public static const INTERACTION_MODE_PRECISE:String = precise

Touching the page indicator on a symbol will select that symbol's exact index.

See also

INTERACTION_MODE_PREVIOUS_NEXTConstant 
public static const INTERACTION_MODE_PREVIOUS_NEXT:String = previousNext

Touching the page indicator on the left of the selected symbol will select the previous index and to the right of the selected symbol will select the next index.

See also

VERTICAL_ALIGN_BOTTOMConstant 
public static const VERTICAL_ALIGN_BOTTOM:String = bottom

The symbols will be vertically aligned to the bottom.

See also

VERTICAL_ALIGN_MIDDLEConstant 
public static const VERTICAL_ALIGN_MIDDLE:String = middle

The symbols will be vertically aligned to the middle.

See also

VERTICAL_ALIGN_TOPConstant 
public static const VERTICAL_ALIGN_TOP:String = top

The symbols will be vertically aligned to the top.

See also