Flexberry Documentation Flexberry Documentation

  • API Docs for Version: develop

    • APIs

    Show:

    DetailEditFormController Class

    Extends EditFormController
    Defined in: addon/controllers/detail-edit-form.js:9
    Module: ember-flexberry

    Controller for the Detail's Edit Forms. It lets to interact between agregator's and details's forms.

    This class re-exports to the application as /controllers/detail-edit-form. So, you can inherit from ./detail-edit-form, even if file app/controllers/detail-edit-form.js is not presented in the application.

    Example:

    // app/controllers/order.js
import DetailEditFormController from './detail-edit-form';
export default DetailEditFormController.extend({
});

    Item Index

    Methods

    Properties

    Methods

    _destroyHasManyRelationships

    (
    • model
    )
    Promise

    Inherited from EditFormController: addon/controllers/edit-form.js:962

    Destroy (delete and save) all hasMany relationships in the model recursively. This method invokes by delete method.

    Parameters:

    • model DS.Model
      Record with hasMany relationships.

    Returns:

    Promise: A promise that will be resolved to array of destroyed records.

    _getModelWithHasMany

    (
    • model
    )
    Ember.NativeArray

    Inherited from EditFormController: addon/controllers/edit-form.js:939

    Returns an array with the model and all its hasMany relationships, obtained recursively, for each model.

    Parameters:

    Returns:

    Ember.NativeArray: An array with the model and all its hasMany relationships.

    _openModalDialog

    (
    • modelObject
    • editFormRoute
    • isNewRecord
    • useSidePageMode
    )
    private

    Inherited from ErrorableControllerMixin: addon/mixins/edit-in-modal-open.js:57

    Open modal window fo edit record or create new record.

    Parameters:

    • modelObject Object
      record or model controller, when record is created.
    • editFormRoute String
      name of edit record route for modal content.
    • isNewRecord Boolean
      flag indicates when modal record open fo create new record.
    • useSidePageMode Boolean
      Indicates when use side page mode.

    _reloadModalData

    (
    • currentContext
    • options
    )
    private

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:504

    This method refreshes displayed data on lookup modal window. It reloads current lookup modal window in order to show loading image. Then proper request to load data is formed (it considers current page, filter, etc). After the data loading data are displayed on lookup modal window. This method is called during the first data loading and after each change of request parameters (current page, filter, etc) on lookup modal window controller (it is implemented by sending handler on this method to lookup modal window controller).

    Parameters:

    • currentContext String
      Current execution context of this method.
    • options Object
      Parameters to load proper data and to tune modal lookup window outlook.
      • [relatedToType] String optional

        Type of records to load.

      • [projectionName] String optional

        Projection name to load data by.

      • [perPage] String optional

        Number of records to display on page.

      • [page] String optional

        Current page to display on lookup window.

      • [sorting] String optional

        Current sorting.

      • [filter] String optional

        Current filter.

      • [filterCondition] String optional

        Current filter condition.

      • [predicate] String optional

        Current limit predicate.

      • [title] String optional

        Title of modal lookup window.

      • [saveTo] String optional

        Options to save selected lookup value.

      • [currentLookupRow] String optional

        Current lookup value.

      • [customPropertiesData] String optional

        Custom properties of modal lookup window.

      • [componentName] String optional

        Component name of lookup component.

      • [notUseUserSettings] Boolean optional

        Not use user settings in the list component on lookup window.

    _saveHasManyRelationships

    (
    • model
    )
    Promise private

    Inherited from EditFormController: addon/controllers/edit-form.js:904

    Save dirty hasMany relationships in the model recursively. This method invokes by save method.

    Parameters:

    • model DS.Model
      Record with hasMany relationships.

    Returns:

    Promise: A promise that will be resolved to array of saved records.

    actions.addColumnToSorting

    (
    • column
    )

    Inherited from EditFormController: addon/controllers/edit-form.js:395

    Add column into end list sorting.

    Parameters:

    • column Object
      Column for sorting.

    actions.addErrorMessage

    (
    • msg
    )
    public

    Inherited from ErrorableControllerMixin: addon/mixins/errorable-controller.js:25

    Add error message.

    Parameters:

    actions.close

    (
    • skipTransition
    • rollBackModel
    )

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:124

    Handler for button 'Close' click. If return path is determined, an error is thrown because this action should not be triggered. Otherwise base logic is executed.

    Parameters:

    • skipTransition Boolean

      If true, then transition during close form process will be skipped.

    • rollBackModel Boolean

      Flag: indicates whether to set flag to roll back model after route leave (if true) or not (if false).

    actions.delete

    (
    • skipTransition
    )

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:105

    Handler for button 'Delete' click. If return path is determined and current model is saved, record marks as deleted and user is redirected to agregator's form. Otherwise base logic is executed.

    Parameters:

    • skipTransition Boolean

      If true, then transition during close form process will be skipped after delete.

    actions.dismissErrorMessages

    () public

    Inherited from ErrorableControllerMixin: addon/mixins/errorable-controller.js:36

    Dismiss error messages.

    actions.error

    (
    • error
    )

    Inherited from ErrorableControllerMixin: addon/mixins/errorable-controller.js:15

    Save the error.

    Parameters:

    actions.flexberryFileViewImageAction

    (
    • selectedFileOptions
    )
    public

    Inherited from FlexberryFileControllerMixin: addon/mixins/flexberry-file-controller.js:36

    Handles {{#crossLink "FlexberryFileComponent"}}flexberry-file{{/crossLink}} viewImageAction: creates modal dialog with selected file preview.

    Parameters:

    • selectedFileOptions Object
      Information about selected file.
      • [fileSrc] String optional

        File as base64string image data or as URL (to be setted as img tag's 'src' property).

      • [fileName] String optional

        File name to be setted as modal dialog caption.

    actions.groupEditRowClick

    (
    • record
    • [options]
    )

    Inherited from ErrorableControllerMixin: addon/mixins/edit-in-modal-open.js:35

    {{#crossLink "FlexberryGroupeditComponent"}}{{/crossLink}} row click handler. It sets modelNoRollBack to true at current controller, redirects to detail's route, save necessary data to service.

    Parameters:

    • record Ember.Object
      Record related to clicked table row.
    • [options] Object optional
      Record related to clicked table row.
      • saveBeforeRouteLeave Boolean

        Flag: indicates whether to save current model before going to the detail's route.

      • editOnSeparateRoute Boolean

        Flag: indicates whether to edit detail on separate route.

      • modelName String

        Clicked detail model name (used to create record if record is undefined).

      • detailArray Array

        Current detail array (used to add record to if record is undefined).

      • editFormRoute Boolean

        Path to detail's form.

    actions.previewLookupValue

    (
    • previewData
    )

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:401

    Handlers action from FlexberryLookup preview action.

    Parameters:

    • previewData Object
      Lookup parameters: { recordId, transitionRoute, transitionOptions, showInSeparateRoute, projection, modelName, controller }.

    actions.removeLookupValue

    (
    • removeData
    )

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:377

    Handlers action from FlexberryLookup remove action.

    Parameters:

    • removeData Object
      Lookup parameters: { relationName, modelToLookup }.

    actions.routeWillTransition

    () public

    Inherited from FlexberryLookupMixin but overwritten in addon/mixins/flexberry-file-controller.js:73

    Handles corresponding route's willTransition action. It sends message about transition to modal dialog's controller.

    actions.save

    ()

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:80

    Handler for button 'Save' click. If return path is determined, no rollback happens and user is redirected to agregator's form. Otherwise base logic is executed.

    actions.saveAndClose

    (
    • skipTransition
    )

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:91

    Handler for button 'Save and close' click. If return path is determined, no rollback happens and user is redirected to agregator's form. Otherwise base logic is executed.

    Parameters:

    • skipTransition Boolean

      If true, then transition during close form process will be skipped after save.

    actions.showLookupDialog

    (
    • chooseData
    )

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:123

    Handles action from lookup choose action. It opens modal window where availible values are shown. In order to customize content of all lookup modal window there is such a way: 1. Create template with necessary content and set unique name for it (for example 'customlookupform.hbs'); 2. Override lookup setting lookupSettings.contentTemplate on controller level (for example 'customlookupform'); 3. If there has to be specific logic or properties on controller for template, current lookup controller can be overriden (it is 'lookup-dialog' for edit forms), new name can be set on lookup setting lookupSettings.controllerName and new controller can be injected as lookupController (if the controller was extended and not reopened).

    Parameters:

    • chooseData Object
      Lookup parameters (projection name, relation name, etc).

    actions.sortByColumn

    (
    • column
    )

    Inherited from EditFormController: addon/controllers/edit-form.js:385

    Sorting list by column.

    Parameters:

    • column Object
      Column for sorting.

    actions.updateLookupValue

    (
    • updateData
    )

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:478

    Update relation value at model.

    Parameters:

    • updateData Object
      Lookup parameters to update data at model: { relationName, newRelationValue, modelToLookup }.

    close

    (
    • skipTransition
    • rollBackModel
    )

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:138

    Сlose edit form and transition to parent route.

    Parameters:

    • skipTransition Boolean

      If true, then transition during close form process will be skipped.

    • rollBackModel Boolean

      Flag: indicates whether to set flag to roll back model after route leave (if true) or not (if false).

    closeModalDialog

    ()

    Defined in addon/controllers/advlimit-dialog.js:46

    Close current modal window if it exists.

    closeModalDialog

    ()

    Defined in addon/controllers/colsconfig-dialog.js:31

    Close current modal window if it exists.

    createdModalDialog

    (
    • modalDialog
    )

    Defined in addon/controllers/advlimit-dialog.js:34

    Handles create modal window action. It saves created window to have opportunity to close it later.

    Parameters:

    • modalDialog JQuery

      Created modal window.

    createdModalDialog

    (
    • modalDialog
    )

    Defined in addon/controllers/colsconfig-dialog.js:18

    Handles create modal window action. It saves created window to have opportunity to close it later.

    Parameters:

    • modalDialog JQuery

      Created modal window.

    delete

    (
    • skipTransition
    )
    Promise

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:187

    Delete object, if successful transition to parent route.

    Parameters:

    • skipTransition Boolean

      If true, then transition during close form process will be skipped after delete.

    Returns:

    Promise:

    getCellComponent

    (
    • attr
    • bindingPath
    • modelClass
    )
    Object

    Inherited from EditFormController: addon/controllers/edit-form.js:798

    Method to get type and attributes of component, which will be embeded in object-list-view cell.

    Parameters:

    • attr Object
      Attribute of projection property related to current table cell.
    • bindingPath String
      Path to model property related to current table cell.
    • modelClass DS.Model
      Model class of data record related to current table row.

    Returns:

    Object: Object containing name & properties of component, which will be used to render current table cell ({ componentName: 'my-component', componentProperties: { ... } }).

    onDeleteActionFulfilled.

    (
    • skipTransition
    )

    Inherited from EditFormController: addon/controllers/edit-form.js:706

    This method will be invoked when delete operation successfully completed. Override this method to add some custom logic on delete operation success.

    Parameters:

    • skipTransition Boolean
      If true, then transition during close form process (default behavior) will be skipped.

    Example:

    onDeleteActionFulfilled() {
                      alert('Delete operation succeed!');
                      this.close(false);
                    }

    onDeleteActionRejected.

    (
    • errorData
    )

    Inherited from EditFormController: addon/controllers/edit-form.js:724

    This method will be invoked when delete operation completed, but failed. Override this method to add some custom logic on delete operation fail.

    Parameters:

    • errorData Object
      Data about delete operation fail.

    Example:

    onDeleteActionRejected() {
                      alert('Delete operation failed!');
                    }

    onDeleteActionStarted.

    ()

    Inherited from EditFormController but overwritten in addon/controllers/edit-form.js:691

    This method will be invoked before delete operation will be called. Override this method to add custom logic on delete operation start.

    Example:

    onDeleteActionStarted() {
                      alert('Delete operation started!');
                    }

    onSaveActionAlways.

    (
    • data
    )

    Inherited from EditFormController but overwritten in addon/controllers/edit-form.js:671

    This method will be invoked always when save operation completed, regardless of save promise's state (was it fulfilled or rejected). Override this method to add some custom logic on save operation completion.

    Parameters:

    • data Object
      Data about completed save operation.

    Example:

    onSaveActionAlways(data) {
                      alert('Save operation completed!');
                    }

    onSaveActionFulfilled.

    ()

    Inherited from EditFormController: addon/controllers/edit-form.js:636

    This method will be invoked when save operation successfully completed. Override this method to add some custom logic on save operation success.

    Example:

    onSaveActionFulfilled() {
                      alert('Save operation succeed!');
                    }

    onSaveActionRejected.

    (
    • errorData
    )

    Inherited from EditFormController: addon/controllers/edit-form.js:651

    This method will be invoked when save operation completed, but failed. Override this method to add some custom logic on save operation fail.

    Parameters:

    • errorData Object
      Data about save operation fail.

    Example:

    onSaveActionRejected() {
                      alert('Save operation failed!');
                    }

    onSaveActionStarted.

    ()

    Inherited from EditFormController: addon/controllers/edit-form.js:621

    This method will be invoked before save operation will be called. Override this method to add some custom logic on save operation start.

    Example:

    onSaveActionStarted() {
                      alert('Save operation started!');
                    }

    openCreateModalDialog

    (
    • modelController
    • editFormRoute
    • useSidePageMode
    )

    Inherited from ErrorableControllerMixin: addon/mixins/edit-in-modal-open.js:137

    Open create record in modal window.

    Parameters:

    • modelController Object
      parent model controller.
    • editFormRoute String
      name of edit record route for modal content.
    • useSidePageMode Boolean
      Indicates when use side page mode.

    openEditModalDialog

    (
    • record
    • editFormRoute
    • useSidePageMode
    )

    Inherited from ErrorableControllerMixin: addon/mixins/edit-in-modal-open.js:124

    Open edit record in modal window.

    Parameters:

    • record Object
      Record.
    • editFormRoute String
      name of edit record route for modal content.
    • useSidePageMode Boolean
      Indicates when use side page mode.

    rejectError

    (
    • errorData
    • message
    )
    public

    Inherited from ErrorableControllerMixin: addon/mixins/errorable-controller.js:56

    Reject Error.

    Parameters:

    rollbackAll

    ()

    Inherited from EditFormController: addon/controllers/edit-form.js:886

    Rollback current model.

    rollbackHasManyRelationships

    (
    • model
    )
    deprecated

    Inherited from EditFormController: addon/controllers/edit-form.js:873

    Deprecated: Use `rollbackHasMany` from model.

    Rollback dirty hasMany relationships in the model recursively. This method invokes by resetController in the edit-form route.

    Parameters:

    • model DS.Model
      Record with hasMany relationships.

    save

    (
    • close
    • skipTransition
    )
    Promise

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:172

    Save object.

    Parameters:

    • close Boolean

      If true, then save and close.

    • skipTransition Boolean

      If true, then transition after save process will be skipped.

    Returns:

    Promise:

    saveModel

    () Promise

    Inherited from EditFormController: addon/controllers/edit-form.js:525

    The default save model logic implementation.

    Returns:

    Promise:

    transitionToParentRoute

    (
    • skipTransition
    • rollBackModel
    )

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:201

    Method to transit to parent's route (previous route). If modelAgregatorRoute is set, transition to defined path and set flag 'modelNoRollBack' to true on controller to prevent rollback of model. Then if parentRoute is set, transition to defined path. Otherwise transition to corresponding list.

    Parameters:

    • skipTransition Boolean

      If true, then transition will be skipped.

    • rollBackModel Boolean

      Flag: indicates whether to set flag to roll back model after route leave (if true) or not (if false).

    validate

    () RSVP.Promise

    Inherited from EditFormController: addon/controllers/edit-form.js:423

    Runs validation on {{#crossLink "EditFormController/validationObject:property"}}{{/crossLink}} and returns promise. Promise resolved if validation successful or rejected if validation failed. Promise always settled with [ResultCollection](http://offirgolan.github.io/ember-cp-validations/docs/classes/ResultCollection.html) object.

    Returns:

    RSVP.Promise:

    Properties

    _EmberCpValidationsResultCollectionClass

    Unknown private

    Inherited from EditFormController: addon/controllers/edit-form.js:70

    _hasParentRoute

    Boolean private

    Defined in addon/controllers/detail-edit-form.js:28

    A logic value showing if current route has parent one.

    _modalControllerName

    String private

    Inherited from ErrorableControllerMixin: addon/mixins/edit-in-modal-open.js:14

    Name of using modal controller

    Default: 'editrecord-dialog'

    _modalTemplateName

    String private

    Inherited from ErrorableControllerMixin: addon/mixins/edit-in-modal-open.js:24

    Name of using modal template

    Default: 'editrecord-dialog'

    _openedModalDialog

    JQuery

    Defined in addon/controllers/advlimit-dialog.js:22

    Current opened modal window.

    Default: undefined

    _openedModalDialog

    JQuery

    Defined in addon/controllers/colsconfig-dialog.js:9

    Current opened modal window.

    Default: undefined

    appState

    AppStateService

    Inherited from EditFormController: addon/controllers/edit-form.js:130

    Service for managing the state of the application.

    contentTemplate

    String

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:51

    Name of template for content of modal window.

    context

    String

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:85

    Modal context param. Selector or jquery object specifying the area to dim.

    Default: '.ember-application > .ember-view'

    controllerName

    String

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:34

    Name of controller that handles modal window. Controller with the same name has to be injected to property lookupController.

    defaultDeveloperUserSettings

    Object

    Inherited from EditFormController: addon/controllers/edit-form.js:212

    Object with default developer user settings.

    Default: undefined

    destroyHasManyRelationshipsOnModelDestroy

    Boolean

    Inherited from EditFormController: addon/controllers/edit-form.js:166

    If true, all details will be deleted along with the main model.

    Default: false

    detachable

    Boolean

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:75

    Modal detachable param. If set to false will prevent the modal from being moved to inside the dimmer.

    Default: false

    developerUserSettings

    Object

    Inherited from EditFormController: addon/controllers/edit-form.js:203

    Object with developer user settings.

    Default: undefined

    flexberryDetailInteractionService

    Service private

    Inherited from EditFormController: addon/controllers/edit-form.js:894

    Service that lets interact between agregator's and detail's form.

    flexberryFileModalController

    Controller

    Inherited from FlexberryFileControllerMixin: addon/mixins/flexberry-file-controller.js:17

    Controller for modal dialog content.

    Default: Injected flexberry-file-view-dialog controller.

    flexberryFileModalTemplateName

    String

    Inherited from FlexberryFileControllerMixin: addon/mixins/flexberry-file-controller.js:26

    Modal dialog content template's name.

    Default: 'flexberry-file-view-dialog'

    loaderTemplate

    String

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:59

    Name of template for content of loading modal window.

    lookupController

    Ember.InjectedProperty

    Inherited from FlexberryLookupMixin but overwritten in addon/controllers/edit-form.js:79

    Controller to show colsconfig modal window.

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

    lookupEventsService

    Service

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:114

    Service that triggers lookup events.

    lookupModalWindowPerPage

    Number

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:105

    Default number of records per page on lookup window list.

    Default: 5

    lookupSettings

    Object

    Inherited from FlexberryLookupMixin but overwritten in addon/controllers/edit-form.js:152

    Object with settings for modal window. Structure object: - **controllerName** - Controller name, default: 'lookup-dialog'. - **template** - Template name modal window, default: 'lookup-dialog'. - **contentTemplate** - Template name that rendering after loading data, default: 'lookup-dialog-content'. - **loaderTemplate** - Template name that will be visible while loading data, default: 'loading'.

    modalDialogSettings

    Object

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:67

    Object with settings for modal window.

    modelCurrentAgregatorPathes

    Array

    Defined in addon/controllers/detail-edit-form.js:53

    Paths to return to after leaving current route.

    modelCurrentAgregators

    Array

    Defined in addon/controllers/detail-edit-form.js:61

    Current detail's agregators.

    modelNoRollBack

    Boolean

    Inherited from EditFormController: addon/controllers/edit-form.js:184

    Flag to cancel rollback of model on controller resetting. Flag is set for interaction of agregator's and detail's routes.

    Default: false

    objectlistviewEvents

    Service

    Inherited from ErrorableControllerMixin: addon/mixins/edit-in-modal-open.js:7

    Service that triggers objectlistview events.

    parentRoute

    String

    Inherited from EditFormController: addon/controllers/edit-form.js:97

    Route name corresponding list form.

    parentRouteRecordId

    String

    Inherited from EditFormController: addon/controllers/edit-form.js:105

    Parent route record ID.

    queryParams

    Array

    Inherited from EditFormController: addon/controllers/edit-form.js:194

    Defines which query parameters the controller accepts. [More info.](https://emberjs.com/api/ember/release/classes/Controller#property_queryParams).

    Default: ['readonly']

    readonly

    Boolean

    Inherited from EditFormController: addon/controllers/edit-form.js:121

    Indicates whether the current form is opened only for reading.

    Default: false

    readonlyAttr

    String | Undefined

    Inherited from EditFormController: addon/controllers/edit-form.js:138

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

    Default: undefined

    returnToAgregatorRoute

    Boolean

    Inherited from EditFormController but overwritten in addon/controllers/detail-edit-form.js:43

    Flag to enable return to agregator's path if possible. It overrides base default value.

    Default: true

    routeName

    String

    Inherited from EditFormController: addon/controllers/edit-form.js:113

    Route name corresponding this edit form.

    saveBeforeRouteLeave

    Boolean

    Defined in addon/controllers/detail-edit-form.js:69

    Flag: indicates whether to save current model before going to the detail's route. This flag is set to true when this form is opened from agregator's form.

    Default: false

    template

    String

    Inherited from FlexberryLookupMixin: addon/mixins/flexberry-lookup-controller.js:43

    Name of template for modal window itself (not content of modal window).

    validationModel

    Any

    Inherited from EditFormController: addon/controllers/edit-form.js:233

    Reference to object to be validated.

    Default: model

    validationObject

    Any

    Inherited from EditFormController: addon/controllers/edit-form.js:221

    Reference to object to be validated.

    Default: model