EclipseToggleParams

lumin.ui. EclipseToggleParams

new EclipseToggleParams(a_type, a_iconPath, a_labelText, a_statusText1, a_statusText2, a_height, a_iconType)

Parameters:
Name Type Description
a_type lumin.ui.EclipseToggleType
a_iconPath string
a_labelText string
a_statusText1 string
a_statusText2 string
a_height number
a_iconType lumin.ui.SystemIcon

Members

absoluteIconPath :boolean

If the icon path is an absolute path (default false).

Type:
  • boolean

height :number

Height of the Eclipse toggle, (default 0 = default toggle height).

Type:
  • number

iconPath :string

Eclipse toggle icon path used in kRadialWithIcon.

Type:
  • string

iconScale :number

Icon scale (default 1.0f).

Type:
  • number

iconType :lumin.ui.SystemIcon

The type of SystemIcon to be used for the eclipse toggle

Type:

iconTypeOffState :lumin.ui.SystemIcon

Optional SystemIcon to be displayed in the toggle off state

Type:

l10nKey :string

The localization key for the element label.

Type:
  • string

l10nParams :Object.<string, lumin.utils.LocaleHelper.Param>

The optional localization parameters for the element label.

Type:

labelDisplayMode :lumin.ui.LabelDisplayMode

The display mode of the label, used in kIcon.

Type:

labelSide :lumin.ui.Side

What side the label text sits on, used in kIcon.

Type:

labelText :string

The toggle label text

Type:
  • string

showBackground :boolean

Whether to show the toggle background (OFF outline or solid ON states)

Type:
  • boolean

statusText1 :string

The left status label of the kSwitchWithLabel ("OFF")

Type:
  • string

statusText2 :string

The right status label of the kSwitchWithLabel ("ON")

Type:
  • string

type :lumin.ui.EclipseToggleType

Type of eclipse toggle.

Type:

lumin.ui. EclipseToggleParams

new EclipseToggleParams(a_type, a_iconType, a_labelTextopt, a_statusText1opt, a_statusText2opt, a_heightopt)

Parameters:
Name Type Attributes Default Description
a_type lumin.ui.EclipseToggleType
a_iconType lumin.ui.SystemIcon
a_labelText string <optional>
""
a_statusText1 string <optional>
"OFF"
a_statusText2 string <optional>
"ON"
a_height number <optional>
0.0

Members

absoluteIconPath :boolean

If the icon path is an absolute path (default false).

Type:
  • boolean

height :number

Height of the Eclipse toggle, (default 0 = default toggle height).

Type:
  • number

iconPath :string

Eclipse toggle icon path used in kRadialWithIcon.

Type:
  • string

iconScale :number

Icon scale (default 1.0f).

Type:
  • number

iconType :lumin.ui.SystemIcon

The type of SystemIcon to be used for the eclipse toggle

Type:

iconTypeOffState :lumin.ui.SystemIcon

Optional SystemIcon to be displayed in the toggle off state

Type:

l10nKey :string

The localization key for the element label.

Type:
  • string

l10nParams :Object.<string, lumin.utils.LocaleHelper.Param>

The optional localization parameters for the element label.

Type:

labelDisplayMode :lumin.ui.LabelDisplayMode

The display mode of the label, used in kIcon.

Type:

labelSide :lumin.ui.Side

What side the label text sits on, used in kIcon.

Type:

labelText :string

The toggle label text

Type:
  • string

showBackground :boolean

Whether to show the toggle background (OFF outline or solid ON states)

Type:
  • boolean

statusText1 :string

The left status label of the kSwitchWithLabel ("OFF")

Type:
  • string

statusText2 :string

The right status label of the kSwitchWithLabel ("ON")

Type:
  • string

type :lumin.ui.EclipseToggleType

Type of eclipse toggle.

Type:

lumin.ui. EclipseToggleParams

new EclipseToggleParams(a_type, a_iconPath, a_labelTextopt, a_statusText1opt, a_statusText2opt, a_heightopt)

Parameters:
Name Type Attributes Default Description
a_type lumin.ui.EclipseToggleType
a_iconPath string
a_labelText string <optional>
""
a_statusText1 string <optional>
"OFF"
a_statusText2 string <optional>
"ON"
a_height number <optional>
0.0

Members

absoluteIconPath :boolean

If the icon path is an absolute path (default false).

Type:
  • boolean

height :number

Height of the Eclipse toggle, (default 0 = default toggle height).

Type:
  • number

iconPath :string

Eclipse toggle icon path used in kRadialWithIcon.

Type:
  • string

iconScale :number

Icon scale (default 1.0f).

Type:
  • number

iconType :lumin.ui.SystemIcon

The type of SystemIcon to be used for the eclipse toggle

Type:

iconTypeOffState :lumin.ui.SystemIcon

Optional SystemIcon to be displayed in the toggle off state

Type:

l10nKey :string

The localization key for the element label.

Type:
  • string

l10nParams :Object.<string, lumin.utils.LocaleHelper.Param>

The optional localization parameters for the element label.

Type:

labelDisplayMode :lumin.ui.LabelDisplayMode

The display mode of the label, used in kIcon.

Type:

labelSide :lumin.ui.Side

What side the label text sits on, used in kIcon.

Type:

labelText :string

The toggle label text

Type:
  • string

showBackground :boolean

Whether to show the toggle background (OFF outline or solid ON states)

Type:
  • boolean

statusText1 :string

The left status label of the kSwitchWithLabel ("OFF")

Type:
  • string

statusText2 :string

The right status label of the kSwitchWithLabel ("ON")

Type:
  • string

type :lumin.ui.EclipseToggleType

Type of eclipse toggle.

Type:

lumin.ui. EclipseToggleParams

Eclipse toggle parameters for creating sliders

Constructor

new EclipseToggleParams(a_type, a_iconType, a_iconTypeOffState, a_labelTextopt, a_statusText1opt, a_statusText2opt, a_heightopt)

Parameters:
Name Type Attributes Default Description
a_type lumin.ui.EclipseToggleType
a_iconType lumin.ui.SystemIcon
a_iconTypeOffState lumin.ui.SystemIcon
a_labelText string <optional>
""
a_statusText1 string <optional>
"OFF"
a_statusText2 string <optional>
"ON"
a_height number <optional>
0.0

Members

absoluteIconPath :boolean

If the icon path is an absolute path (default false).

Type:
  • boolean

height :number

Height of the Eclipse toggle, (default 0 = default toggle height).

Type:
  • number

iconPath :string

Eclipse toggle icon path used in kRadialWithIcon.

Type:
  • string

iconScale :number

Icon scale (default 1.0f).

Type:
  • number

iconType :lumin.ui.SystemIcon

The type of SystemIcon to be used for the eclipse toggle

Type:

iconTypeOffState :lumin.ui.SystemIcon

Optional SystemIcon to be displayed in the toggle off state

Type:

l10nKey :string

The localization key for the element label.

Type:
  • string

l10nParams :Object.<string, lumin.utils.LocaleHelper.Param>

The optional localization parameters for the element label.

Type:

labelDisplayMode :lumin.ui.LabelDisplayMode

The display mode of the label, used in kIcon.

Type:

labelSide :lumin.ui.Side

What side the label text sits on, used in kIcon.

Type:

labelText :string

The toggle label text

Type:
  • string

showBackground :boolean

Whether to show the toggle background (OFF outline or solid ON states)

Type:
  • boolean

statusText1 :string

The left status label of the kSwitchWithLabel ("OFF")

Type:
  • string

statusText2 :string

The right status label of the kSwitchWithLabel ("ON")

Type:
  • string

type :lumin.ui.EclipseToggleType

Type of eclipse toggle.

Type:

lumin.ui. EclipseToggleParams

new EclipseToggleParams(a_type, a_iconPath, a_labelText, a_statusText1, a_statusText2, a_height, a_iconType, a_iconTypeOffState)

Parameters:
Name Type Description
a_type lumin.ui.EclipseToggleType
a_iconPath string
a_labelText string
a_statusText1 string
a_statusText2 string
a_height number
a_iconType lumin.ui.SystemIcon
a_iconTypeOffState lumin.ui.SystemIcon

Members

absoluteIconPath :boolean

If the icon path is an absolute path (default false).

Type:
  • boolean

height :number

Height of the Eclipse toggle, (default 0 = default toggle height).

Type:
  • number

iconPath :string

Eclipse toggle icon path used in kRadialWithIcon.

Type:
  • string

iconScale :number

Icon scale (default 1.0f).

Type:
  • number

iconType :lumin.ui.SystemIcon

The type of SystemIcon to be used for the eclipse toggle

Type:

iconTypeOffState :lumin.ui.SystemIcon

Optional SystemIcon to be displayed in the toggle off state

Type:

l10nKey :string

The localization key for the element label.

Type:
  • string

l10nParams :Object.<string, lumin.utils.LocaleHelper.Param>

The optional localization parameters for the element label.

Type:

labelDisplayMode :lumin.ui.LabelDisplayMode

The display mode of the label, used in kIcon.

Type:

labelSide :lumin.ui.Side

What side the label text sits on, used in kIcon.

Type:

labelText :string

The toggle label text

Type:
  • string

showBackground :boolean

Whether to show the toggle background (OFF outline or solid ON states)

Type:
  • boolean

statusText1 :string

The left status label of the kSwitchWithLabel ("OFF")

Type:
  • string

statusText2 :string

The right status label of the kSwitchWithLabel ("ON")

Type:
  • string

type :lumin.ui.EclipseToggleType

Type of eclipse toggle.

Type: