ButtonBase - Documentation

ButtonBase

go to → Members

Extends

ui.core.Widget

Signals

common.SIGNALRELEASING

Inherited From:

ui.core.DisposableHTMLElement

common.SIGNALRELEASED

Inherited From:

ui.core.DisposableHTMLElement

ui.core.UI_SIGNALFIRST_PAINT

Inherited From:

ui.core.DisposableHTMLElement

ui.core.UI_SIGNALPAINTED

Inherited From:

ui.core.DisposableHTMLElement

ui.core.UI_SIGNALUNPAINTED

Inherited From:

ui.core.DisposableHTMLElement

ui.core.UI_SIGNALCHILD_ADDED

Inherited From:

ui.core.DisplayObjectContainer

ui.core.UI_SIGNALCHILD_MOVED

Inherited From:

ui.core.DisplayObjectContainer

ui.core.UI_SIGNALCHILD_REMOVED

Inherited From:

ui.core.DisplayObjectContainer

Styling

Members

write-onlyflavor :string

TODO

read-onlyflavor :ui.core.helpers.FlagEnum

TODO

read-onlysize :ui.core.helpers.FlagEnum

Overrides:

ui.core.Widget → size

TODO

write-onlysize :string

Overrides:

ui.core.Widget → size

TODO

write-onlyvariant :string

TODO

read-onlyvariant :ui.core.helpers.FlagEnum

TODO

Methods

protectedoverride-me_Style()

Inherited From:

ui.core.DisplayObject → _Style

Command

Members

alwaysDisplayCommand :boolean

TODO

command :actions.Command

TODO

isCommandContext :boolean

TODO

isCommandTrigger :boolean

TODO

Methods

protected_OnCommandUpdated(p_command)

TODO

Parameters:

Name	Type	Description
`p_command`	actions.Command

Interactivity

Members

focusArea :Element

Inherited From:

ui.core.Widget → focusArea

Interactivity.Selection

Members

isSelectable :boolean

Inherited From:

ui.core.Widget → isSelectable

read-onlyisSelected :boolean

Inherited From:

ui.core.Widget → isSelected

selectionStack :ui.core.helpers.WidgetSelection

Inherited From:

ui.core.Widget → selectionStack

selectOnActivation :boolean

Inherited From:

ui.core.Widget → selectOnActivation

Methods

Select(p_toggle)

Inherited From:

ui.core.Widget → Select

protected_InitSelectionStack()

Inherited From:

ui.core.Widget → _InitSelectionStack

protected_OnSelectionStackAdd(p_item)

Inherited From:

ui.core.Widget → _OnSelectionStackAdd

protected_OnSelectionStackRemove(p_item)

Inherited From:

ui.core.Widget → _OnSelectionStackRemove

protectedoverride-me_SelectionGain()

Inherited From:

ui.core.Widget → _SelectionGain

protectedoverride-me_SelectionLost()

Inherited From:

ui.core.Widget → _SelectionLost

Interactivity.Focus

Members

isFocusable :boolean

Inherited From:

ui.core.Widget → isFocusable

read-onlyisFocused :boolean

Inherited From:

ui.core.Widget → isFocused

Methods

_Highlight(p_toggle)

Inherited From:

ui.core.Widget → _Highlight

Focus(p_toggle)

Inherited From:

ui.core.Widget → Focus

protectedoverride-me_FocusGain()

Inherited From:

ui.core.Widget → _FocusGain

protectedoverride-me_FocusLost()

Inherited From:

ui.core.Widget → _FocusLost

protectedoverride-me_HighlightGain()

Inherited From:

ui.core.Widget → _HighlightGain

protectedoverride-me_HighlightLost()

Inherited From:

ui.core.Widget → _HighlightLost

Data

Members

data :*

Inherited From:

ui.core.Widget → data

Methods

protectedoverride-me_OnDataChanged(p_oldData)

Inherited From:

ui.core.Widget → _OnDataChanged

protectedoverride-me_OnDataUpdated(p_data)

Inherited From:

ui.core.Widget → _OnDataUpdated

protectedoverride-me_PostDataChanged(p_oldData)

Inherited From:

ui.core.Widget → _PostDataChanged

Child Management

Members

read-onlycount :number

Inherited From:

ui.core.DisplayObjectContainer → count

read-onlydisplayList :array

Inherited From:

ui.core.DisplayObjectContainer → displayList

Methods

Add(p_displayObject, p_containeropt, p_cssClassopt, p_indexopt)

Inherited From:

ui.core.DisplayObjectContainer → Add

At(p_index) → {ui.core.DisplayObject|ui.core.DisplayObject}

Inherited From:

ui.core.DisplayObjectContainer → At

Move(p_displayObject, p_index)

Inherited From:

ui.core.DisplayObjectContainer → Move

Remove(p_displayObject)

Inherited From:

ui.core.DisplayObjectContainer → Remove

RemoveAt(p_index) → {ui.core.DisplayObject}

Inherited From:

ui.core.DisplayObjectContainer → RemoveAt

protectedoverride-me_OnChildAdded(p_displayObject, p_index)

Inherited From:

ui.core.DisplayObjectContainer → _OnChildAdded

protectedoverride-me_OnChildMoved(p_displayObject, p_index, p_oldIndex)

Inherited From:

ui.core.DisplayObjectContainer → _OnChildMoved

protectedoverride-me_OnChildRemoved(p_displayObject, p_index)

Inherited From:

ui.core.DisplayObjectContainer → _OnChildRemoved

Rendering

Members

read-onlyisPainted

Inherited From:

ui.core.DisposableHTMLElement → isPainted

visible :boolean

Inherited From:

ui.core.DisplayObject → visible

staticprotected__usePaintCallback

Inherited From:

ui.core.DisposableHTMLElement → __usePaintCallback

Methods

protectedoverride-me_OnPaintChange()

Inherited From:

ui.core.DisposableHTMLElement → _OnPaintChange

protectedoverride-me_PostRender()

Inherited From:

ui.core.DisplayObject → _PostRender

protectedoverride-me_Render()

Inherited From:

ui.core.DisplayObject → _Render

Hierarchy

Members

parent :ui.core.DisplayObjectContainer

Inherited From:

ui.core.DisplayObject → parent

Methods

BringToFront()

Inherited From:

ui.core.DisplayObject → BringToFront

protectedoverride-me_OnParentChanged(p_oldParent)

Inherited From:

ui.core.DisplayObject → _OnParentChanged

Broadcasting

This section list the main methods used to watch/unwatch signals on this object. For more info on signals, see signals

Methods

Unwatch(p_signal, p_fn, p_listener) → {ui.core.DisposableHTMLElement}

Inherited From:

ui.core.DisposableHTMLElement → Unwatch

Watch(p_signal, p_fn, p_listener) → {ui.core.DisposableHTMLElement}

Inherited From:

ui.core.DisposableHTMLElement → Watch

WatchOnce(p_signalId, p_fn, p_listener) → {ui.core.DisposableHTMLElement}

Inherited From:

ui.core.DisposableHTMLElement → WatchOnce

protected_Broadcast(p_signal, …args)

Inherited From:

ui.core.DisposableHTMLElement → _Broadcast

Pooling

Group of methods related to the NKMjs pooling system.

Members

read-onlyisReleasing :boolean

Inherited From:

ui.core.DisposableHTMLElement → isReleasing

Methods

override-me_Wake()

Inherited From:

ui.core.DisposableHTMLElement → _Wake

PreventRelease()

Inherited From:

ui.core.DisposableHTMLElement → PreventRelease

Release()

Inherited From:

ui.core.DisposableHTMLElement → Release

protectedoverride-me_CleanUp()

Inherited From:

ui.core.DisposableHTMLElement → _CleanUp

Misc

Members

__default_flavor :string

TODO

__default_size :string

TODO

__default_variant :string

TODO

read-onlyflags

Inherited From:

ui.core.DisplayObject → flags

read-onlyhost

Inherited From:

ui.core.DisplayObject → host

htitle :string

Inherited From:

ui.core.Widget → htitle

write-onlyisActivable :boolean

Overrides:

ui.core.Widget → isActivable

TODO

read-onlyisToggled :boolean

TODO

notifiesSelectionStack :boolean

Inherited From:

ui.core.Widget → notifiesSelectionStack

options :object

TODO

order :number

Inherited From:

ui.core.DisplayObject → order

request :object

TODO

toggle :object

TODO

trigger :object

TODO

read-onlywrapper

Inherited From:

ui.core.DisplayObject → wrapper

Methods

Activate(p_evt)

Overrides:

ui.core.Widget → Activate

TODO

Parameters:

Name	Type	Description
`p_evt`	Event

Deactivate()

Only used if isToggle === true.

protectedoverride-me_OnOptionsWillUpdate(p_options)

TODO

Parameters:

Name	Type	Description
`p_options`	*

protected_RegisterLocalRequestHandler(p_requestType, p_fn)

Inherited From:

ui.core.DisplayObject → _RegisterLocalRequestHandler

protected_UnregisterLocalRequestHandler(p_requestType, p_fn)

Inherited From:

ui.core.DisplayObject → _UnregisterLocalRequestHandler