MAF.control.PageIndicator

Configs

updateText : {function}

Function to call for updating the indicator text.

Methods

animate(config) inherited

Parameters:

Name	Type	Description
config	Object	A config object

Fires:

• MAF.element.Core#event:onAnimationEnded

appendTo() → {Class} inherited

Appends this component to a parent.

Returns:

This component.

attachToSource()

Attach this to a source to listen to state update events.

createContent() virtualinherited

After the component has appended to the view this method can be used to create some more content to be added to this component. This can be implemented (or overridden) by objects that inherit the member.

focus() inherited

This will try and focus this component. If it cannot recieve focus, this focus will stay on the currently focused component.

freeze() → {Class} inherited

Freezes this component. Screen renders no longer trigger until thawed.

Returns:

This component.

generateStatePacket() privateinherited

Gives a object containing values needed for keeping the state of this component between different views.

getAbsolutePosition() → {Object} inherited

Give back the position relative to its first positioned ancestor element

Returns:

{hOffset:Number, vOffset: Number}

getSourceCarousel() → {Boolean}

Check if the attached component is configured to act like a carousel.

Returns:

True if source is acting like a carousel.

getSourceCurrentPage() → {Number}

What is the currently active page in the attached component.

Returns:

Active page.

getSourcePageCount() → {Number}

How many pages are in the attached component.

Returns:

Number of pages.

getView() → {Class} inherited

Returns:

Returns the view this class is appended on.

hide() → {Class} inherited

Hides this component.

Returns:

This component.

initialize() inherited

Initialize the class

inspectStatePacket() inherited

Handle the state of this component for example when returning on the view it is on.

setDisabled(disabled) inherited

Change the disabled state of the component. A disabled component will not be able to recieve focus.

If not changed in extended component it will also set opacity to 05 when disabled.

Parameters:

Name	Type	Argument	Default	Description
disabled	boolean	optional	false	True will disable the component, false will enable it.

setSecure(secure) → {Class} inherited

Parameters:

Name	Type	Description
secure	boolean

Returns:

This component.

shiftSource(direction)

Change the page the attached component is on.

Parameters:

Name	Type	Description
direction	String	Which direction to change the page to. See for example MAF.element.Grid#shift

show() → {Class} inherited

Shows this component.

Returns:

This component.

thaw() → {Class} inherited

Thawes this component. Screen renders can trigger again.

Returns:

This component.

toggleDisabled() → {Class} inherited

Toggle between the disable states of the component.

Returns:

This component.

toggleSecure() → {Class} inherited

Toggle between the secure states of the component.

Returns:

This component.

verifySecure() inherited

Events

onAnimationEnded

Fired when a animation on this component has ended.

onAppend

Fired when component has appended to a parent. Update visual appearances by applying a Theme style and rendering the skin.

onBlur

Fired when the component is blurred.

onFocus

Fired when the component recieves focus.

onNavigate

Fired when a navigation happens when the component has focus.

onSecureFailed

Fired when the component is secured and it fails to verify the security after a select.

onSelect

Fired when the component is selected.