ve.Interface

ve.Component. ve.Interface

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

Interface used for encapsulating other ve.Components in a grid-like formatting pattern. Recursive.

  • Functional binding: veInterface().
Constructor:
  • arg0_components_obj: Object<ve.Component>
  • arg1_options: Object
    • .is_folder=false: boolean
    • .open=false: boolean
    • .type="default": string - Either 'default'/'flex'/'raw'. Returns a ve.FlexInterface and ve.RawInterface in other cases.
Instance:
  • <component_key>: ve.Component - Automatic destructuring for component_key.
  • .components_obj: Object<ve.Component> - Internal private field for .v.
  • .dimensions=[0,0]: Array<number, number> .reserved_keys: Array<string> - Controls what keys are reserved and cannot be destructured.
  • .v: Object<ve.Component>
Methods:
  • addComponent(arg0_component_key:string, arg1_component_obj:ve.Component)
  • redraw() - Recalculates coordinates before calling this.refresh().
  • refresh() - Redraws the present interface without recalculating coordinates.
  • removeComponent(arg0_component_obj:ve.Component)
  • resize(arg0_width:number, arg1_height:number)
Static Methods:

Constructor

new ve.Interface()

Source:

Extends

Members

v :Object

Returns the this.components_obj variable of the present Component.

  • Accessor of: ve.Interface
Source:
Type:

v

Sets a new this.components_obj variable for the present Component and redraws the interface.

  • Accessor of: ve.Interface
Source:

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:

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

#assignComponentCoordinates(arg0_components_obj)

Iterates over all components and assigns their coordinates.

  • Static method of: ve.Interface
Source:
Parameters:
Name Type Description
arg0_components_obj Object

#getDefinedComponentDimensions(arg0_components_obj) → {Array.<number>}

Returns the current .dimensions [width, height] of defined components prior to assigning coordinates to non-defined coordinates.

  • Static method of: ve.Interface
Source:
Parameters:
Name Type Description
arg0_components_obj Object
Returns:
Type:
Array.<number>

addComponent(arg0_component_key, arg1_component_obj)

Adds a new component and destructures it to the present component before redrawing the ve.Interface.

  • Method of: ve.Interface
Source:
Parameters:
Name Type Description
arg0_component_key string
arg1_component_obj ve.Component

redraw()

Redraws the entire UI for ve.Interface, including refreshing individual table cells.

  • Method of: ve.Interface
Source:

refresh()

Refreshes the current UI without recalculating coordinates.

  • Method of: ve.Interface
Source:

removeComponent(arg0_component_obj)

Removes a component mounted to the current interface.

  • Method of: ve.Interface
Source:
Parameters:
Name Type Description
arg0_component_obj ve.Component

resize(arg0_width, arg1_height)

Resizes the .dimensions of the present interface component.

Source:
Parameters:
Name Type Description
arg0_width number
arg1_height number

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

setValueFromObject(arg0_object, arg1_object)

Destructures Object values and transfers them into the .v instance fields of each Vercengen component.

Overrides:
Source:
Parameters:
Name Type Description
arg0_object Object

The Vercengen object to transfer to.
arg1_object Object

The other object to transfer from.