Flexberry Documentation Flexberry Documentation

  • API Docs for Version: develop

    • APIs

    Show:

    PaginatedController Class

    Uses
    Defined in: addon/mixins/paginated-controller.js:8
    Module: ember-flexberry

    Mixin for controller, that pagination support.

    Methods

    _addPageNumberIntoArray

    (
    • arr
    • pageNumber
    • isEllipsis
    )
    private

    Defined in addon/mixins/paginated-controller.js:293

    Add page number into array.

    Parameters:

    • arr Array

      Array pages.

    • pageNumber Number

      Number of page.

    • isEllipsis Boolean

      If true this page not showing in list.

    _checkPageNumber

    (
    • pageNum
    )
    Boolean private

    Defined in addon/mixins/paginated-controller.js:325

    Check there is a page with this number.

    Parameters:

    • pageNum Number

      Number of page.

    Returns:

    Boolean:

    If page exists, return pageNum, else, return lastPage.

    _createColumn

    () private

    Defined in addon/mixins/olv-toolbar-controller.js:571

    Create the column.

    _filtersPredicate

    (
    • componentName
    )
    BasePredicate | Undefined private

    Defined in addon/mixins/multi-list-route.js:135

    Return predicate for QueryBuilder or undefined.

    Parameters:

    • componentName String

      Component name.

    Returns:

    BasePredicate | Undefined:

    Predicate for QueryBuilder or undefined.

    _generateColumns

    () private

    Defined in addon/mixins/olv-toolbar-controller.js:477

    Generate the columns.

    _getGeneratedColumns

    (
    • projectionAttributes
    • settingsSource
    • fixedColumns
    • colsOrder
    • sorting
    )
    private

    Defined in addon/mixins/olv-toolbar-controller.js:346

    Get columns info.

    Parameters:

    _getLastPage

    (
    • perPage
    • count
    )
    Number private

    Defined in addon/mixins/paginated-controller.js:311

    Get number last page.

    Parameters:

    • perPage Number

      Count records on page.

    • count Number

      Total count records.

    Returns:

    Number:

    Number last page.

    _reloadListByName

    (
    • componentName
    )
    private

    Defined in addon/mixins/multi-list-route.js:162

    Reloads list's data by name.

    Parameters:

    • componentName String

      Component name.

    _showConfigDialog

    (
    • componentName
    • settingName
    • settingsSource
    • isExportExcel
    • immediateExport
    )
    private

    Defined in addon/mixins/olv-toolbar-controller.js:176

    Show columns config dialog.

    Parameters:

    _showSortGeDialog

    (
    • componentName
    • useSidePageMode
    • modelProjection
    • geSorting
    )
    private

    Defined in addon/mixins/olv-toolbar-controller.js:439

    Show columns config dialog for groupedit.

    Parameters:

    actions.firstPage

    ()

    Defined in addon/mixins/paginated-controller.js:283

    Transition to first page.

    actions.getGeneratedColumns

    (
    • componentName
    • settingName
    • modelProjection
    • geSorting
    )

    Defined in addon/mixins/olv-toolbar-controller.js:99

    Show columns config dialog.

    Parameters:

    • componentName Object

      Component name.

    • settingName Object

      Setting name.

    • modelProjection Object

      Model projection.

    • geSorting Object

      Current sorting.

    actions.gotoPage

    (
    • pageNum
    )

    Defined in addon/mixins/paginated-controller.js:240

    Transition to page with number.

    Parameters:

    • pageNum Number

      Number of page.

    actions.lastPage

    ()

    Defined in addon/mixins/paginated-controller.js:273

    Transition to last page.

    actions.nextPage

    ()

    Defined in addon/mixins/paginated-controller.js:251

    Transition to next page.

    actions.previousPage

    ()

    Defined in addon/mixins/paginated-controller.js:262

    Transition to previous page.

    actions.reloadListByName

    (
    • componentName
    )

    Defined in addon/mixins/multi-list-route.js:102

    Reload list's data by name.

    Parameters:

    • componentName String

      Component name.

    actions.showAdvLimitDialog

    (
    • componentName
    • advLimitName
    )

    Defined in addon/mixins/olv-toolbar-controller.js:146

    Show adv limit config dialog.

    Parameters:

    • componentName Object

      Component name.

    • advLimitName Object

      Adv limit name.

    actions.showConfigDialog

    (
    • componentName
    • settingName
    • useSidePageMode
    • isExportExcel
    • immediateExport
    )

    Defined in addon/mixins/olv-toolbar-controller.js:72

    Show columns config dialog.

    Parameters:

    • componentName Object

      Component name.

    • settingName Object

      Setting name.

    • useSidePageMode Object

      Indicates when use side page mode.

    • isExportExcel Object

      Indicates if it's export excel dialog.

    • immediateExport Object

      Indicate if auto export is needed.

    actions.showFiltersDialog

    (
    • componentName
    • filterColumns
    )

    Defined in addon/mixins/olv-toolbar-controller.js:121

    Show filters dialog.

    Parameters:

    • componentName Object

      Component name.

    • filterColumns Object

      columns with available filters.

    actions.showSortGeDialog

    (
    • componentName
    • useSidePageMode
    • modelProjection
    • geSorting
    )

    Defined in addon/mixins/olv-toolbar-controller.js:86

    Show columns config dialog for groupedit.

    Parameters:

    • componentName Object

      Component name.

    • useSidePageMode Object

      Indicates when use side page mode.

    • modelProjection Object

      Model projection.

    • geSorting Object

      Current sorting.

    setSorting

    (
    • componentName
    • sorting
    )

    Defined in addon/mixins/multi-list-route.js:83

    Sets sorting and reload component content by component name.

    Parameters:

    • componentName String

      Component name.

    • sorting Array

      Sorting object.

    Properties

    _groupEditEventsService

    Service private

    Defined in addon/mixins/olv-toolbar-controller.js:17

    Service that triggers FlexberryGroupeditComponent events.

    advLimit

    AdvLimitService

    Defined in addon/mixins/multi-list-route.js:34

    Service for managing advLimits for lists.

    advLimit

    AdvLimit

    Defined in addon/mixins/olv-toolbar-controller.js:44

    Service for managing advLimits for lists.

    advLimitController

    Ember.InjectedProperty

    Defined in addon/mixins/olv-toolbar-controller.js:26

    Controller to show advlimit config modal window.

    Default: Ember.inject.controller('advlimit-dialog')

    cellComponent

    Object

    Defined in addon/mixins/olv-toolbar-controller.js:52

    Default cell component that will be used to display values in columns cells.

    Sub-properties:

    • [componentName=undefined] String optional
    • [componentProperties=null] String optional

    currentColumnsWidths

    Object

    Defined in addon/mixins/olv-toolbar-controller.js:64

    Columns widtghs for current component.

    filtersDialogController

    Ember.InjectedProperty

    Defined in addon/mixins/olv-toolbar-controller.js:35

    Controller to show filters modal window.

    Default: Ember.inject.controller('filters-dialog')

    hasNextPage

    Boolean

    Defined in addon/mixins/paginated-controller.js:133

    If true next page exists.

    hasPreviousPage

    Boolean

    Defined in addon/mixins/paginated-controller.js:146

    If true previous page exists.

    multiListSettings

    Object

    Defined in addon/mixins/multi-list-route.js:18

    Settings for all lists on form.

    objectlistviewEvents

    Service

    Defined in addon/mixins/multi-list-route.js:26

    Service that triggers objectlistview events.

    page

    Number

    Defined in addon/mixins/paginated-controller.js:51

    Start page.

    Default: 1

    pages

    Array

    Defined in addon/mixins/paginated-controller.js:157

    Array of objects corresponding to list of pages.

    Each page is presented as object with following properties:

    • number - Number of page.
    • isCurrent - Page is current.
    • isEllipsis - If true this page not showing in list.

    perPage

    Number

    Defined in addon/mixins/paginated-controller.js:60

    Count records on page.

    Default: 5

    perPageValue

    Number

    Defined in addon/mixins/paginated-controller.js:78

    Get or set perPage value.

    perPageValues

    Array

    Defined in addon/mixins/paginated-controller.js:69

    User selectable options values for perPage.

    Default: [5, 10, 20, 50]

    queryParams

    Array

    Defined in addon/mixins/paginated-controller.js:230

    Defines which query parameters the controller accepts. More info..

    Default: ['page', 'perPage']

    recordsTotalCount

    Number

    Defined in addon/mixins/paginated-controller.js:122

    Total count records.