ve.FlexInterface

ve.Component. ve.FlexInterface

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

Flex interface used for partitions within the same window that can be automatically resized by the user, similar to sub-windows. The .arg1_options.style.flex attribute of the descendant Component will determine its flex size.

  • Functional binding: veFlexInterface().
Constructor:
  • arg0_value: Object
    • <category_key>: Object
      • <category_key>: Object
      • <component_key>: ve.Component
        • .options: Object
          • .flex_disabled=false: boolean
      • .type="horizontal" - Either 'horizontal'/'vertical'.
    • .type="horizontal" - Either 'horizontal'/'vertical'.
  • arg1_options: Object
Instance:
Methods:
  • handleEvents()
  • handleResize(arg0_e:Event, arg1_size_property:string, arg2_position_property:string)
Static Methods:
  • generateHTMLRecursively(arg0_root_el:HTMLElement, arg1_value:Object, arg2_options:{ flex_disabled:boolean })

Constructor

new ve.FlexInterface()

Source:

Extends

Members

v :Object

Returns the current value of the component.

  • Accessor of: ve.FlexInterface
Source:
Type:

v

Sets the present value of the component.

  • Accessor of: ve.FlexInterface
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

#generateHTMLRecursively(arg0_root_el, arg1_value, arg2_optionsopt) → {HTMLElement}

Generates HTML recursively given a current value compatible with the component's initialising arg0_value and a root element.

  • Static method of: ve.FlexInterface
Source:
Parameters:
Name Type Attributes Description
arg0_root_el HTMLElement | undefined
arg1_value Object
arg2_options Object <optional>
Name Type Attributes Default Description
flex_disabled boolean <optional>
 false

Whether flex resizing is disabled for the given element.
Returns:
Type:
HTMLElement

handleEvents()

Handles events for the current component.

  • Method of: ve.FlexInterface
Source:

handleResize(arg0_e, arg1_dimension_property, arg2_position_property)

Handles a resize event given a MouseDown event type. Internal helper method.

  • Method of: ve.FlexInterface
Source:
Parameters:
Name Type Description
arg0_e Event
arg1_dimension_property string

"width" or "height"
arg2_position_property string

"pageX" or "pageY"

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.