AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.LayoutBuilderMove Class

    Defined in: alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:24
    Module: aui-layout-move

    A base class for Layout Move.

    Constructor

    A.LayoutBuilderMove

    (
    • config
    )

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:24

    Parameters:

    • config Object

      Object literal specifying layout configuration properties.

    Methods

    _addColMoveButton

    (
    • colNode
    • rowNode
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:99

    Default value for addColMoveButton attribute.

    Parameters:

    _addColMoveTarget

    (
    • col
    • index
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:116

    Default value for addColMoveTarget attribute.

    Parameters:

    _addMovingClass

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:134

    Adds CSS class to indicate that any element is moving.

    _afterEnableMoveColsChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:144

    Fired after the enableMoveCols attribute changes.

    _afterEnableMoveRowsChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:154

    Fired after the enableMoveRows attribute changes.

    _afterMoveColsChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:182

    Fired after cols attribute changes.

    _afterMoveIsColumnModeChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:192

    Fired after layout:isColumnMode attribute changes.

    Parameters:

    _afterMoveLayoutChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:215

    Fired after layout attribute changes.

    _afterMoveMovableChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:164

    Fired after layout-row:movable attribute changes.

    Parameters:

    _afterMoveRowsChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:225

    Fired after rows attribute changes.

    _appendMoveButtonToCols

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:252

    Appends a move button for each col.

    _appendMoveButtonToRows

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:235

    Appends one move button before each row.

    _bindMoveColsEvents

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:269

    Binds the necessary events for the functionality of moving cols on layout.

    _bindMoveRowEvents

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:287

    Binds the necessary events for the functionality of moving rows on layout.

    _chooseColMoveTarget

    (
    • cutButton
    • col
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:305

    Default value for chooseColMoveTarget attribute.

    Parameters:

    _clickColMoveTarget

    (
    • target
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:328

    Default value for clickColMoveTarget attribute.

    Parameters:

    _clickOnCutButton

    (
    • cutButton
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:342

    Starts or cancels movement of rows and cols.

    Parameters:

    _createRowTargetArea

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:373

    Default value for chooseRowMoveTarget attribute.

    _createRowTargetAreaInOneDirection

    (
    • direction
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:384

    Create target area to move the row to one direction.

    Parameters:

    • direction String

      Should be either 'before' or 'after'.

    _hasAnythingMovable

    (
    • row
    )
    Boolean protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:424

    Checks if the given row either can be moved or has at least one column that can.

    Parameters:

    Returns:

    Boolean:

    _insertCutButtonOnCols

    (
    • row
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:452

    Inserts cut buttons on cols.

    Parameters:

    _insertCutButtonOnRow

    (
    • row
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:484

    Inserts cut button on a row.

    Parameters:

    _moveToTarget

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:511

    Move col or row to another place.

    Parameters:

    _onEscKey

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:532

    Fires when the esc key is pressed.

    _onKeyPressOnMoveCutButton

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:542

    Fires when key press on cut button.

    Parameters:

    _onKeyPressOnMoveTarget

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:566

    Fires when key press on target area.

    Parameters:

    _onMouseClickOnMoveCutButton

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:554

    Fires when click on cut button.

    Parameters:

    _onMouseClickOnMoveTarget

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:577

    Fires when click on target area.

    Parameters:

    _removeAllCutButton

    (
    • cutButton
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:588

    Removes all cut buttons.

    Parameters:

    _removeColMoveButtons

    (
    • clickedButton
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:607

    Default value for removeColMoveButtons attribute.

    Parameters:

    • clickedButton Node

    _removeColMoveTargets

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:624

    Default value for removeColMoveTargets attribute.

    _removeCutButtonFromRow

    (
    • row
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:634

    Removes cut button from row.

    Parameters:

    _removeMovingClass

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:645

    Removes the CSS class indicating that some element has moving.

    _removeMovingClass

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:656

    Removes the CSS class indicating that some element has moving.

    _removeTargetArea

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:666

    Removes all target area.

    _resetMoveUI

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:677

    Reset the UI to a initial state.

    _uiSetEnableMoveCols

    (
    • enableMoveCols
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:693

    Updates the UI according to the value of the enableMoveCols attribute.

    Parameters:

    • enableMoveCols Boolean

    _uiSetEnableMoveRows

    (
    • enableMoveRows
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:710

    Updates the UI according to the value of the enableMoveRows attribute.

    Parameters:

    • enableMoveRows Boolean

    _unbindMoveColEvents

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:727

    Unbinds the events related to the functionality of moving cols from layout.

    _unbindMoveRowEvents

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:739

    Unbinds the events related to the functionality of moving rows from layout.

    cancelMove

    ()

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:90

    Cancels the ongoing move operation.

    destructor

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:79

    Destructor implementation for the A.LayoutBuilderMove class. Lifecycle.

    initializer

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:54

    Construction logic executed during instantiation. Lifecycle.

    Properties

    _colToBeMoved

    Node protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:36

    Col that will be moved.

    _rowToBeMoved

    Node protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:45

    Row that will be moved.

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:752

    Static property used to define the default attribute configuration for the A.LayoutBuilderMove.

    Attributes

    addColMoveButton

    Function

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:761

    Default function to add move button to cols.

    addColMoveTarget

    Function

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:774

    Default function to add target to cols.

    chooseColMoveTarget

    Function

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:787

    Default function to choose target on cols.

    chooseRowMoveTarget

    Function

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:800

    Default function to choose target on rows.

    clickColMoveTarget

    Function

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:813

    Default function to click on targets in cols.

    enableMoveCols

    Boolean

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:826

    Flag indicating if the feature of moving cols from layout is enabled or not.

    Default: true

    enableMoveRows

    Boolean

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:839

    Flag indicating if the feature of moving rows from layout is enabled or not.

    Default: true

    removeColMoveButtons

    Function

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:852

    Default function to remove move button from cols.

    removeColMoveTargets

    Function

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-move.js:865

    Default function to remove targets from cols.