Class: SuiBuilder

'brixy.ui.SuiBuilder'~ SuiBuilder

new SuiBuilder (name)

SuiBuilder object.

Parameters:
Name Type Description
name string

Builder's name. (optional)

Properties:
Name Type Description
_builder Object

Private builder object.

Properties
Name Type Description
name string

Builder's name.

element component

Current SUI component.

container component

Current SUI container component.

validator Object

Validator object.

builder SuiBuilder

This SuiBuilder instance.

Source:

Methods

(static) attach (members, replaceopt)

Adds methods into SuiBuilder prototype.

Parameters:
Name Type Attributes Default Description
members Object

Methods.

replace boolean <optional>
false

If true, existing methods will be replaced. (optional)

Source:

(static) detach (members)

Removes methods from the SuiBuilder prototype.

Parameters:
Name Type Description
members string | Array.<string>

The list of the method names to detach.

Source:

addComponent (name, callback)

Adds method into SuiBuilder instance. Existing method are replaced.

Parameters:
Name Type Description
name string

Component name.

callback function
Source:

addComponents ()

Adds methods into SuiBuilder instance. Existing methods are replaced.

Parameters:
Name Type Attributes Description
components, ... Object <optional>
<repeatable>

Each argument is object with component definitions.

Source:

get (id) → {component}

Returns saved element.

Parameters:
Name Type Description
id string
Returns:
  • component
Source:

getAll () → {Object}

Returns all saved elements.

Returns:
  • Object
Source:

result () → {int}

Returns a result of the ScriptUI window.show() method.

Returns:
  • int
Source:

toString () → {string}

Returns a string representation of the object.

Returns:
  • string
Source: