Flexberry Documentation Flexberry Documentation

  • API Docs for Version: develop

    • APIs

    Show:

    FlexberryObjectlistviewComponent Class

    Extends FlexberryBaseComponent
    Defined in: addon/components/olv-pagination.js:3
    Module: ember-flexberry

    Component to pagination of object list view.

    Item Index

    Methods

    Properties

    Methods

    _clearSelectedRecords

    () private

    Defined in addon/components/flexberry-objectlistview.js:1739

    Clear selected records on all pages. This method should be removed when we will ask user about actions with selected records.

    _conjuctPredicates

    (
    • limitPredicate
    • autocompletePredicate
    • lookupAdditionalLimitFunction
    )
    BasePredicate

    Defined in addon/components/flexberry-multiple-lookup.js:199

    Concatenates predicates.

    Parameters:

    • limitPredicate BasePredicate

      The first predicate to concatenate.

    • autocompletePredicate BasePredicate

      The second predicate to concatenate.

    • lookupAdditionalLimitFunction Function

      Function return BasePredicate to concatenate.

    Returns:

    BasePredicate:

    Concatenation of two predicates.

    _createQueryBuilder

    (
    • store
    • modelName
    • projection
    • order
    )
    Builder

    Defined in addon/components/flexberry-multiple-lookup.js:172

    Creates an instance of the Builder class with selection and sorting specified in the component parameters.

    Parameters:

    Returns:

    Builder:

    _getRowByKey

    () private

    Defined in addon/components/flexberry-objectlistview.js:1683

    Get the row by key.

    _setActiveRow

    (
    • row
    )
    private

    Defined in addon/components/flexberry-objectlistview.js:1701

    Set the active row.

    Parameters:

    • row Object

      Table row, which must become active.

    _valueChanged

    () private

    Defined in addon/components/olv-filter-interval.js:89

    It observes changes in from, to, value.

    actions.addColumnToSorting

    (
    • column
    )
    public

    Defined in addon/components/flexberry-objectlistview.js:1150

    Handles action from object-list-view when no handler for this component is defined.

    Parameters:

    • column Object

      Column to add sorting by

    actions.applyFilters

    (
    • filters
    )

    Defined in addon/components/flexberry-objectlistview.js:1334

    Dummy action handlers, overloaded in LimitedController.

    Parameters:

    actions.availableHierarchicalMode

    (
    • hierarchicalAttribute
    )

    Defined in addon/components/flexberry-objectlistview.js:1375

    Set availability hierarchical mode, and save the attribute name in controller.

    Parameters:

    • hierarchicalAttribute String

      Attribute name to hierarchy building.

    actions.createNewByPrototype

    (
    • prototypeId
    )
    public

    Defined in addon/components/flexberry-objectlistview.js:1296

    This action is called when user click on menu in row.

    Parameters:

    • prototypeId String | Number

      The prototype record ID in row.

    actions.customButtonAction

    (
    • actionName
    )
    public

    Defined in addon/components/flexberry-objectlistview.js:1266

    Handler to get user button's actions and send action to corresponding controllers's handler.

    Parameters:

    • actionName String

      The name of action

    actions.customButtonInRowAction

    (
    • actionName
    • model
    )

    Defined in addon/components/flexberry-objectlistview.js:1281

    Handler to get user button's in rows actions and send action to corresponding controllers's handler.

    Parameters:

    actions.filterByAnyMatch

    (
    • The
    )

    Defined in addon/components/flexberry-objectlistview.js:1362

    Handles action from object-list-view when no handler for this component is defined.

    Parameters:

    • The String

      pattern to filter objects

    actions.gotoPage

    (
    • action
    • pageNumber
    )
    public

    Defined in addon/components/flexberry-objectlistview.js:1244

    Handles action from object-list-view when no handler for this component is defined.

    Parameters:

    • action Action

      Action go to page.

    • pageNumber Number

      Number of page to go to.

    actions.loadRecords

    (
    • Primary
    • Instance
    • Property
    • Flag
    )

    Defined in addon/components/flexberry-objectlistview.js:1404

    Redirects the call to controller.

    Parameters:

    actions.nextPage

    (
    • action
    )
    public

    Defined in addon/components/flexberry-objectlistview.js:1223

    Handles action from object-list-view when no handler for this component is defined.

    Parameters:

    • action Action

      Action next page.

    actions.objectListViewRowClick

    (
    • record
    • options
    )
    public

    Defined in addon/components/flexberry-objectlistview.js:1164

    Handles action from row click (action is handled at route so it can't be closure action now).

    Parameters:

    • record Object

      Clicked record.

    • options Object

      Different parameters to handle action.

    actions.perPageClick

    (
    • perPageValue
    )

    Defined in addon/components/flexberry-objectlistview.js:1417

    Called when click on perPage.

    Parameters:

    • perPageValue String

      Selected perPage value.

    actions.previousPage

    (
    • action
    )
    public

    Defined in addon/components/flexberry-objectlistview.js:1202

    Handles action from object-list-view when no handler for this component is defined.

    Parameters:

    • action Action

      Action previous page.

    actions.resetFilters

    (
    • action
    )

    Defined in addon/components/flexberry-objectlistview.js:1347

    Dummy action handlers, overloaded in LimitedController.

    Parameters:

    • action Action

      Action reset filters.

    actions.searchPageButtonAction

    (
    • action
    )

    Defined in addon/components/flexberry-objectlistview.js:1441

    Action search and open page.

    Parameters:

    • action Function

      The goToPage action from controller.

    actions.sendMenuItemAction

    (
    • actionName
    • record
    )

    Defined in addon/components/flexberry-objectlistview.js:1430

    Send action with actionName into controller.

    Parameters:

    actions.sortByColumn

    (
    • column
    )
    public

    Defined in addon/components/flexberry-objectlistview.js:1136

    Handles action from object-list-view when no handler for this component is defined.

    Parameters:

    • column Object

      Column to sort by

    actions.switchExpandMode

    ()

    Defined in addon/components/flexberry-objectlistview.js:1395

    Called controller action to switch in collapse/expand mode.

    actions.switchHierarchicalMode

    ()

    Defined in addon/components/flexberry-objectlistview.js:1386

    Called controller action to switch in hierarchical mode.

    actions.toggleStateFilters

    ()

    Defined in addon/components/flexberry-objectlistview.js:1325

    Show/hide filters.

    beforeDeleteAllRecords

    (
    • modelName
    • data
    )

    Defined in addon/components/flexberry-objectlistview.js:1569

    Hook that executes before deleting all records on all pages.

    Parameters:

    • modelName String

      Model name for deleting records.

    • data Object

      Metadata.

      • [cancel=false] Boolean optional

        Flag for canceling deletion.

      • [filterQuery] Object optional

        Filter applying before delete all records on all pages.

    Example:

    <!-- app/templates/employees.hbs -->
                    {{flexberry-objectlistview
                      ...
                      beforeDeleteAllRecords=(action 'beforeDeleteAllRecords')
                      ...
                    }}
                    
    // app/controllers/employees.js
                    import ListFormController from './list-form';
                    
                    export default ListFormController.extend({
                      actions: {
                        beforeDeleteAllRecords(modelName, data) {
                          if (modelName === 'application-user') {
                            data.cancel = true;
                          }
                        }
                      }
                    });

    beforeDeleteRecord

    (
    • record
    • data
    )

    Defined in addon/components/flexberry-objectlistview.js:1533

    Hook that executes before deleting the record.

    Parameters:

    • record DS.Model

      Deleting record.

    • data Object

      Metadata.

      • [cancel=false] Boolean optional

        Flag for canceling deletion.

      • [immediately] Boolean optional

        See ObjectListView/immediateDelete:property property for details.

    Example:

    <!-- app/templates/employees.hbs -->
                    {{flexberry-objectlistview
                      ...
                      beforeDeleteRecord=(action 'beforeDeleteRecord')
                      ...
                    }}
                    
    // app/controllers/employees.js
                    import ListFormController from './list-form';
                    
                    export default ListFormController.extend({
                      actions: {
                        beforeDeleteRecord(record, data) {
                          if (record.get('myProperty')) {
                            data.cancel = true;
                          }
                        }
                      }
                    });

    configurateTag

    (
    • tagConfig
    • record
    )

    Defined in addon/components/flexberry-multiple-lookup.js:97

    Hook for configurate tag.

    Parameters:

    • tagConfig Object

      Settings for tag.

    • record DS.Model

      The record in tag.

    Example:

    <!-- app/templates/employees.hbs -->
                    {{flexberry-multiple-lookup
                      ...
                      configurateTag=(action "configurateTag")
                      ...
                    }}
                    
    // app/controllers/employees.js
                    import ListFormController from './list-form';
                    
                    export default ListFormController.extend({
                      actions: {
                        configurateTag(tagConfig, record) {
                          set(tagConfig, 'canBeDeleted', false);
                          if (record === this.get('myFavoriteRecord')) {
                            set(tagConfig, 'canBeSelected', false);
                            set(tagConfig, 'customClass', 'my-fav-record');
                          }
                        }
                      }
                    });

    confirmDeleteRow

    (
    • record
    )
    Boolean | Promise

    Defined in addon/components/flexberry-objectlistview.js:1458

    Hook that can be used to confirm delete row.

    Parameters:

    • record DS.Model

      The record to be deleted.

    Returns:

    Boolean | Promise:

    If true, then delete row, if Promise, then delete row after successful resolve, else cancel.

    Example:

    // app/controllers/example.js
                    ...
                    actions: {
                      ...
                      confirmDeleteRow(record) {
                        return new Promise((resolve, reject) => {
                          this.showConfirmDialg({
                            title: Delete an object with the ID '${record.get('id')}'?,
                            onApprove: resolve,
                            onDeny: reject,
                          });
                        });
                      }
                      ...
                    }
                    ...
                    
    <!-- app/templates/example.hbs -->
                    {{flexberry-objectlistview
                      ...
                      confirmDeleteRow=(action "confirmDeleteRow")
                      ...
                    }}

    confirmDeleteRows

    () Boolean | Promise

    Defined in addon/components/flexberry-objectlistview.js:1496

    Hook that can be used to confirm delete rows.

    Returns:

    Boolean | Promise:

    If true, then delete row, if Promise, then delete row after successful resolve, else cancel.

    Example:

    // app/controllers/example.js
                    ...
                    actions: {
                      ...
                      confirmDeleteRows() {
                        return new Promise((resolve, reject) => {
                          this.showConfirmDialg({
                            title: 'Delete all selected records?',
                            onApprove: resolve,
                            onDeny: reject,
                          });
                        });
                      }
                      ...
                    }
                    ...
                    
    <!-- app/templates/example.hbs -->
                    {{flexberry-objectlistview
                      ...
                      confirmDeleteRows=(action "confirmDeleteRows")
                      ...
                    }}

    didRender

    ()

    Defined in addon/components/flexberry-objectlistview.js:1659

    Called after a component has been rendered, both on initial render and in subsequent rerenders. More info.

    getTargetObjectByCondition.

    (
    • condition
    )
    Null | Component | Controller

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:225

    Returns that 'targetObject' (from 'targetObject's hierarchy) which satisfies a given condition.

    let controller = this.getTargetObjectByCondition((targetObject) => {
                      return targetObject instanceof Controller;
                    });

    Parameters:

    • condition Function

      Callback-function, which will be called for each 'targetObject' in 'targetObject's hierarchy, until callback return true for one of them.

    Returns:

    Null | Component | Controller:

    Target object which satisfies a given condition or null.

    init

    ()

    Defined in addon/components/olv-filter-interval.js:32

    An overridable method called when objects are instantiated. For more information see FlexberryBaseComponent/init:method of FlexberryBaseComponent.

    initProperty

    (
    • options
    )

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:153

    Initializes component's property with recpect to following priority: 1 - template-defined parameters, 2 - applicaion configuration-defined parameters (JSON from ./config/environment by path defined in 'appConfigSettingsPath' property), 3 - component-defined defaults. Note! It is important to be declared as undefined for those component properties, which will be initialized through 'initProperty' call.

    // ./config/environment.js.
                    module.exports = function(environment) {
                      var ENV = {
                        APP: {
                          components: {
                            myComponent: {
                              myComponentProperty: 'myComponentProperty config-defined default value',
                            }
                          }
                        }
                      };
                      return ENV;
                    };
                    
    // /components/my-component.js
                    import FlexberryBaseComponent from 'ember-flexberry/flexberry-base-component';
                    
                    export default FlexberryBaseComponent.extend({
                      appConfigSettingsPath: 'APP.components.myComponent',
                    
                      myComponentProperty: undefined,
                    
                      init() {
                        this._super.apply(this, arguments);
                        this.initProperty({ propertyName: 'myComponentProperty', defaultValue: 'myComponentProperty default value' });
                      }
                    });

    Parameters:

    • options Object

      Method options.

      • propertyName String

        Component's property name.

      • defaultValue

        Component's property default value (from component defined default's).

    Properties

    _availableHierarchicalMode

    Boolean private

    Defined in addon/components/flexberry-objectlistview.js:90

    Flag indicate when available the hierarchical mode.

    Default: false

    _hierarchicalAttribute

    String private

    Defined in addon/components/flexberry-objectlistview.js:100

    Store the attribute name set by hierarchyByAttribute.

    _loadRecords

    String private

    Defined in addon/components/flexberry-objectlistview.js:50

    Store the action name at controller for loading records.

    Default: 'loadRecords'

    _pages

    Ember.Array

    Defined in addon/components/flexberry-objectlistview.js:268

    The passed pages as Ember array.

    _saveHierarchicalAttribute

    String private

    Defined in addon/components/flexberry-objectlistview.js:80

    Store the action name at controller for save the hierarchical attribute name.

    Default: 'saveHierarchicalAttribute'

    _showFilters

    Boolean private

    Defined in addon/components/flexberry-objectlistview.js:31

    Flag used to display filters.

    Default: false

    _switchExpandMode

    String private

    Defined in addon/components/flexberry-objectlistview.js:70

    Store the action name at controller for switch to the collapse/expand mode.

    Default: 'switchExpandMode'

    _switchHierarchicalMode

    String private

    Defined in addon/components/flexberry-objectlistview.js:60

    Store the action name at controller for switch to the hierarchical mode.

    Default: 'switchHierarchicalMode'

    action

    String

    Defined in addon/components/flexberry-objectlistview.js:360

    Primary action for row click.

    Default: 'objectListViewRowClick'

    allowColumnResize

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:325

    Flag: indicates whether allow to resize columns (if true) or not (if false).

    Default: true

    appConfig

    Object

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:88

    Application configuration (JSON from ./config/environment.js).

    Default: null

    appConfigSettings

    Object

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:97

    Component settings object from application configuration (part of JSON from ./config/environment.js). Part of appConfig related to appConfigSettingsPath.

    Default: null

    appConfigSettingsPath

    String

    Inherited from FlexberryBaseComponent but overwritten in addon/components/flexberry-objectlistview.js:241

    Path to component's settings in application configuration (JSON from ./config/environment.js).

    Default: 'APP.components.flexberryObjectlistview'

    availableCollExpandMode

    Boolean private

    Defined in addon/components/flexberry-objectlistview.js:178

    Flag indicate when available the collapse/expand all hierarchies mode.

    Default: false

    bottomPagination

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:278

    Bottom position of pagination.

    Default: true

    buttonClass

    String

    Defined in addon/components/flexberry-objectlistview.js:616

    Classes for buttons.

    cellComponent

    Object

    Defined in addon/components/flexberry-objectlistview.js:397

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

    Sub-properties:

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

    colsConfigButton

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:651

    Flag indicates whether to show colsConfigButton button at toolbar.

    Default: false

    columnsResizeMode

    String

    Defined in addon/components/flexberry-objectlistview.js:833

    It is used to set how the resize method works. Values: 'fit', 'flex', 'overflow'

    Default: 'overflow'

    columnsWidthAutoresize

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:824

    Indicates whether or not autoresize columns for fit the page width.

    Default: false

    componentForFilter

    Function

    Defined in addon/components/flexberry-objectlistview.js:699

    The function (action) to customize the component used in the filters, will be called when the component is initialized.

    The function must return an object with the following properties:

    • name - string with the component name.
    • properties object with the properties of the component, passed to the component via dynamicProperties.

    The function is called with three parameters:

    • type - string with the attribute type.
    • relation - indicates that the attribute is a relation.
    • attribute - object with the attribute description.

    componentForFilterByCondition

    Function

    Defined in addon/components/flexberry-objectlistview.js:716

    The function (action) to customize the component used in the filters, will be called when the component is initialized and each time the condition is changed.

    The function must return an object with the following properties:

    • name - string with the component name.
    • properties object with the properties of the component, passed to the component via dynamicProperties.

    The function is called with three parameters:

    • newCondition - string with the new condition.
    • oldCondition - string with the old condition.
    • type - string with the attribute type.

    componentMode

    String

    Defined in addon/components/flexberry-objectlistview.js:369

    It indicates current component mode. Available values: listform - simple list form and after row selection it has to be opened corresponding edit form; lookupform - component is placed on lookup form and after row selection current lookup form has to be closed.

    Default: 'listform'

    componentName

    String

    Inherited from FlexberryBaseComponent but overwritten in addon/components/flexberry-objectlistview.js:381

    The name of the component. Initially, it was used to store user settings for the component. Now used for different purposes.

    conditionsByType

    Function

    Defined in addon/components/flexberry-objectlistview.js:687

    The function (action) for setting the available filtering conditions, will be called when the component is initialized.

    The function must return a set of valid values for the flexberry-dropdown component and is called with two parameters:

    • type - string with the attribute type.
    • attribute - object with the attribute description.

    content

    DS.ManyArray

    Defined in addon/components/flexberry-objectlistview.js:598

    Content to be displayed (models collection).

    Default: null

    createNewButton

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:624

    Flag indicates whether to show creation button at toolbar.

    Default: false

    currentController

    Controller

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:107

    Current controller.

    Default: null

    currentIntervalRecords

    String

    Defined in addon/components/flexberry-objectlistview.js:852

    Current interval of records.

    customButtons

    Array

    Defined in addon/components/flexberry-objectlistview.js:979

    Array of custom user buttons.

    Example:

    {
                      buttonName: '...', // Button displayed name.
                      buttonAction: '...', // Action that is called from controller on this button click (it has to be registered at component).
                      buttonClasses: '...', // Css classes for button.
                      buttonTitle: '...', // Button title.
                      iconClasses: '', // Css classes for icon. Remember to add the icon class here, and for the button tag, through the buttonClasses property, if necessary.
                      disabled: true, // The state of the button is disabled if true or enabled if false.
                    }

    Example of how to add user buttons:

    1. it has to be defined computed property at corresponding controller (name of property is not fixed).
    import Ember from 'ember';
                    import ListFormController from 'ember-flexberry/controllers/list-form';
                    
                    export default ListFormController.extend({
                      ...
                      customButtonsMethod: computed('i18n.locale', function() {
                        let i18n = this.get('i18n');
                        return [{
                          buttonName: i18n.t('forms.components-examples.flexberry-objectlistview.toolbar-custom-buttons-example.custom-button-name'),
                          buttonAction: 'userButtonActionTest',
                          buttonClasses: 'test-click-button'
                        }];
                      })
                    });
    1. it has to be defined set as 'buttonAction' methods.
    import Ember from 'ember';
                    import ListFormController from 'ember-flexberry/controllers/list-form';
                    
                    export default ListFormController.extend({
                      ...
                      clickCounter: 1,
                      messageForUser: undefined,
                    
                      actions: {
                        userButtonActionTest: function() {
                          let i18n = this.get('i18n');
                          let clickCounter = this.get('clickCounter');
                          this.set('clickCounter', clickCounter + 1);
                          this.set('messageForUser',
                            i18n.t('forms.components-examples.flexberry-objectlistview.toolbar-custom-buttons-example.custom-message').string +
                            ' ' + clickCounter);
                        }
                      }
                    });
    1. defined methods and computed property have to be registered at component.
    {{flexberry-objectlistview
                      ...
                      customButtons=customButtonsMethod
                      userButtonActionTest=(action "userButtonActionTest")
                    }}

    customButtonsInRow

    Array

    Defined in addon/components/flexberry-objectlistview.js:1116

    Array of custom buttons of special structures [{ buttonName: ..., buttonAction: ..., buttonClasses: ... }, {...}, ...].

    Example:

    {
                      buttonName: '...', // Button displayed name.
                      buttonAction: '...', // Action that is called from controller on this button click (it has to be registered at component).
                      buttonClasses: '...', // Css classes for button.
                      buttonIcon: '...', // Button icon
                      buttonTitle: '...' // Button title.
                    }

    customProperties

    Object

    Defined in addon/components/flexberry-objectlistview.js:924

    Set of properties to set for commponent (when it is used on lookup window).

    customTableClass

    String

    Defined in addon/components/flexberry-objectlistview.js:562

    Custom classes for table.

    Default: ''

    customToolbarComponents

    Array

    Defined in addon/components/flexberry-objectlistview.js:1051

    Custom components in the toolbar.

    Example:

    [
                      {
                        name: '...', // Component name.
                        properties: {...} // Component properties.
                      },
                      ...
                    ]

    Example of how to add custom components:

    1. it has to be defined computed property at corresponding controller.
    import Ember from 'ember';
                    import ListFormController from 'ember-flexberry/controllers/list-form';
                    
                    export default ListFormController.extend({
                      ...
                      customToolbarComponents: computed('dropdownValue', function() {
                        return [{
                          name: 'flexberry-dropdown',
                          properties: {
                            items: this.get('dropdownItems'),
                            value: this.get('dropdownValue'),
                            onChange: this.get('onChange').bind(this)
                          }
                        }];
                      })
                    });
    1. in the controller, you must specify the onChange method.
    import Ember from 'ember';
                    import ListFormController from 'ember-flexberry/controllers/list-form';
                    
                    export default ListFormController.extend({
                      ...
                      dropdownValue: null,
                      dropdownItems: null,
                    
                      onChange: function(value) {
                        this.set('dropdownValue', value);
                      },
                    });
    1. the customToolbarComponents property must be specified in the list template.
    {{flexberry-objectlistview
                      ...
                      customToolbarComponents=customToolbarComponents
                    }}

    data-test-component

    String

    Defined in addon/components/flexberry-objectlistview.js:206

    Using ember-test-selectors, creates [data-test-component=flexberry-objectlistview] selector for this component.

    Default: 'flexberry-objectlistview'

    ddlFilterSettings

    Array

    Defined in addon/components/flexberry-objectlistview.js:224

    Settings for filters with a dropdown list of values.

    Example:

    ddlFilterSettings: computed(function () { return [{ modelName: 'ember-flexberry-dummy-suggestion-type', projectionName: 'SuggestionTypeL', propName: 'name', bindingPath: 'type' }] })

    defaultLeftPadding

    Number

    Defined in addon/components/flexberry-objectlistview.js:259

    Default left padding in cells.

    Default: 10

    defaultSortingButton

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:669

    Flag indicates whether to show button fo default sorting set.

    Default: true

    defaultTagConfig

    Object

    Defined in addon/components/flexberry-multiple-lookup.js:85

    Default settings for tags.

    Sub-properties:

    • [canBeDeleted=true] Boolean optional

      The tag can be deleted

    • [canBeSelected=true] Boolean optional

      The tag can be selected

    • [customClass=''] String optional

      Custom css classes for the tag

    deleteButton

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:642

    Flag indicates whether to show delete button at toolbar.

    Default: false

    disableHierarchicalMode

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:250

    Flag used for disable the hierarchical mode.

    Default: false

    dynamicProperties

    Object

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:58

    Component dynamic properties ({ componentPropertyName: value }). Used when component renders dynamically with ember {{component}} helper: {{component 'my-component' value=value dynamicProperties=myConponentProperties}}. In the end of component initialization its properties values will be replaced with values from this object.

    Default: null

    editFormRoute

    String

    Defined in addon/components/flexberry-objectlistview.js:343

    Route for edit form by click row.

    editInModal

    Boolean private

    Defined in addon/components/flexberry-objectlistview.js:487

    Flag indicate when edit form must be open in modal window.

    Default: false

    enableFilters

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:678

    Flag to use filters in OLV component.

    Default: false

    eventsBus

    Evented

    Defined in addon/components/flexberry-objectlistview.js:950

    Interface for communication between object-list-view and flexberry-objectlistview.

    exportExcelButton

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:660

    Flag indicates whether to show exportExcelButton button at toolbar.

    Default: false

    filterButton

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:733

    Flag indicates whether to show filter button at toolbar.

    Default: false

    filterByAllWords

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:760

    If this option is enabled, search query will be split by words, search will be on lines that contain each of search query word.

    Default: false

    filterByAnyWord

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:751

    If this option is enabled, search query will be split by words, search will be on lines that contain any word of search query.

    Default: false

    filterProjectionName

    String

    Defined in addon/components/flexberry-objectlistview.js:769

    Name of model projection which should be used for filtering throught search-element on toolbar. Filtering is processed only by properties defined in this projection.

    Default: undefined

    filterText

    String

    Defined in addon/components/flexberry-objectlistview.js:742

    Used to specify 'filter by any match' field value.

    Default: null

    fixedHeader

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:334

    Flag indicates whether to fix the table head (if true) or not (if false).

    Default: false

    formLoadTimeTracker

    FormLoadTimeTrackerService private

    Defined in addon/components/flexberry-objectlistview.js:41

    Link on .

    hasNextPage

    Function

    Defined in addon/components/flexberry-objectlistview.js:907

    Function to determine if current page has next page.

    Default: null

    hasPreviousPage

    Function

    Defined in addon/components/flexberry-objectlistview.js:898

    Function to determine if current page has previous page.

    Default: null

    hierarchicalIndent

    Number

    Defined in addon/components/flexberry-objectlistview.js:188

    Indent in pixels to indicate hierarchy.

    hierarchyAttribute

    String

    Defined in addon/components/flexberry-objectlistview.js:127

    Set the attribute name to hierarchy build.

    hierarchyByAttribute

    String

    Defined in addon/components/flexberry-objectlistview.js:109

    Set the attribute name to hierarchy build. If specified, will attempt to build on this attribute hierarchy.

    hierarchyPaging

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:167

    Flag indicate when component in hierarchycal mode has paging.

    Default: false

    inExpandMode

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:156

    Flag indicate when component is in the collapse/expand mode.

    Default: false

    inHierarchicalMode

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:145

    Flag indicate when component is in the hierarchical mode.

    Default: false

    isParentRecordPropertyName

    String

    Defined in addon/components/flexberry-objectlistview.js:135

    The name of a property in the model that determines whether any record is the parent of other records. If a property value with this name is defined (not undefined), the button to display child records will be shown immediately, and the records will be loaded only when the button is clicked.

    Default: 'isParentRecord'

    lookupComponentName

    String

    Defined in addon/components/flexberry-objectlistview.js:389

    The name of the flexberry-lookup component for which the flexberry-objectlistview component is used.

    menuInRowAdditionalItems

    Array

    Defined in addon/components/flexberry-objectlistview.js:496

    Additional menu items for dropdown menu in last column of every row.

    Default: null

    Example:

    // app/controllers/exapmle.js
                    ...
                    menuItems: [{
                      icon: 'spy icon',
                      title: 'Recruit it',
                      actionName: 'recruit',
                    }],
                    ...
                    actions: {
                      ...
                      recruit(record) {
                        record.set('isSpy', true);
                      },
                      ...
                    },
                    ...

    Note: For every action in component you need to pass an additional parameter in the form of actionName="actionName".

    // app/templates/example.hbs
                    ...
                    {{flexberry-groupedit
                      ...
                      menuInRowAdditionalItems=menuItems
                      recruit="recruit"
                      ...
                    }}
                    ...

    For in-row menu following properties are used:

    • {{#crossLink "FlexberryGroupeditComponent/showEditMenuItemInRow:property"}}{{/crossLink}},
    • {{#crossLink "FlexberryGroupeditComponent/showPrototypeMenuItemInRow:property"}}{{/crossLink}},
    • {{#crossLink "FlexberryGroupeditComponent/showDeleteMenuItemInRow:property"}}{{/crossLink}},
    • {{#crossLink "FlexberryGroupeditComponent/menuInRowAdditionalItems:property"}}{{/crossLink}}.

    minAutoColumnWidth

    Number

    Defined in addon/components/flexberry-objectlistview.js:815

    Minimum column width, if width isn't defined in userSettings.

    Default: 150

    modelName

    String

    Defined in addon/components/flexberry-objectlistview.js:607

    Model's name. Used by toolbar.

    Default: null

    modelProjection

    Object

    Defined in addon/components/flexberry-objectlistview.js:589

    Model projection which should be used to display given content.

    Default: null

    objectlistviewEventsService

    Service

    Defined in addon/components/flexberry-objectlistview.js:958

    Service that triggers objectlistview events.

    onEditForm

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:351

    Flag indicates whether component on edit form (for FOLV).

    Default: false

    orderable

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:571

    Flag indicates whether ordering by clicking on column headers is allowed.

    Default: false

    overflowedComponents

    Array

    Defined in addon/components/flexberry-objectlistview.js:843

    List of component names, which can overflow table cell.

    Default: A(['flexberry-dropdown', 'flexberry-lookup'])

    pages

    DS.ManyArray

    Defined in addon/components/flexberry-objectlistview.js:779

    Array of pages to show.

    Default: null

    perPageValue

    Number

    Defined in addon/components/flexberry-objectlistview.js:788

    Current number of records to show per page.

    Default: null

    perPageValues

    DS.ManyArray

    Defined in addon/components/flexberry-objectlistview.js:797

    Array of numbers of records to show on one page.

    Default: null

    placeholder

    String

    Defined in addon/components/flexberry-objectlistview.js:316

    Text to be displayed in table body, if content is not defined or empty.

    Default: t('components.flexberry-objectlistview.placeholder')

    readonly

    Boolean

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:20

    Flag: indicates whether component is readonly.

    Default: false

    readonlyAttr

    String | Undefined

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:29

    Readonly HTML attribute following to the readonly query param. According to the W3C standard, returns 'readonly' if readonly is true and undefined otherwise.

    recordsTotalCount

    Number

    Defined in addon/components/flexberry-objectlistview.js:806

    Total count records.

    Default: null

    refreshButton

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:633

    Flag indicates whether to show refresh button at toolbar.

    Default: false

    relatedModel

    DS.Model

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:70

    Model to which current component's value is related.

    Default: null

    removeData

    Object

    Defined in addon/components/flexberry-multiple-lookup.js:276

    Object with lookup properties to send on remove action.

    required

    Boolean

    Inherited from FlexberryBaseComponent: addon/components/flexberry-base-component.js:40

    Flag: indicates whether component is required.

    Default: false

    rowClickable

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:553

    Flag indicates whether table rows are clickable.

    Default: true

    searchPageButtonReadonly

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:295

    Flag used for disabling searchPageButton.

    searchPageValue

    Number

    Defined in addon/components/flexberry-objectlistview.js:287

    Number page for search.

    selectedRecord

    DS.Model

    Defined in addon/components/flexberry-objectlistview.js:916

    Current selected record of list.

    showAsteriskInRow

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:415

    Flag indicates whether to show asterisk icon in first column of every changed row.

    Default: false

    showCheckBoxInRow

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:424

    Flag indicates whether to show checkbox in first column of every row.

    Default: false

    showDeleteButtonInRow

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:433

    Flag indicates whether to show delete button in first column of every row.

    Default: false

    showDeleteMenuItemInRow

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:460

    Flag indicates whether to show dropdown menu with delete menu item, in last column of every row.

    Default: false

    showEditButtonInRow

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:442

    Flag indicates whether to show edit button in first column of every row.

    Default: false

    showEditMenuItemInRow

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:469

    Flag indicates whether to show dropdown menu with edit menu item, in last column of every row.

    Default: false

    showFiltersInModal

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:215

    Flag used to display filters in modal.

    Default: false

    showPrototypeButtonInRow

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:451

    Flag indicates whether to show prototype button in first column of every row.

    Default: false

    showPrototypeMenuItemInRow

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:478

    Flag indicates whether to show dropdown menu with prototype menu item, in last column of every row.

    Default: false

    showShowingEntries

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:889

    Flag indicates whether to show showingEntries.

    Default: true

    showValidationMessages

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:406

    Flag: indicates whether to show validation messages in every row or not.

    Default: false

    sorting

    Object

    Defined in addon/components/flexberry-objectlistview.js:580

    Dictionary with sorting data related to columns.

    Default: null

    store

    Service

    Defined in addon/components/flexberry-objectlistview.js:966

    Ember data store.

    tableStriped

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:544

    Flag indicates whether table are striped.

    Default: true

    useRowByRowLoading

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:932

    Flag indicates whether row by row loading mode on.

    Default: false

    useRowByRowLoadingProgress

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:941

    Flag indicates whether to use bottom row by row loading progress while rows in loading state.

    Default: false

    useSidePageMode

    Boolean

    Defined in addon/components/flexberry-objectlistview.js:196

    The value of the useSidePageMode property for the modal windows used by this component. It can be configured through the configuration file (config/environment.js).

    Default: false