MAF.control.BackButton

    new MAF.control.BackButton()

    Example

    new MAF.control.BackButton({
   label: 'Back'
}).appendTo(this);

    Configs

    backParams : {Object}

    Object of data you want to send to the previous view when selected by a user.

    Methods

    animate(config) inherited

    Parameters:

    NameTypeDescription
    configObject

    A config object

    Fires:

    appendTo() → {Class} inherited

    Appends this component to a parent.

    Returns:

    This component.

    createContent()

    After the component has appended to the view this method can be used to create some more content to be added to this component. Default this will add 2 MAF.element.Text components to the content array of this component. The first has a Fontawesome glyph.

    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}

    getText()

    Get which text is displayed on this component.

    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:

    NameTypeArgumentDefaultDescription
    disabledbooleanoptional false

    True will disable the component, false will enable it.

    setSecure(secure) → {Class} inherited

    Parameters:

    NameTypeDescription
    secureboolean

    Returns:

    This component.

    setText(text)

    Set the text for the back button label.

    Parameters:

    NameTypeDescription
    textString

    What to display on the back button label.

    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.