API Docs for: 1.8.0
Show:

photonui.ToggleButton Class

Uses
Extends photonui.CheckBox
Defined in: src/interactive/togglebutton.js:42
Module: Interactive
Parent Module: PhotonUI

Toogle Button.

Constructor

photonui.ToggleButton

()

Defined in src/interactive/togglebutton.js:42

Methods

__onButtonClicked

(
  • event
)
private

Inherited from photonui.Button: src/interactive/button.js:389

Called when the button is clicked.

Parameters:

__onChange

(
  • event
)
private

Inherited from photonui.CheckBox: src/interactive/checkbox.js:134

Parameters:

__onCheckboxClick

(
  • event
)
private

Inherited from photonui.CheckBox: src/interactive/checkbox.js:158

Parameters:

__onContextMenu

(
  • event
)
private

Inherited from photonui.Widget: src/widget.js:445

Called when the context menu should be displayed.

Parameters:

__onLocaleChanged

() private

Inherited from photonui.Widget: src/widget.js:460

Called when the locale is changed.

__onSpanClick

(
  • event
)
private

Inherited from photonui.CheckBox: src/interactive/checkbox.js:147

Parameters:

__onSpanKeyPress

(
  • event
)
private

Inherited from photonui.CheckBox: src/interactive/checkbox.js:167

Parameters:

_bindEvent

(
  • id
  • element
  • evName
  • callback
  • [options]
)
private

Inherited from photonui.Base: src/base.js:229

Javascript event binding (for internal use).

Parameters:

  • id String
    An unique id for the event.
  • element DOMElement
    The element on which the event will be bind.
  • evName String
    The event name (e.g. "mousemove", "click",...).
  • callback Function
    The function that will be called when the event occured.
  • [options] Object optional
    options for addEventListener

_buildHtml

() private

Inherited from photonui.Widget but overwritten in src/interactive/togglebutton.js:76

Build the widget HTML.

_callCallbacks

(
  • wEvent
  • params
)
private

Inherited from photonui.Base: src/base.js:292

Call all callbacks for the given wEvent. NOTE: the first argument passed to the callback is the current widget. NOTE²: if the thisArg of the callback is null, this will be binded to the current widget.

Parameters:

  • wEvent String
    The widget event.
  • params Array
    Parametters that will be sent to the callbacks.

_registerWEvents

(
  • wEvents
)
private

Inherited from photonui.Base: src/base.js:276

Register available wEvent.

Parameters:

_unbindEvent

(
  • id
)
private

Inherited from photonui.Base: src/base.js:257

Unbind javascript event.

Parameters:

  • id String
    The id of the event.

_update

() private

Inherited from photonui.Button: src/interactive/button.js:332

Update the button content

_updateProperties

(
  • properties
)
deprecated private

Inherited from photonui.Base: src/base.js:209

Force the update of the given properties. This method is deprecated. One should use '@photonui-update' abitbol's annotation on concerned properties.

Parameters:

  • properties Array
    The properties to update.

_visibilityChanged

(
  • visibility
)
private

Inherited from photonui.Widget: src/widget.js:425

Called when the visibility changes.

Parameters:

  • visibility Boolean

    Current visibility state (otptional, defaut=this.visible)

addClass

(
  • className
)

Inherited from photonui.Widget: src/widget.js:378

Add a class to the outer HTML element of the widget.

Parameters:

  • className String
    The class to add.

destroy

()

Inherited from photonui.Base but overwritten in src/interactive/button.js:311

Destroy the widget.

hide

()

Inherited from photonui.Widget: src/widget.js:345

Hide the widget (equivalent to widget.visible = false).

registerCallback

(
  • id
  • wEvent
  • callback
  • thisArg
)

Inherited from photonui.Base: src/base.js:169

Register a callback for any PhotonUI/Widget event (called wEvent). Callback signature: function (Object(Base/Widget) [, arg1 [, arg2 [, ...]]])

Parameters:

  • id String
    An unique id for the callback.
  • wEvent String
    the PhotonUI/Widget event name.
  • callback Function
    The callback function.
  • thisArg Object
    The value of this (optionnal, default = current widget).

removeCallback

(
  • id
)

Inherited from photonui.Base: src/base.js:193

Remove a registered callback.

Parameters:

  • id String
    The id of the callback.

removeClass

(
  • className
)

Inherited from photonui.Widget: src/widget.js:395

Remove a class from the outer HTML element of the widget.

Parameters:

  • className String
    The class to remove.

show

()

Inherited from photonui.Widget: src/widget.js:336

Display the widget (equivalent to widget.visible = true).

unparent

()

Inherited from photonui.Widget: src/widget.js:354

Detache the widget from its parent.

Properties

__callbacks

Object private

Inherited from photonui.Base: src/base.js:142

Object containing references to registered callbacks.

__events

Object private

Inherited from photonui.Base: src/base.js:132

Object containing references javascript events binding (for widget internal use).

__html

Object private

Inherited from photonui.Widget: src/widget.js:321

Object containing references to the widget HTML elements

absolutePosition

Object

Inherited from photonui.Widget: src/widget.js:275

Absolute position of the widget on the page. {x: Number, y: Number}

appearance

String

Inherited from photonui.Button: src/interactive/button.js:235

Define the button appearance.

  • normal
  • flat

Default: "normal"

buttonColor

String

Inherited from photonui.Button: src/interactive/button.js:261

Button's color.

The available colors depends on the theme. Particle, the default PhotonUI theme provides the following colors:

  • blue
  • red
  • yellow
  • green
  • null (default)

Default: null

contextMenu

photonui.PopupWindow

Inherited from photonui.Widget: src/widget.js:223

The managed contextual menu.

Default: null (= no context menu)

contextMenuName

String

Inherited from photonui.Widget: src/widget.js:206

The name of the managed contextual menu (photonui.PopupWindow().name).

Default: null (= no context menu)

data

Object

Inherited from photonui.Base: src/base.js:113

Arbitrary data

Default: {}

html

HTMLElement

Inherited from photonui.Widget but overwritten in src/interactive/button.js:293

Html outer element of the widget (if any).

Default: null

layoutOptions

Object

Inherited from photonui.Widget: src/widget.js:243

Layout options.

Default: {}

leftIcon

BaseIcon

Inherited from photonui.Button: src/interactive/button.js:138

Left icon widget.

Default: : null

leftIconName

String

Inherited from photonui.Button: src/interactive/button.js:115

Left icon widget name.

Default: : null

leftIconVisible

Boolean

Inherited from photonui.Button: src/interactive/button.js:157

Define if the left icon is displayed or hidden.

Default: true

name

String

Inherited from photonui.Widget: src/widget.js:109

The unique name of the widget.

Default: "widget-" + uuid.v4()

offsetHeight

Number

Inherited from photonui.Widget: src/widget.js:305

Widget height (outer HTML element).

offsetWidth

Number

Inherited from photonui.Widget: src/widget.js:291

Widget width (outer HTML element).

parent

photonui.Widget

Inherited from photonui.Widget: src/widget.js:145

The parent widget.

Default: null (no parent)

parentName

String

Inherited from photonui.Widget: src/widget.js:131

The parent widget name.

Default: null (no parent)

rightIcon

BaseIcon

Inherited from photonui.Button: src/interactive/button.js:198

Right icon widget.

Default: : null

rightIconName

String

Inherited from photonui.Button: src/interactive/button.js:175

Right icon widget name.

Default: : null

rightIconVisible

Boolean

Inherited from photonui.Button: src/interactive/button.js:217

Define if the right icon is displayed or hidden.

Default: true

text

String

Inherited from photonui.Button: src/interactive/button.js:77

The button text.

Default: "Button"

textVisible

Boolean

Inherited from photonui.Button: src/interactive/button.js:97

Define if the button text is displayed or hidden.

Default: true

tooltip

String

Inherited from photonui.Widget: src/widget.js:184

Tooltip.

Default: null

value

Boolean

Inherited from photonui.CheckBox: src/interactive/checkbox.js:75

The input value.

Default: false

visible

Boolean

Inherited from photonui.Widget: src/widget.js:157

Is the widget visible or hidden.

Default: true