Flexberry Documentation
OlvToolbar Class
addon/components/olv-toolbar.js:20
Item Index
Methods
- _confirmDeleteRows
- _createMenuSubitems
- _rowsDeleted
- _rowSelected
- _updateNamedAdvLimits
- actions.createNew
- actions.customButtonAction
- actions.delete
- actions.filterByAnyMatch
- actions.keyDownFilterAction
- actions.onExportMenuItemClick
- actions.onLimitMenuItemClick
- actions.onMenuItemClick
- actions.refresh
- actions.removeFilter
- actions.showConfigDialog
- actions.showConfigDialog
- actions.showExportDialog
- actions.showFiltersTool
- getTargetObjectByCondition.
- initProperty
- onFailureSpeechRecognition
- onSuccessSpeechRecognition
- showInfoModalDialog
Properties
- _componentNameForModalWindow
- _errorModalDialog
- _infoModalDialogCaption
- _infoModalDialogContent
- advLimit
- advLimitButton
- advLimitItems
- appConfig
- appConfigSettings
- appConfigSettingsPath
- colsConfigButton
- colsConfigMenu
- colsSettingsItems
- componentName
- createNewButton
- currentController
- customButtonAction
- customButtons
- customComponents
- deleteButton
- dynamicProperties
- editFormRoute
- editInModal
- enableCreateNewButton
- enableDeleteButton
- exportExcelButton
- exportExcelItems
- filterButton
- filterByAnyMatchText
- filterText
- inLookup
- isDeleteButtonEnabled
- listNamedExportSettings
- listNamedUserSettings
- lookupComponentName
- menus
- modelController
- namedAdvLimits
- objectlistviewEventsService
- readonly
- readonlyAttr
- refreshButton
- relatedModel
- required
- selectAll
- showFiltersInModal
Methods
_confirmDeleteRows
()
private
Delete rows when it confirmed.
_createMenuSubitems
-
itemsNameList -
icon
Creating menu subitems.
_rowsDeleted
-
componentName -
count
Handler for "Olv rows deleted" event in objectlistview.
Parameters:
-
componentNameStringThe name of objectlistview component
-
countIntegerNumber of deleted records
_rowSelected
-
componentName -
record -
count -
checked -
recordWithKey
Event handler for "row has been selected" event in objectlistview.
Parameters:
-
componentNameStringThe name of objectlistview component
-
recordDS.ModelThe model corresponding to selected row in objectlistview
-
countNumberCount of selected rows in objectlistview
-
checkedBooleanCurrent state of row in objectlistview (checked or not)
-
recordWithKeyObjectThe model wrapper with additional key corresponding to selected row
_updateNamedAdvLimits
-
componentName
Refresh current adv limits list.
Parameters:
-
componentNameStringThe name of objectlistview component
actions.createNew
()
public
Handles action from object-list-view when no handler for this component is defined.
actions.customButtonAction
-
action
Action for custom button.
actions.delete
()
public
Delete selected rows.
actions.filterByAnyMatch
()
public
Filters the content by "Filter by any match" field value.
actions.keyDownFilterAction
()
public
Checks if "Enter" button was pressed. If "Enter" button was pressed then filters the content by "Filter by any match" field value.
actions.onExportMenuItemClick
-
e
Handler click on flexberry-menu.
Parameters:
-
ejQuery.EventjQuery.Event by click on menu item
actions.onLimitMenuItemClick
-
e
Handler click on flexberry-menu of advLimits.
Parameters:
-
ejQuery.EventjQuery.Event by click on menu item
actions.onMenuItemClick
-
e
Handler click on flexberry-menu.
Parameters:
-
ejQuery.EventjQuery.Event by click on menu item
actions.refresh
()
public
Handles action from object-list-view when no handler for this component is defined.
actions.removeFilter
()
public
Remove filter from url.
actions.showConfigDialog
()
public
Action to show confis dialog.
actions.showConfigDialog
()
public
Action to show confis dialog.
actions.showExportDialog
()
public
Action to show export dialog.
actions.showFiltersTool
()
public
Action to show filters tool.
getTargetObjectByCondition.
-
condition
Returns that 'targetObject' (from 'targetObject's hierarchy) which satisfies a given condition.
let controller = this.getTargetObjectByCondition((targetObject) => {
return targetObject instanceof Controller;
});
Parameters:
-
conditionFunctionCallback-function, which will be called for each 'targetObject' in 'targetObject's hierarchy, until callback return true for one of them.
Returns:
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.
// ./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' });
}
});
onFailureSpeechRecognition
-
error
Callback failure speech recognition.
Parameters:
-
errorStringtext error.
onSuccessSpeechRecognition
-
text
Callback success speech recognition.
Parameters:
-
textStringtext.
Properties
_componentNameForModalWindow
String
private
The name of the component for themodal window.
If the flexberry-objectlistview component is used for the flexberry-lookup component, we must pass the name of the flexberry-lookup component to the modal window.
_errorModalDialog
JQueryObject
private
Selected jQuery object, containing HTML of error modal dialog.
Default: null
_infoModalDialogCaption
String
private
Caption to be displayed in info modal dialog. It will be displayed only if some info occurs.
Default: ''
_infoModalDialogContent
String
private
Content to be displayed in info modal dialog. It will be displayed only if some info occurs.
Default: ''
advLimitItems
Unknown
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'
colsConfigMenu
Service
colsSettingsItems
Unknown
currentController
Controller
Current controller.
Default: null
customButtonAction
String
Name of action to send out, action triggered by click on user button.
Default: 'customButtonAction'
customComponents
Array
See FlexberryObjectlistviewComponent/customComponents:property.
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
editInModal
Boolean
private
Flag indicate when edit form must be open in modal window.
Default: false
exportExcelButton
Boolean
Flag indicates whether to show exportExcelButton button at toolbar.
Default: false
exportExcelItems
Unknown
inLookup
Boolean
Indicates that the flexberry-objectlistview component is used for the flexberry-lookup component.
Default: false
isDeleteButtonEnabled
Boolean
Flag shows enable-state of delete button. If there are selected rows button is enabled. Otherwise - not.
Default: false
listNamedExportSettings
Unknown
listNamedUserSettings
Unknown
lookupComponentName
String
The name of the flexberry-lookup component for which the flexberry-objectlistview component is used.
objectlistviewEventsService
Service
Service that triggers objectlistview events.
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.