APIs

Show:

Filters dialog Content component.

Methods

actions.applyFilters

()

Apply filters for current list.

actions.clearFilterField

(
  • filter
)

Cleans the filter for one column.

Parameters:

  • filter Object

    Object with the filter description.

actions.clearFiltersFields

()

Clear filters form.

actions.filterConditionChanged

(
  • filter
  • newCondition
  • oldCondition
)

Called when filter condition in any column was changed by user.

Parameters:

  • filter Object

    Object with the filter description.

  • newCondition String

    The new value of the filter condition.

  • oldCondition String

    The old value of the filter condition.

getTargetObjectByCondition.

(
  • condition
)
Null | Component | Controller
Returns that 'targetObject' (from 'targetObject's hierarchy) which satisfies a given condition. `javascript 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.

initProperty

(
  • options
)
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. `javascript // ./config/environment.js. module.exports = function(environment) { var ENV = { APP: { components: { myComponent: { myComponentProperty: 'myComponentProperty config-defined default value', } } } }; return ENV; }; ` `javascript // /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

appConfig

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

Default: null

appConfigSettings

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

Default: null

appConfigSettingsPath

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

Default: 'APP.components.flexberryBaseComponent'

componentName

String

Unique name of the component.

currentController

Controller
Current controller.

Default: null

dynamicProperties

Object
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

filterColumns

Object[]

Columns with available filters.

objectlistviewEvents

Class

Service that triggers objectlistview events.

Default: Ember.inject.service()

readonly

Boolean
Flag: indicates whether component is readonly.

Default: false

readonlyAttr

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

relatedModel

DS.Model
Model to which current component's value is related.

Default: null

required

Boolean
Flag: indicates whether component is required.

Default: false