ve.Radio

ve.Component. ve.Radio

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

Mutually exclusive radio input with a specific reserved namespace. Consider using ve.Checkbox if you do not intend inputs to be mutually exclusive.

  • Functional binding: ve.Radio
Constructor:
  • arg0_value: Object
    • <radio_group_key>: Object
      • .is_category: true - You must set .is_category to true for it to take effect.
      • <radio_key>: Object
    • <radio_key>: Object
      • .name: string
      • .selected: boolean
  • arg1_options: Object
    • .selected: string - Overrides the <option_key>.selected option in arg0_value.
Instance:
  • .v: Object<boolean> - Recursive value, the same as arg0_value.
Static Fields:
  • .instances: Array<ve.Radio>
Static Methods:
  • generateHTMLRecursively(arg0_value:Object<boolean>, arg1_this:ve.Radio) | string

Constructor

new ve.Radio()

Source:

Extends

Members

v :Object.<boolean>

Returns the present value of the checked options.

  • Accessor of: ve.Radio
Source:
Type:

v

Sets the present value of the checked options.

  • Accessor of: ve.Radio
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_value, arg1_this) → {string}

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

  • Static method of: ve.Radio
Source:
Parameters:
Name Type Description
arg0_value Object.<boolean>
arg1_this ve.Radio
Returns:
Type:
string

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.