ve.HierarchyDatatype

ve.Component. ve.HierarchyDatatype

Refer to ve.Component for methods or fields inherited from this Component's parent such as .options.attributes or .element.

Hierarchy datatype used as a nested draggable item/group for ve.Hierarchy. Item by default.

  • Functional binding: veHierarchyDatatype().
Constructor:
  • arg0_value: Object<ve.Component>
  • arg1_options: Object
    • .disabled=false: boolean - Whether the item is draggable within the hierarchy.
    • .id: string
    • .type="item": string - Either 'group'/'item'.
Instance:
  • .components_obj: Object<ve.Component>
  • .is_vercengen_hierarchy_datatype=true: boolean
  • .name; string - Accessor. Differs from ve.Component.name in that it is a ve.Text.v value instead of a span element.
  • .type="item": string - Determined by .options.type.
  • .v: Object<ve.Component> - Accessor. Same as .components_obj.
Methods:
  • refresh() - Refreshes the display of the current datatype.
Static Fields:

Constructor

new ve.HierarchyDatatype()

Source:

Extends

Members

from_binding

Internal .from_binding setter for handling .options.from_binding. Accepts a string literal that is then parsed to a variable reference.

.to_binding counterparts are manually handled child-side.

Overrides:
Source:

instances :Array.<ve.HierarchyDatatype>

Contains a list of all instances of ve.HierarchyDatatypes.

Source:
Type:

limit

Tests the current this.limit by calling this.limit_function(this.v, this). Otherwise resolves to true if no .options.limit is set.

Overrides:
Source:

name

Returns the visual name of the present ve.Component,

Overrides:
Source:

Methods

addComponent()

Adds the current component to this.parent_el should it exist.

Overrides:
Source:

bind(arg0_container_el)

Manually binds/mounts the present ve.Component into the visual DOM.

Overrides:
Source:
Parameters:
Name Type Description
arg0_container_el HTMLElement

fireFromBinding()

Pseudo-setter from binding. Fires only upon program-driven changes to .v directly, which means that this has to be monitored manually component-side in set v(). This should always come last in set v().

Overrides:
Source:

fireToBinding()

Pseudo-setter to binding. Fires only upon user-driven changes, which means that this has to be monitored manually component-side.

Overrides:
Source:

remove()

Removes the component/element from the DOM.

Overrides:
Source:

removeComponent()

Removes the current component from this.parent_el should it exist.

Overrides:
Source:

setOwner(arg0_value, arg1_owner_array)

Sets the root parent and ownership tree. Influences this.parent_el, this.owner, this.owners.

Overrides:
Source:
Parameters:
Name Type Description
arg0_value
arg1_owner_array