AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.FormBuilderPages Class

    Extends: A.Base
    Defined in: alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:34
    Module: aui-form-builder-page-manager
    Parent Module: aui-form-builder

    A base class for Form Builder Pages Builder.

    Constructor

    A.FormBuilderPages

    (
    • config
    )

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:34

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _addPage

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:157

    Create a new page on Form Builder.

    _addTab

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:185

    Create a new tab on Form Builder.

    _afterActivePageNumberChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:204

    Fired after the activePageNumber attribute changes.

    Parameters:

    _afterModeChange

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:215

    Fired after the mode attribute changes.

    _afterPagesQuantityChange

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:225

    Fired after the pagesQuantity attribute changes.

    _afterTabViewSelectionChange

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:236

    Fired after the selection attribute from the tabview changes.

    _createPagination

    () A.Pagination protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:256

    Creates pagination.

    Returns:

    A.Pagination:

    _createPopover

    () A.Popover protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:278

    Creates popover.

    Returns:

    A.Popover:

    _createTabView

    () A.TabView protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:325

    Creates tab view.

    Returns:

    A.TabView:

    _createUntitledPageLabel

    (
    • activePageNumber
    • pagesQuantity
    )
    String protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:345

    Returns an untitled page string based on strings attribute.

    Parameters:

    Returns:

    String:

    _disablePaginationView

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:365

    Disable Pagination items.

    _disableTabView

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:375

    Disable TabView items.

    _enablePaginationView

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:399

    Enable TabView items.

    _enablePaginationView

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:389

    Enable Pagination items.

    _getDeleteButtonLabel

    () String protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:413

    Returns the delete button string according to the page quantity.

    Returns:

    String:

    _getPagination

    () A.Pagination protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:433

    Returns the pagination instance.

    Returns:

    A.Pagination:

    _getPopover

    () A.Popover protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:452

    Returns the popover instance.

    Returns:

    A.Popover:

    _getTabView

    () A.TabView protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:463

    Returns the tab view instance.

    Returns:

    A.TabView:

    _onAddLastPageClick

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:495

    Fired on Add new page after last element clicked.

    _onCurrentPageChange

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:507

    Fired on current page change.

    _onDescriptionInputValueChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:518

    Fired on description input value change.

    Parameters:

    _onRemovePageClick

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:531

    Fired on remove button clicked.

    _onSwitchViewClick

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:568

    Fired on switch view button clicked.

    _onTitleInputValueChange

    (
    • event
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:585

    Fired on title input value change.

    Parameters:

    _removeTab

    (
    • index
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:609

    Remove a tab from Form Builder.

    Parameters:

    _renderFooterPagination

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:627

    Render default footer pagination

    _renderTopPagination

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:637

    Render default top pagination

    _syncPopoverContent

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:647

    Updates the popover content ui.

    _uiSetActivePageNumber

    (
    • activePageNumber
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:659

    Updates the ui according to the value of the activePageNumber attribute.

    Parameters:

    _uiSetMode

    (
    • type
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:684

    Switch the pages mode view.

    Parameters:

    • type String

    _uiSetPagesQuantity

    (
    • total
    )
    protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:708

    Updates the ui according to the value of the pagesQuantity attribute.

    Parameters:

    _updateTabViewContent

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:726

    Update all tabs title based on titles attribute.

    destructor

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:110

    Destructor lifecycle implementation for the A.FormBuilderPages class. Lifecycle.

    disablePaginations

    ()

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:137

    Disable PaginationVeiw and TabView.

    enablePaginations

    ()

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:147

    Enable PaginationVeiw and TabView.

    initializer

    () protected

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:69

    Construction logic executed during the A.FormBuilderPages instantiation. Lifecycle.

    Attributes

    activePageNumber

    Number

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:751

    Index of the current active page.

    Default: 1

    descriptions

    Array

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:762

    List of all pages descriptions.

    Default: []

    mode

    String

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:774

    The mode of the pages visualization. Could be pagination or tabs.

    Default: 'pagination'

    pageHeader

    Node

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:788

    Container for the page's header.

    Default: null

    pagesQuantity

    Number

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:801

    Total of pages.

    Default: 0

    paginationContainer

    Node

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:812

    Container for the paginator.

    Default: null

    strings

    Object

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:825

    Collection of strings used to label elements of the UI. To Untitled Page text, the string used should follow this have placeholder to Active Page Number and Pages Quantity, e.g. Untitled Page ({activePageNumber} of {pagesQuantity}).

    tabviewContainer

    Node

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:845

    Container for the tab view.

    Default: null

    titles

    Array

    Defined in alloy-ui/src/aui-form-builder/js/aui-form-builder-page-manager.js:858

    List of all pages titles.

    Default: []