ve.Feature: Features in Vercengen represent special containers such as panels, windows, tooltips, or interface which encapsulate ve.Component types.
Used to automatically destructure arg0_components_obj.
Constructor:
arg0_components_obj: function|Object<ve.Component>|string|ve.Componentarg1_options: Object - Fed into this.options for localised parsing.
DOM:
.instance: this:ve.Component
Instance:
.child_class=this.constructor: ve.Feature - The constructor object of the child class..child_class_obj=ve[htis.child_class.prototype.constructor.name]: ve.Feature - The actual object of the child class..components_obj: Array<ve.Component>.id: string.is_vercengen_feature=true: boolean - Whether to mark this ve.Feature as a Vercengen feature..options: Object
Methods:
- addComponents(arg0_components_obj:Object<ve.Component>) - Appends new components to the present ve.Feature.
- close() - Alias for .remove()
- remove() - Removes the current feature.
- removeComponents(arg0_components_obj:Object<ve.Component>) - Removes components from the current this.element based on key names.
- updateOwner() - Updates the
.owner/.ownersfields for all encapsulated components to ve.Feature if no ve.Class owner could be found.
Static Fields:
.instances: Array<ve.Feature>
Types:
- ve.Confirm(arg0_components_obj:Object<ve.Component>, arg1_options:Object) - Confirm dialogue/modal.
- ve.ContextMenu(arg0_components_obj:Object<ve.Component>, arg1_options:Object) - Pop-up context menu located at the cursor with an assigned
.idto prevent duplicates. - ve.Modal(arg0_components_obj:Object<ve.Component>, arg1_options:Object) - Overlays a modal on top of the current Vercengen overlay interface. Must be responded to before conventional windows.
- ve.Navbar(arg0_navbar_obj:Object, arg1_options:Object) - Creates an action topbar with recursive dropdown menus and keybind settings.
- ve.PageMenuWindow(arg0_page_obj:Object, arg1_options:Object) - Creates a page menu window, which encapsulates components in pages instead of interfaces.
- ve.Scene(arg0_components_obj:Object<ve.Component>, arg1_options:Object) - Creates a full-viewport rendering scene.
- ve.Toast(arg0_components_obj:Object<ve.Component>|string, arg1_options:Object) - Spawns a toast at the current cursor.
- ve.Tooltip(arg0_components_obj:Object<ve.Component>|string|ve.Component, arg1_options:Object) - Spawns a tooltip for the given
.options.element. - ve.Window(arg0_components_obj:Object<ve.Component>|string, arg1_options:Object) - Default ve.Feature for encapsulating components in ve.Class.
Classes
- ve.Confirm
- ve.ContextMenu
- ve.Modal
- ve.Navbar
- ve.PageMenuWindow
- ve.Scene
- ve.Toast
- ve.Tooltip
- ve.Window
Members
Methods
addComponents(arg0_components_obj)
Adds components to the present this.element.
- Method of: ve.Feature
Parameters:
| Name | Type | Description |
|---|---|---|
arg0_components_obj |
Object
|
close()
Alias for this.remove().
- Method of: ve.Feature
remove()
Removes the ve.Feature from its static .instances field in addition to unmounting the feature from the DOM.
- Method of: ve.Feature
removeComponents(arg0_components_obj)
Removes components from the present this.element.
- Method of: ve.Feature
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.
- Method of: ve.Feature