AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.LayoutBuilderResizeCol Class

    Defined in: alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:22
    Module: aui-layout-builder-resize-col

    LayoutBuilder extension, which can be used to add the funcionality of resizing columns of the builder's layout.

    Constructor

    A.LayoutBuilderResizeCol

    (
    • config
    )

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:22

    Parameters:

    • config Object

      Object literal specifying layout builder configuration properties.

    Methods

    _afterDragAlign

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:93

    Fired when the drag:align event is triggered.

    _afterDragEnd

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:120

    Fired when the drag:end event is triggered.

    _afterDragEnter

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:153

    Fired when the drag:enter event is triggered.

    Parameters:

    _afterDragMouseDown

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:168

    Fired when the drag:mouseDown event is triggered.

    Parameters:

    _afterDragMouseup

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:191

    Fired when the drag:mouseup event is triggered.

    Parameters:

    _afterDragStart

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:209

    Fired when the drag:start event is triggered.

    Parameters:

    _afterEnableResizeColsChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:227

    Fired after the enableResizeCols attribute changes.

    _afterResizeColIsColumnModeChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:237

    Fired after the isColumnMode changes.

    _afterResizeColLayoutChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:247

    Fired after the layout attribute is set.

    _afterResizeColLayoutColsChange

    () protected

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

    Fired after the cols attribute from a layout row is set.

    _afterResizeColLayoutRowsChange

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:258

    Fired after the rows attribute from the layout is set.

    _bindResizeColEvents

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:280

    Binds the necessary events for the functionality of resizing layout columns.

    _canDrop

    (
    • dragNode
    • position
    )
    Boolean protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:307

    Checks if a drag node can be dropped in the given position.

    Parameters:

    Returns:

    Boolean:

    _createDelegateDrag

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:346

    Creates the A.DD.Delegate instance responsible for the dragging functionality.

    _handleBreakpointDrop

    (
    • dragNode
    • dropNode
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:371

    Handles the action of dropping a drag handler on top of a breakpoint.

    Parameters:

    _hideBreakpoints

    (
    • rowNode
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:411

    Hides all the breakpoints in the given row.

    Parameters:

    _hideColDraggableBoundaries

    () protected

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

    Hides all the draggable bars.

    _insertColumnAfterDropHandles

    (
    • dragNode
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:434

    Add new column for the given layout row after drop handler.

    Parameters:

    _insertGrid

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:472

    Inserts a grid to the current row in order to visualize the possible breakpoints.

    _onKeyPressResizeColBreakpoint

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:548

    Fired when the user starts the action to resize a col.

    Parameters:

    _onKeyPressResizeColDragHandle

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:571

    Fired when the enter button is pressed on drag handle.

    Parameters:

    _onMouseEnterCol

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:500

    Fired when the cursor is over a column.

    Parameters:

    _onMouseEnterDraggable

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:535

    Fired when the cursor is over a Draggable bar.

    Parameters:

    _onMouseEnterDraggable

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:515

    Fired when the cursor is over a Draggable bar.

    Parameters:

    _removeDragHandles

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:600

    Removes all the drag handles from the layout.

    _removeGrid

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:610

    Removes the grid from the target.

    _resize

    (
    • dragNode
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:626

    Resizes cols after a resize event.

    Parameters:

    _showBreakpoints

    (
    • row
    • dragNode
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:643

    Shows all breakpoints in the given row. We need to show the drop targets before drag:start event, or they won't work.

    Parameters:

    _showColDraggableBoundaries

    (
    • colNode
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:659

    Shows draggable bars of a column.

    Parameters:

    _syncDragHandles

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:681

    Updates the drag handles for all the layout rows.

    _syncRowDragHandles

    (
    • row
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:696

    Updates the drag handles for the given layout row.

    Parameters:

    _uiSetEnableResizeCols

    (
    • enableResizeCols
    )
    protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:724

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

    Parameters:

    • enableResizeCols Boolean

    _unbindResizeColEvents

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:746

    Unbinds the events related to the functionality of resizing layout columns.

    destructor

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:80

    Destructor implementation for the A.LayoutBuilderResizeCol class. Lifecycle.

    initializer

    () protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:60

    Construction logic executed during A.LayoutBuilderResizeCol instantiation. Lifecycle.

    Properties

    _dragNode

    Node protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:42

    Keeps a reference for dragNode for keyboard purposes only.

    _gridlineNodes

    Array protected

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:51

    Grid line nodes.

    ATTRS

    Object static

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:760

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

    Attributes

    enableResizeCols

    Boolean

    Defined in alloy-ui/src/aui-layout/js/aui-layout-builder-resize-col.js:769

    Flag indicating if the feature of resizing layout columns is enabled or not.

    Default: true