MAF.element.Button

This is a button component without styling.

This component extends from the MAF.element.Container and adds ability for securing the action behind onSelect.

new MAF.element.Button()

Configs

focus : {Boolean}

Initializes the component with the ability to focus or not. Default is true (enabled focus).

secure : {Boolean}

Indicates if the button is locked with an Admin PIN. Default is false.

Methods

animate(config) inherited

Parameters:

NameTypeDescription
configObject

A config object

Fires:

appendTo() → {Class}

Appends this component to a parent.

Returns:

This component.

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() private

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}

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

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

setDisabled(disabled)

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:

NameTypeArgumentDefaultDescription
disabledbooleanoptional false

True will disable the component, false will enable it.

setSecure(secure) → {Class}

Parameters:

NameTypeDescription
secureboolean

Returns:

This component.

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}

Toggle between the disable states of the component.

Returns:

This component.

toggleSecure() → {Class}

Toggle between the secure states of the component.

Returns:

This component.

verifySecure()

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.