module:MRolePushButtonWidget

module:MRolePushButtonWidget

Role push button widget class.

Constructor

new (require("MRolePushButtonWidget"))()

Description:

  • Constructor.

Extends

Members

signalPressed :MSignal

Description:

  • Pressed signal

Overrides:

Pressed signal

Type:
  • MSignal

signalSender

Description:

  • Property method.

Overrides:

Property method.

setSignalSender

Description:

  • Property method.

Overrides:

Property method.

setDisabled

Description:

  • Set the widget disabled.

Overrides:

Set the widget disabled.

setEnabled

Description:

  • Set the widget enabled.

Overrides:

Set the widget enabled.

setEnabledState

Description:

  • Set enabled state.

Overrides:

Set enabled state.

setDisabledState

Description:

  • Set disabled state.

Overrides:

Set disabled state.

toggleEnabledState

Description:

  • Toggle enabled state.

Overrides:

Toggle enabled state.

setHidden

Description:

  • Set the widget hidden.

    Method uses style.display CSS to change the visibility.

Overrides:

Set the widget hidden.

Method uses style.display CSS to change the visibility.

setVisible

Description:

  • Set the widget visible.

    Method uses style.display CSS to change the visibility.

Overrides:

Set the widget visible.

Method uses style.display CSS to change the visibility.

setVisibilityState

Description:

  • Set visibility state.

Overrides:

Set visibility state.

setHiddenState

Description:

  • Set hidden state.

Overrides:

Set hidden state.

toggleVisibilityState

Description:

  • Toggle visibility state,

Overrides:

Toggle visibility state,

Methods

role() → {string}

Description:

  • Role.

Returns:

String enum value from MPushRoleButtonWidgetRole class.

Type
string

setRole(role, iconVisibility)

Description:

  • Set role.

Parameters:
Name Type Description
role string

String enum value from MPushRoleButtonWidgetRole class.
iconVisibility boolean

Whether the icon should be shown.

(static) getClassName() → {string}

Description:

  • Get class name of this widget.

    This method is needed to get the name of the class this widget since minifying of JS will omit it. The method must return the name of the widget class as string.

Returns:
Type
string

text() → {string}

Description:

  • Text.

Overrides:
Returns:
Type
string

setText(text)

Description:

  • Set text

Overrides:
Parameters:
Name Type Description
text string

Text.

primaryIcon() → {null|MFontAwesomeIconWidget}

Description:
Overrides:
Returns:
Type
null | MFontAwesomeIconWidget

setPrimaryIcon(iconClasses)

Description:

  • Set primary icon.

    You can use module:MFontAwesomeIconEnums enum class.

Overrides:
Parameters:
Name Type Description
iconClasses Array.<string>

Icon classes.

setPrimaryIconAriaHidden(state)

Description:

  • Set primary icon aria hidden.

Overrides:
Parameters:
Name Type Description
state boolean

State.

setPrimaryIconVisible()

Description:

  • Set primary icon visible.

Overrides:

setPrimaryIconHidden()

Description:

  • Set primary icon hidden.

Overrides:

setPrimaryIconVisibilityState(state)

Description:

  • Set primary icon visibility state.

Overrides:
Parameters:
Name Type Description
state boolean

State.

secondaryIcon() → {null|MFontAwesomeIconWidget}

Description:
Overrides:
Returns:
Type
null | MFontAwesomeIconWidget

setSecondaryIcon(iconClasses)

Description:

  • Set secondary icon.

    You can use module:MFontAwesomeIconEnums enum class.

Overrides:
Parameters:
Name Type Description
iconClasses Array.<string>

Icon classes.

setSecondaryIconAriaHidden(state)

Description:

  • Set secondary icon aria hidden.

Overrides:
Parameters:
Name Type Description
state boolean

State.

setSecondaryIconVisible()

Description:

  • Set secondary icon visible.

Overrides:

setSecondaryIconHidden()

Description:

  • Set secondary icon hidden.

Overrides:

setSecondaryIconVisibilityState(state)

Description:

  • Set secondary icon visibility state.

Overrides:
Parameters:
Name Type Description
state boolean

State.

click()

Description:

  • Emulate click.

    Method will emit signalPressed signal.

Overrides:

type() → {string}

Description:

  • Property Method.

Overrides:
Returns:

Value from MWidgetType enum class.

Type
string

parentWidget() → {null|MWidget}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | MWidget

setParent(parentWidget)

Description:

  • Set parent of this widget.

    This widget will be placed under root HTML element of the given parentWidget.

    This method affects the hierarchy of this widget.

Overrides:
Parameters:
Name Type Description
parentWidget MWidget

Parent widget.

setParentOfWidgetElement(parentWidget)

Description:

  • Set parent of this widget.

    This widget will be placed under widget HTML element of the given parentWidget.

    This method affects the hierarchy of this widget.

Overrides:
Parameters:
Name Type Description
parentWidget MWidget

Parent widget.

setParentByHTMLElementID(parentHTMLElementID)

Description:

  • Set parent by element ID.

    This method affects the hierarchy of this widget.

Overrides:
Parameters:
Name Type Description
parentHTMLElementID string

Parent HTML element ID.

setParentByHTMLElement(parentHTMLElement)

Description:

  • Set parent by HTML element.

    This method affects the hierarchy of this widget.

Overrides:
Parameters:
Name Type Description
parentHTMLElement HTMLElement

Parent HTML element.

assignParentWidget(parentWidget)

Description:

  • Assign parent widget.

    This method doesn't change hierarchy, simple sets the given widget as parent widget of this widget.

Overrides:
Parameters:
Name Type Description
parentWidget MWidget

Widget.

rootHTMLElement() → {null|HTMLElement}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | HTMLElement

widgetHTMLElement() → {null|HTMLElement}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | HTMLElement

childrenLayouts() → {Array.<MLayout>}

Description:

  • Property method.

Overrides:
Returns:

Value.

Type
Array.<MLayout>

addChildLayout(layout)

Description:

  • Property method

Overrides:
Parameters:
Name Type Description
layout MWidget | MLayout

Layout.

removeChildLayout(layout) → {boolean}

Description:

  • Property method.

Overrides:
Parameters:
Name Type Description
layout MWidget | MLayout

Layout.
Returns:

Whether the given layout found and removed.

Type
boolean

childrenWidgets() → {Array.<MWidget>}

Description:

  • Property method.

Overrides:
Returns:

Value.

Type
Array.<MWidget>

addChildWidget(widget)

Description:

  • Property method

Overrides:
Parameters:
Name Type Description
widget MWidget

Widget.

removeChildWidget(widget) → {boolean}

Description:

  • Property method.

Overrides:
Parameters:
Name Type Description
widget MWidget

Widget.
Returns:

Whether the given widget found and removed.

Type
boolean

childrenFields() → {Array.<MField>}

Description:

  • Property method.

Overrides:
Returns:

Value.

Type
Array.<MField>

addChildField(field)

Description:

  • Property method

Overrides:
Parameters:
Name Type Description
field MWidget | MField

Field.

removeChildField(field) → {boolean}

Description:

  • Property method.

Overrides:
Parameters:
Name Type Description
field MWidget | MField

Field.
Returns:

Whether the given field found and removed.

Type
boolean

childrenHTMLElements() → {Array.<HTMLElement>}

Description:

  • Property method.

Overrides:
Returns:

Value.

Type
Array.<HTMLElement>

addChildHTMLElement(htmlElement)

Description:

  • Add given htmlElement as a child to this widget.

Overrides:
Parameters:
Name Type Description
htmlElement HTMLElement

HTML element.

removeChildHTMLElement(htmlElement) → {boolean}

Description:

  • Property method.

Overrides:
Parameters:
Name Type Description
htmlElement htmlElement

HTML element.
Returns:

Whether the given htmlElement found and removed.

Type
boolean

className() → {null|string}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | string

cssClassesNamespace() → {null|string}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | string

data() → {null|*}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
null | *

setData(data)

Description:

  • Property Method.

Overrides:
Parameters:
Name Type Description
data *

Data to be set.

isDisabled() → {boolean}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
boolean

isHidden() → {boolean}

Description:

  • Property Method.

Overrides:
Returns:

Value.

Type
boolean

setRootHTMLElementID(id)

Description:

  • Set root HTML element ID.

Overrides:
Parameters:
Name Type Description
id string

ID.

getWidgetHTMLElementName() → {null|string}

Description:

  • Get widget HTML element name.

Overrides:
Returns:

Name.

Type
null | string

setWidgetHTMLElementName(name)

Description:

  • Set widget HTML element name.

Overrides:
Parameters:
Name Type Description
name string

Name.

setWidgetHTMLElementAttribute(attributeName, value)

Description:

  • Set widget HTML element attribute.

Overrides:
Parameters:
Name Type Description
attributeName string

Attribute name.
value *

Value to be set.

getWidgetHTMLElementAttribute(attributeName) → {*}

Description:

  • Set widget HTML element attribute.

Overrides:
Parameters:
Name Type Description
attributeName string

Attribute name.
Returns:

Value.

Type
*

remove()

Description:

  • Remove the widget from its parent.

Overrides:

addRootHTMLElementEventListener(event, callback, context)

Description:

  • Add event listener to the root HTML element.

Overrides:
Parameters:
Name Type Description
event string

Event.
callback function

Callback.
context any

Context, namely this.

addWidgetHTMLElementEventListener(event, callback, context)

Description:

  • Add event listener to the widget HTML element.

Overrides:
Parameters:
Name Type Description
event string

Event.
callback function

Callback.
context any

Context, namely this.

removed()

Description:

  • This method is invoked when a widget is removed for deletion from memory.

Overrides:

initializeDescendantData()

Description:

  • Data block data initialized.

    This method is usually invoked explicitly by the parent object.

Overrides:

initializeData()

Description:

  • Initialize data by using data block.

Overrides: