Javascript API 7.x

Class: Switcher

bu.control. Switcher

new Switcher( [opt_options])

Parameters:
Name Type Argument Description
opt_options bu.control.SwitcherOptions <optional>

Switcher options.
Source:
bu/controls/switcher.js
Fires:
  • bu.control.event:SwitcherEvent

Extends

Members

controldefs :Array.<bu.ControlDefinition>

Array of control definitions this control contains.

Type:
Inherited From:
Source:
bu/controls/control.js

<nullable> element :Element

This is the HTML element where the control is drawn. Do not modify this property directly. Use only in the constructor.

Type:
  • Element
Inherited From:
Source:
bu/controls/control.js

<nullable> target :Element

This is the HTML element where the control is appended. Do not modify this property directly. Use constructor or setTarget to set this value.

Type:
  • Element
Inherited From:
Source:
bu/controls/control.js

Methods

addControlDefinition(controldef)

Adds a control definition to the control. By default the control in the control definition is changed its target to the element of this control. Override this behaviour in inherited classes to change the target to another one.

Parameters:
Name Type Description
controldef *

Control definition.
Inherited From:
Source:
bu/controls/control.js

addControlDefinitions(controldefs)

Adds an array of control definitions to the control. Controls in the control definition array shouldn't have a target set.

Parameters:
Name Type Description
controldefs Array.<bu.control.ControlDefinition>

Array of control definitions to add.
Inherited From:
Source:
bu/controls/control.js

containsControlDefinition(controldef)

Checks if a control definition is already added.

Parameters:
Name Type Description
controldef bu.ControlDefinition

Control definition to check.
Inherited From:
Source:
bu/controls/control.js
Returns:

True if it is added.

Type
boolean

getControlDefinitions()

Return the array of control definitions this control has inside.

Inherited From:
Source:
bu/controls/control.js
Returns:
Type
Array.<bu.ControlDefinition>

isEnabled()

Return if this control is enabled or not.

Source:
bu/controls/switcher.js
Returns:
Type
boolean

isTool()

Returns true if this control is a tool. A tool is a control that contains one or several options in a list (for example a bu.control.Switcher) that are linked to a viewer and only one of them can be active at a time. Tools are usually related to interactions in a way that only one interaction can be active at a time in a viewer.

Inherited From:
Overrides:
Source:
bu/controls/control.js
Returns:
Type
boolean

setEnabled(enabled)

Set if this control is enabled or not.

Parameters:
Name Type Description
enabled *

If enabled.
Source:
bu/controls/switcher.js

setSelectedItem(selectedItem)

Set the selected item of the control and triggers the corresponding events.

Parameters:
Name Type Description
selectedItem number

Index of the selected item. If -1 or outside current range then all items are set to unselected.
Source:
bu/controls/switcher.js

setTarget(target)

This function is used to set a target element for the control.

Parameters:
Name Type Description
target Element | string | bu.Viewer

Target.
Inherited From:
Source:
bu/controls/control.js

unselectTool()

If this control is a tool the unselects the tool.

Inherited From:
Overrides:
Source:
bu/controls/control.js

updateControlList(list, listValues)

Updates the list of options with a new list.

Parameters:
Name Type Description
list Array.<string>

List of text content for each item.
listValues Array.<string>

List of values for each item.
Source:
bu/controls/switcher.js

updateLanguage()

Updates the control for the current language in the bu.Globalization singleton.

Inherited From:
Overrides:
Source:
bu/controls/control.js