Flexberry Documentation Flexberry Documentation

  • API Docs for Version: develop

    • APIs

    Show:

    FlexberryTreeComponent Class

    Uses
    Extends Component
    Defined in: addon/components/flexberry-tree.js:43
    Module: ember-flexberry

    Flexberry tree component with Semantic UI accordion style. Component must be used in combination with flexberry-treenode component, because it's only a wrapper for those tree nodes, which are placed on the same tree level.

    Usage: templates/my-form.hbs

    Methods

    _accordionPropertiesDidChange

    () private

    Defined in addon/components/flexberry-tree.js:293

    Reinitializes Semantic UI accordion on component's wrapping

    when following component's accordion-related properties changed: {{crossLink "FlexberryTreeComponent/exclusive:property"}}'exclusive'{{/crossLink}}, {{crossLink "FlexberryTreeComponent/collapsible:property"}}'collapsible'{{/crossLink}}, {{crossLink "FlexberryTreeComponent/animateChildren:property"}}'animateChildren'{{/crossLink}}, {{crossLink "FlexberryTreeComponent/duration:property"}}'duration'{{/crossLink}}

    _actionHandlerIsDefined

    (
    • options
    )
    Boolean private

    Inherited from RequiredActionsMixin but overwritten in addon/mixins/dynamic-actions.js:119

    Returns flag, indicating whether action handler is defined, for action with the specified name, or not.

    Parameters:

    • options Object
      Method options
      • actionName String

        Name of component's action for which handler's existence this method should check.

    Returns:

    Boolean: Flag, indicating whether action handler is defined, for action with the specified name, or not.

    _addDynamicProperty

    (
    • propertyName
    )
    private

    Inherited from DynamicPropertiesMixin: addon/mixins/dynamic-properties.js:70

    Adds component's new dynamic property. Gets related value from {{#crossLink "DynamicPropertiesMixin:dynamicProperties:property"}}dynamic properties{{/crossLink}}, and assignes it to related component's property, then attaches observer.

    Parameters:

    • propertyName String
      Name of dynamic property that must be added.

    _destroyAccordion

    () private

    Defined in addon/components/flexberry-tree.js:280

    Destroys Semantic UI accordion on component's wrapping

    .

    _dynamicPropertiesDidChange

    () private

    Inherited from DynamicPropertiesMixin: addon/mixins/dynamic-properties.js:205

    Observes & handles any changes in {{#crossLink "DynamicPropertiesMixin/dynamicProperties:property"}}'dynamicProperties'{{/crossLink}}, assigns actual values to a component's related properties (including initialization moment).

    _initializeAccordion

    () private

    Defined in addon/components/flexberry-tree.js:257

    Initializes Semantic UI accordion on component's wrapping

    depending on following component's accordion-related properties: {{crossLink "FlexberryTreeComponent/exclusive:property"}}'exclusive'{{/crossLink}}, {{crossLink "FlexberryTreeComponent/collapsible:property"}}'collapsible'{{/crossLink}}, {{crossLink "FlexberryTreeComponent/animateChildren:property"}}'animateChildren'{{/crossLink}}, {{crossLink "FlexberryTreeComponent/duration:property"}}'duration'{{/crossLink}}

    _removeDynamicProperties

    () private

    Inherited from DynamicPropertiesMixin: addon/mixins/dynamic-properties.js:189

    Removes component's all previously added dynamic properties. Removes related component's properties & observers.

    _removeDynamicProperty

    (
    • propertyName
    )
    private

    Inherited from DynamicPropertiesMixin: addon/mixins/dynamic-properties.js:158

    Removes component's previously added dynamic property. Removes related component's property & observer.

    Parameters:

    • propertyName String
      Name of dynamic property that must be removed.

    attachEventHandler

    (
    • options
    )

    Inherited from DomActionsMixin: addon/mixins/dom-actions.js:104

    Attaches event handler for a given event-target. Also remembers attached handlers and related event-targets for clean up logic which will be executed before component will be destroyed, so use this method instead of explicit calls to [jQuery.on method](http://api.jquery.com/on/) to avoid possible memory leaks.

    Parameters:

    closeModalDialog

    ()

    Inherited from DomActionsMixin: addon/mixins/colsconfig-dialog-controller.js:42

    Close current modal window if it exists.

    createdModalDialog

    (
    • modalDialog
    )

    Inherited from DomActionsMixin: addon/mixins/colsconfig-dialog-controller.js:24

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

    Parameters:

    • modalDialog JQuery
      Created modal window.

    detachAllEventHandlers

    ()

    Inherited from DomActionsMixin: addon/mixins/dom-actions.js:213

    Detaches all event-handlers remembered in metadata when event-handlers were attached through {{#crossLink "DomActionsMixin/attachEventHandler:method"}}'attachEventHandler' method {{/crossLink}}.

    detachEventHandler

    (
    • options
    )

    Inherited from DomActionsMixin: addon/mixins/dom-actions.js:159

    Detaches event-handler from a given event-target. Also cleans up metadata remembered when event-handler was attached through {{#crossLink "DomActionsMixin/attachEventHandler:method"}}'attachEventHandler' method {{/crossLink}}.

    Parameters:

    send

    (
    • actionName
    • args
    )
    Any

    Inherited from DomActionsMixin: addon/mixins/dom-actions.js:254

    Overridden ['send' method](https://github.com/emberjs/ember.js/blob/v2.7.0/packages/ember-runtime/lib/mixins/action_handler.js#L145). Method logic still the same, but method now returns value returned by the action handler. `

    Parameters:

    • actionName String
      Name of the action that must be triggered.
    • args
      Arguments that must be passed to action.

    Returns:

    Any: Returns value returned by action handler.

    Properties

    _availableDomEvents

    Object private

    Inherited from DomActionsMixin: addon/mixins/dom-actions.js:53

    Dictionary containing names of DOM-events available for component's wrapping DOM-element and component's actions names related to them.

    _componentWrapperIsAvailable

    Boolean private

    Inherited from DynamicPropertiesMixin: addon/mixins/dynamic-properties.js:48

    Flag: indicates whether component's wrapper DOM-element is available for select now.

    _dynamicActions

    Object private

    Inherited from DynamicActionsMixin: addon/mixins/dynamic-actions.js:64

    Component's dynamic actions from {{#crossLink "DynamicActionsMixin:dynamicActions:property"}}'dynamicActions' property{{/crossLink}}, mapped from array into flat [JSON-object](http://www.json.org/).

    _dynamicPropertiesMetadata

    Object[] private

    Inherited from DynamicPropertiesMixin: addon/mixins/dynamic-properties.js:57

    Array with objects containing names of already assigned {{#crossLink "DynamicPropertiesMixin:dynamicProperties:property"}}dynamic properties{{/crossLink}} and observer handlers related to them. Each object in array has following structure: { propertyName: '...', propertyObserverHandler: function() { ... } }.

    Default: null

    _eventsMetadata

    Object[] private

    Inherited from DomActionsMixin: addon/mixins/dom-actions.js:69

    Array with objects containing selected event targets & handlers attached to them. Each object in array has following structure: { eventTarget: ..., attachedEventHandlers: { click: [function() {}, function() {}, ...], dblclick: [function() {}, function() {}, ...], ... } }.

    Default: null

    _hasContent

    Boolean private

    Defined in addon/components/flexberry-tree.js:137

    Flag: indicates whether some nested content is defined (some yield markup or {{#crossLink "FlexberryTreeComponent/nodes:property"}}'nodes'{{/childNodes}} are defined).

    _hasFooter

    Boolean private

    Defined in addon/components/flexberry-tree.js:151

    Flag: indicates whether some nested content for footer is defined (some yield markup for 'footer').

    _hasHeader

    Boolean private

    Defined in addon/components/flexberry-tree.js:123

    Flag: indicates whether some nested content for header is defined (some yield markup for 'header').

    _hasNodes

    Boolean private

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

    Flag: indicates whether some {{#crossLink "FlexberryTreeComponent/nodes:property"}}tree 'nodes'{{/childNodes}} are defined.

    _isRoot

    Boolean private

    Defined in addon/components/flexberry-tree.js:95

    Flag: indicates whether tree is placed on root level (hasn't parent nodes).

    _openedModalDialog

    JQuery

    Inherited from DomActionsMixin: addon/mixins/colsconfig-dialog-controller.js:14

    Current opened modal window.

    Default: undefined

    _requiredActions

    String[]

    Inherited from RequiredActionsMixin: addon/mixins/required-actions.js:19

    Component's required actions names. For actions enumerated in this array an assertion exceptions will be thrown, if actions handlers are not defined for them.

    Default: null

    animateChildren

    Boolean

    Defined in addon/components/flexberry-tree.js:226

    Flag: indicates whether nested child nodes content opacity should be animated (if true, it may cause performance issues with many nested child nodes).

    Default: false

    animationDuration

    Number

    Defined in addon/components/flexberry-tree.js:236

    Tree nodes expand/collapse animation duration in milliseconds.

    Default: 350

    classNameBindings

    String[]

    Defined in addon/components/flexberry-tree.js:187

    Component's wrapping

    Default: ['_isRoot:ui']

    classNames

    String[]

    Defined in addon/components/flexberry-tree.js:171

    Component's wrapping

    CSS-classes names.

    Any other CSS-class names can be added through component's 'class' property.

    Default: ['flexberry-tree', 'accordion']

    collapsible

    Boolean

    Defined in addon/components/flexberry-tree.js:217

    Flag: indicates whether it is allowed for already expanded tree nodes to collapse.

    Default: true

    dynamicActions

    DynamicActionObject[]

    Inherited from DynamicActionsMixin: addon/mixins/dynamic-actions.js:105

    Component's dynamic actions. If component consumes it's inner structure as [JSON-object](http://www.json.org/) or [Ember-object](https://emberjs.com/api/ember/release/classes/EmberObject) and there is no way to attach action handlers explicitly in hbs-markup, then you can define {{#crossLink "DynamicActionObject"}}dynamic actions{{/crossLink}} somewhere in code & pass defined array into this component's property.

    Default: null

    dynamicProperties

    Object

    Inherited from DynamicPropertiesMixin: addon/mixins/dynamic-properties.js:38

    Object containing dynamic properties that must be assigned to component using {{#crossLink "DynamicPropertiesMixin"}}dynamic-properties mixin{{/crossLink}}.

    Default: null

    exclusive

    Boolean

    Defined in addon/components/flexberry-tree.js:207

    Flag: indicates whether only one tree node can be expanded at the same time. If true, all expanded tree nodes will be automatically collapsed, on some other node expand.

    Default: false

    flexberryClassNames

    Object static

    Defined in addon/components/flexberry-tree.js:18

    Component's CSS-classes names. JSON-object containing string constants with CSS-classes names related to component's hbs-markup elements.

    Sub-properties:

    • prefix String

      Component's CSS-class names prefix ('flexberry-tree').

    • wrapper String

      Component's wrapping

      CSS-class name ('flexberry-tree').

    • header String

      Component's start toolbar CSS-class name ('flexberry-tree-header').

    • footer String

      Component's end toolbar CSS-class name ('flexberry-tree-footer').

    • placeholder String

      Component's placeholder CSS-class name ('flexberry-tree-placeholder').

    isTagless

    Boolean

    Inherited from DynamicPropertiesMixin but overwritten in addon/mixins/dom-actions.js:87

    Flag: indicates whether component is tagless or not (has empty [tagName](https://emberjs.com/api/ember/release/classes/Component#property_tagName) or not).

    nodes

    FlexberryTreenodeObject

    Defined in addon/components/flexberry-tree.js:245

    Tree nodes. This property is optional and must be used when there are too many child nodes, and you don't want to define them explicitly in the .hbs markup, then you can define nodes array somewhere in code & pass defined array to this component's property.

    Default: null

    placeholder

    String

    Defined in addon/components/flexberry-tree.js:197

    Component's placeholder. Will be displayed if nested tree nodes are not defined.

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