Flexberry Documentation Flexberry Documentation

  • API Docs for Version: develop

    • APIs

    Show:

    ObjectlistviewEvents Class

    Uses
    Extends Service
    Defined in: addon/services/objectlistview-events.js:15
    Module: ember-flexberry

    Service for triggering objectlistview events.

    Methods

    addRowTrigger

    (
    • componentName
    )

    Defined in addon/services/objectlistview-events.js:87

    Trigger for "add new row" event in objectlistview. Event name: olvAddRow.

    Parameters:

    • componentName String

      The name of objectlistview component

    clearMultiSelectedRecords

    ()

    Defined in addon/services/objectlistview-events.js:63

    Removes all rows from list of selected rows from component.

    clearSelectedRecords

    (
    • componentName
    )

    Defined in addon/services/objectlistview-events.js:533

    Clears set of previously saved selected records for OLV component with specified name.

    Parameters:

    • componentName String

      The name of OLV component.

    deleteAllRowsTrigger

    (
    • componentName
    • filterQuery
    )

    Defined in addon/services/objectlistview-events.js:125

    Trigger for "delete all rows on all pages" event in objectlistview. Event name: olvDeleteAllRows.

    Parameters:

    • componentName String

      The name of objectlistview component

    • filterQuery Object

      Filter applying before delete all records on all pages

    deleteRowsTrigger

    (
    • componentName
    • immediately
    )

    Defined in addon/services/objectlistview-events.js:112

    Trigger for "delete selected rows" event in objectlistview. Event name: olvDeleteRows.

    Parameters:

    • componentName String

      The name of objectlistview component

    • immediately Boolean

      Flag to delete record immediately

    deleteRowTrigger

    (
    • componentName
    • immediately
    )

    Defined in addon/services/objectlistview-events.js:99

    Trigger for "delete current row" event in objectlistview. Event name: olvDeleteRow.

    Parameters:

    • componentName String

      The name of objectlistview component

    • immediately Boolean

      Flag to delete record immediately

    editRecordDialogHiddenTrigger

    ()

    Defined in addon/services/objectlistview-events.js:548

    Triggers when edit record dialog was created.

    editRecordDialogHiddenTrigger

    ()

    Defined in addon/services/objectlistview-events.js:557

    Triggers when edit record dialog was hidden.

    filterByAnyMatchTrigger

    (
    • componentName
    • pattern
    )

    Defined in addon/services/objectlistview-events.js:158

    Trigger for "filter by any match" event in objectlistview.

    Parameters:

    • componentName String

      The name of objectlistview component

    • pattern String

      The pattern to match attributes values

    filterConditionChangedTrigger

    (
    • componentName
    • filter
    • newValue
    • oldvalue
    )

    Defined in addon/services/objectlistview-events.js:399

    Method to fire the filterConditionChanged event.

    Parameters:

    • componentName String

      The name of the component relative to which the event occurred.

    • filter Object

      Object with the filter description.

    • newValue String

      The new value of the filter condition.

    • oldvalue String

      The old value of the filter condition.

    geSortApplyTrigger

    (
    • componentName
    • sorting
    )

    Defined in addon/services/objectlistview-events.js:342

    Trigger for "geSortApply" event in object-list-view. Event name: geSortApply.

    Parameters:

    • componentName String

      The name of object-list-view component.

    • sorting Array

      Array of sorting definitions.

    getLimitFunction

    (
    • componentName
    )
    BasePredicate

    Defined in addon/services/objectlistview-events.js:449

    Gets current limit function for OLV.

    Parameters:

    • componentName String

      Component name.

    Returns:

    BasePredicate:

    Current limit function.

    getMultiSelectedRecords

    ()

    Defined in addon/services/objectlistview-events.js:54

    Returns a list of selected rows from component.

    getOlvFilterColumnsArray

    (
    • componentName
    )
    Object[]

    Defined in addon/services/objectlistview-events.js:471

    Returns the set of columns with filters saved for the flexberry-objectlistview component.

    Parameters:

    • componentName String

      The name of the component for which you want to get filters.

    Returns:

    Object[]:

    The set of columns with filters.

    getSelectedRecords

    (
    • componentName
    )
    Ember.Map

    Defined in addon/services/objectlistview-events.js:521

    Returns map with previously saved selected records for OLV component with specified name.

    Parameters:

    • componentName String

      The name of OLV component.

    Returns:

    Ember.Map:

    Selected records for OLV component.

    holdMultiSelectedRecords

    ()

    Defined in addon/services/objectlistview-events.js:72

    Remembers all selected rows to keep them when page is changing.

    init

    ()

    Defined in addon/services/objectlistview-events.js:43

    Init service.

    moveRowTrigger

    (
    • componentName
    • shift
    )

    Defined in addon/services/objectlistview-events.js:386

    Trigger for "moveRowTrigger" event in objectlistview. Event name: moveRow.

    Parameters:

    • componentName String

      The name of objectlistview component

    • shift Integer

      Shift for rows

    refreshListOnlyTrigger

    (
    • componentName
    )

    Defined in addon/services/objectlistview-events.js:148

    Trigger for "refresh list" event in OLV component by name.

    Parameters:

    • componentName String

      The name of OLV component.

    refreshListTrigger

    (
    • componentName
    )

    Defined in addon/services/objectlistview-events.js:138

    Trigger for "refresh list" event in OLV component.

    Parameters:

    • componentName String

      The name of OLV component.

    resetFiltersTrigger

    (
    • componentName
    )

    Defined in addon/services/objectlistview-events.js:291

    Trigger for "reset filters" event in simpleolv. Event name: resetFilters.

    Parameters:

    • componentName String

      The name of simpleolv component.

    restoreSelectedRecords

    ()

    Defined in addon/services/objectlistview-events.js:261

    Creates records with all remembered multiselected rows.

    rowAddedTrigger

    (
    • componentName
    • record
    )

    Defined in addon/services/objectlistview-events.js:179

    Trigger for "new row has been added" event in objectlistview. Event name: olvRowAdded.

    Parameters:

    • componentName String

      The name of objectlistview component

    • record DS.Model

      The model corresponding to added row in objectlistview

    rowDeletedTrigger

    (
    • componentName
    • record
    • immediately
    )

    Defined in addon/services/objectlistview-events.js:192

    Trigger for "row has been deleted" event in objectlistview. Event name: olvRowDeleted.

    Parameters:

    • componentName String

      The name of objectlistview component

    • record DS.Model

      The model corresponding to deleted row in objectlistview

    • immediately Boolean

      Flag to show if record was deleted immediately

    rowDeletedTrigger

    (
    • componentName
    • count
    • immediately
    )

    Defined in addon/services/objectlistview-events.js:206

    Trigger for "selected rows has been deleted" event in objectlistview. Event name: groupEditRowDeleted.

    Parameters:

    • componentName String

      The name of objectlistview component

    • count Number

      Count of deleted rows in objectlistview

    • immediately Boolean

      Flag to show if records were deleted immediately

    rowsChangedTrigger

    (
    • componentName
    )

    Defined in addon/services/objectlistview-events.js:279

    Trigger for "model(s) corresponding to some row(s) was changed" event in objectlistview. Event name: olvRowsChanged.

    Parameters:

    • componentName String

      The name of objectlistview component

    rowSelectedTrigger

    (
    • componentName
    • record
    • count
    • checked
    • recordWithKey
    )

    Defined in addon/services/objectlistview-events.js:220

    Trigger for "row has been selected" event in objectlistview. Event name: olvRowSelected.

    Parameters:

    • componentName String

      The name of objectlistview component

    • record DS.Model

      The model corresponding to selected row in objectlistview

    • count Number

      Count of selected rows in objectlistview

    • checked Boolean

      Current state of row in objectlistview (checked or not)

    • recordWithKey Object

      The model wrapper with additional key corresponding to selected row

    setDefaultGeSortTrigger

    (
    • colDescs
    )

    Defined in addon/services/objectlistview-events.js:331

    Trigger for "setDefaultGeSort" event in route. Event name: setDefaultGeSort.

    Parameters:

    • colDescs Array

      Array column descriptions.

    setGeSortTrigger

    (
    • componentName
    • sorting
    • colDescs
    )

    Defined in addon/services/objectlistview-events.js:316

    Trigger for "setGeSort" event in route. Event name: setGeSort.

    Parameters:

    • componentName String

      The name of object-list-view component.

    • sorting Array

      Array of sorting definitions.

    • colDescs Array

      Array column descriptions.

    setLimitFunction

    (
    • limitFunction
    • componentName
    )

    Defined in addon/services/objectlistview-events.js:437

    Sets current limit function for OLV.

    Parameters:

    • limitFunction BasePredicate

      Current limit function.

    • componentName String

      Component name.

    setLoadingState

    (
    • loadingState
    )

    Defined in addon/services/objectlistview-events.js:482

    Method that sets the form's loading state. This method is deprecated, use app state service.

    Parameters:

    • loadingState String

      Loading state for set.

    setOlvFilterColumnsArray

    (
    • componentName
    • columns
    )

    Defined in addon/services/objectlistview-events.js:460

    Saves the set of columns with filters for the flexberry-objectlistview component.

    Parameters:

    • componentName String

      The name of the component for which you want to save filters.

    • columns Object[]

      The set of columns with filters.

    setSortingTrigger

    (
    • componentName
    • sorting
    )

    Defined in addon/services/objectlistview-events.js:303

    Trigger for "setSorting" event in route. Event name: setSorting.

    Parameters:

    • componentName String

      The name of object-list-view component.

    • sorting Array

      Array of sorting definitions.

    updateSelectAll

    (
    • componentName
    • selectAllParameter
    • skipConfugureRows
    )

    Defined in addon/services/objectlistview-events.js:368

    Trigger for "selectAll" event in object-list-view. Event name: updateSelectAll.

    Parameters:

    • componentName String

      The name of object-list-view component

    • selectAllParameter Boolean

      Flag to specify if all records should be selected or unselected.

    • skipConfugureRows Boolean

      Flag to specify if configuring rows needs to be skipped.

    updateWidthTrigger

    (
    • componentName
    )

    Defined in addon/services/objectlistview-events.js:355

    Trigger for "updateWidth" event in object-list-view. Event name: updateWidth.

    Parameters:

    • componentName String

      The name of object-list-view component (can be undefined for update all components widths).

    Properties

    _multiRows

    Array

    Defined in addon/services/objectlistview-events.js:170

    Set of rows for multiselect function in groupedit.

    Default: null

    _olvFilterColumnsArray

    Object private

    Defined in addon/services/objectlistview-events.js:34

    Current model projection columns with available filters.

    _selectedRecords

    Array private

    Defined in addon/services/objectlistview-events.js:25

    Current set of selected records for all list components.

    appState

    AppStateService

    Defined in addon/services/objectlistview-events.js:429

    Service for managing the state of the application.

    currentLimitFunctions

    Object

    Defined in addon/services/objectlistview-events.js:412

    Current limit functions for OLV by componentNames.

    Default: {}

    loadingState

    String

    Defined in addon/services/objectlistview-events.js:421

    Form's loading state.