ve.Window

ve.Feature. ve.Window

Refer to ve.Feature for methods or fields inherited from the parent, such as automatic destructuring.

Represents a Window Feature that contains a set of components which are wrapped inside an Interface.

Constructor:
  • arg0_components_obj: Object<ve.Component>
  • arg1_options: Object
    • .anchor="top_left" - Either 'bottom_left'/'bottom_right'/'top_left'/'top_right'.
    • .height="auto": number
    • .width="12rem": number
    • .x=HTML.mouse_x: function|number - If the type is a function, it must return a number.
    • .y=HTML.mouse_y: function|number - If the type is a function, it must return a number.
    • .do_not_wrap=false: boolean - Whether to disable wrapping in an always open ve.Interface.
    • .element: HTMLElement
    • .id: string
    • .mode="window": string - Either 'static_ui'/'static_window'/'window'.
    • .name="": string - Auto-resolves to 'Window' instead if .can_rename=true.#
    • .name_class="": string
    • .theme: string - The CSS theme to apply to the Feature.
    • .can_close: boolean
    • .can_rename: boolean
    • .draggable: boolean
    • .headless: boolean
    • .resizeable: boolean
    • .bottom_elements: Array<HTMLElement> - Determines margin from bottom.
    • .left_elements: Array<HTMLElement> - Determines margin from left.
    • .right_elements: Array<HTMLElement> - Determines margin from right.
    • .top_elements: Array<HTMLElement> - Determines margin from top.
    • .onuserchange: function(arg0_v:Object, arg1_e:Event) - Fires upon user changes to the window. Changes are discrete, and the set of Object keys may vary.
      • arg0_v: Object
        • .close: boolean - Whether the change is a close event.
        • .name: string
      • arg1_e: Object
        • .instance: ve.Window
Instance:
Methods:
  • getZIndex() | number
  • select()
  • setCoords(arg0_x:number, arg1_y:number)
  • setName(arg0_name:string)
  • setSize(arg0_width:number|string, arg1_height:number|string)
  • refresh(arg0_components_obj:Object<ve.Component>)
Static Fields:
  • .instances: Array<ve.Window>
Static Methods:
  • ve.Window.getHighestZIndex(arg0_options:{ return_object=false: boolean }) | number|ve.Window

Constructor

new ve.Window()

Source:

Extends

Members

v :Object

Returns the components currently visible in the Window.

  • Accessor of: ve.Window
Source:
Type:

v :Object

Sets the components visible in the current window.

  • Accessor of: ve.Window
Source:
Type:

instances :Array.<ve.Feature>

Overrides:
Source:
Type:

Methods

#getHighestZIndex(arg0_optionsopt) → {number|ve.Window}

Returns the highest z-index over the set of all Windows in ve.Window.instances.

  • Static method of: ve.Window
Source:
Parameters:
Name Type Attributes Description
arg0_options Object <optional>
Name Type Attributes Default Description
return_object boolean <optional>
 false

Whether to return a ve.Window instance.
Returns:
Type:
number | ve.Window

#normaliseZIndexes()

Normalises all z-indexes over the set of ve.Windows.

Source:

getZIndex() → {number}

Returns the current z-index of this ve.Window.

  • Method of: ve.Window
Source:
Returns:
Type:
number

refresh(arg0_components_obj)

Refreshes the components display for the current Window.

  • Method of: ve.Window
Source:
Parameters:
Name Type Description
arg0_components_obj Object

select()

Selects the current ve.Window instance, raising its z-index above all other Windows.

  • Method of: ve.Window
Source:

setCoords(arg0_x, arg1_y)

Sets the present coords of the window to a given X, Y coordinate relative to the present anchor.

  • Method of: ve.Window
Source:
Parameters:
Name Type Description
arg0_x number
arg1_y number

setName(arg0_name)

Sets the current name of the window.

  • Method of: ve.Window
Source:
Parameters:
Name Type Description
arg0_name string

setSize(arg0_width, arg1_height)

Sets the given size of the current window using either numbers or CSS calculated strings in Telestyle. Any functions must return either a number/string.

  • Method of: ve.Window
Source:
Parameters:
Name Type Description
arg0_width function | number | string
arg1_height function | number | string

addComponents(arg0_components_obj)

Adds components to the present this.element.

Overrides:
Source:
Parameters:
Name Type Description
arg0_components_obj Object

close()

Alias for this.remove().

Overrides:
Source:

remove()

Removes the ve.Feature from its static .instances field in addition to unmounting the feature from the DOM.

Overrides:
Source:

removeComponents(arg0_components_obj)

Removes components from the present this.element.

Overrides:
Source:
Parameters:
Name Type Description
arg0_components_obj Object

updateOwner()

Iterates over all present Vercengen components in ve.Feature and sets their owner to the current Feature if they do not already have populated .owner/.owners fields.

Overrides:
Source: