EclipseButtonParams

lumin.ui. EclipseButtonParams

new EclipseButtonParams(a_type, a_iconPath, a_labelText, a_heightopt)

Parameters:
Name Type Attributes Default Description
a_type lumin.ui.EclipseButtonType
a_iconPath string
a_labelText string
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 Button, (default 0 = default button height).

Type:
  • number

iconPath :string

Button icon path used in kIcon, kIconWithLabel, and kTextWithIcon.

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 button.

Type:

l10nKey :string

The localization key for the element label, used in kIconWithLabel, kText, and kTextWithIcon.

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 kIconWithLabel.

Type:

labelSide :lumin.ui.Side

What side the button label text sits on, used in kIconWithLabel.

Type:

labelText :string

Button label text used in kIconWithLabel, kText, and kTextWithIcon.

Type:
  • string

outlineButton :boolean

Whether the button has an outline. Considered only for kText and kTextWithIcon type button.

Type:
  • boolean

type :lumin.ui.EclipseButtonType

Type of Eclipse Button.

Type:

width :number

Width of the Eclipse Button, (default 0 = auto calculated width).

Type:
  • number

lumin.ui. EclipseButtonParams

new EclipseButtonParams(a_type, a_iconPath, a_labelText, a_labelSide, a_heightopt)

Parameters:
Name Type Attributes Default Description
a_type lumin.ui.EclipseButtonType
a_iconPath string
a_labelText string
a_labelSide lumin.ui.Side
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 Button, (default 0 = default button height).

Type:
  • number

iconPath :string

Button icon path used in kIcon, kIconWithLabel, and kTextWithIcon.

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 button.

Type:

l10nKey :string

The localization key for the element label, used in kIconWithLabel, kText, and kTextWithIcon.

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 kIconWithLabel.

Type:

labelSide :lumin.ui.Side

What side the button label text sits on, used in kIconWithLabel.

Type:

labelText :string

Button label text used in kIconWithLabel, kText, and kTextWithIcon.

Type:
  • string

outlineButton :boolean

Whether the button has an outline. Considered only for kText and kTextWithIcon type button.

Type:
  • boolean

type :lumin.ui.EclipseButtonType

Type of Eclipse Button.

Type:

width :number

Width of the Eclipse Button, (default 0 = auto calculated width).

Type:
  • number

lumin.ui. EclipseButtonParams

new EclipseButtonParams(a_type, a_iconType, a_labelText, a_labelSide, a_heightopt)

Parameters:
Name Type Attributes Default Description
a_type lumin.ui.EclipseButtonType
a_iconType lumin.ui.SystemIcon
a_labelText string
a_labelSide lumin.ui.Side
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 Button, (default 0 = default button height).

Type:
  • number

iconPath :string

Button icon path used in kIcon, kIconWithLabel, and kTextWithIcon.

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 button.

Type:

l10nKey :string

The localization key for the element label, used in kIconWithLabel, kText, and kTextWithIcon.

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 kIconWithLabel.

Type:

labelSide :lumin.ui.Side

What side the button label text sits on, used in kIconWithLabel.

Type:

labelText :string

Button label text used in kIconWithLabel, kText, and kTextWithIcon.

Type:
  • string

outlineButton :boolean

Whether the button has an outline. Considered only for kText and kTextWithIcon type button.

Type:
  • boolean

type :lumin.ui.EclipseButtonType

Type of Eclipse Button.

Type:

width :number

Width of the Eclipse Button, (default 0 = auto calculated width).

Type:
  • number

lumin.ui. EclipseButtonParams

new EclipseButtonParams(a_type, a_pathOrText, a_heightopt)

Parameters:
Name Type Attributes Default Description
a_type lumin.ui.EclipseButtonType
a_pathOrText string
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 Button, (default 0 = default button height).

Type:
  • number

iconPath :string

Button icon path used in kIcon, kIconWithLabel, and kTextWithIcon.

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 button.

Type:

l10nKey :string

The localization key for the element label, used in kIconWithLabel, kText, and kTextWithIcon.

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 kIconWithLabel.

Type:

labelSide :lumin.ui.Side

What side the button label text sits on, used in kIconWithLabel.

Type:

labelText :string

Button label text used in kIconWithLabel, kText, and kTextWithIcon.

Type:
  • string

outlineButton :boolean

Whether the button has an outline. Considered only for kText and kTextWithIcon type button.

Type:
  • boolean

type :lumin.ui.EclipseButtonType

Type of Eclipse Button.

Type:

width :number

Width of the Eclipse Button, (default 0 = auto calculated width).

Type:
  • number

lumin.ui. EclipseButtonParams

new EclipseButtonParams(a_type, a_iconPath, a_labelText, a_labelSide, a_height, iconType)

Parameters:
Name Type Description
a_type lumin.ui.EclipseButtonType
a_iconPath string
a_labelText string
a_labelSide lumin.ui.Side
a_height number
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 Button, (default 0 = default button height).

Type:
  • number

iconPath :string

Button icon path used in kIcon, kIconWithLabel, and kTextWithIcon.

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 button.

Type:

l10nKey :string

The localization key for the element label, used in kIconWithLabel, kText, and kTextWithIcon.

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 kIconWithLabel.

Type:

labelSide :lumin.ui.Side

What side the button label text sits on, used in kIconWithLabel.

Type:

labelText :string

Button label text used in kIconWithLabel, kText, and kTextWithIcon.

Type:
  • string

outlineButton :boolean

Whether the button has an outline. Considered only for kText and kTextWithIcon type button.

Type:
  • boolean

type :lumin.ui.EclipseButtonType

Type of Eclipse Button.

Type:

width :number

Width of the Eclipse Button, (default 0 = auto calculated width).

Type:
  • number

lumin.ui. EclipseButtonParams

new EclipseButtonParams(a_type)

Parameters:
Name Type Description
a_type lumin.ui.EclipseButtonType

Members

absoluteIconPath :boolean

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

Type:
  • boolean

height :number

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

Type:
  • number

iconPath :string

Button icon path used in kIcon, kIconWithLabel, and kTextWithIcon.

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 button.

Type:

l10nKey :string

The localization key for the element label, used in kIconWithLabel, kText, and kTextWithIcon.

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 kIconWithLabel.

Type:

labelSide :lumin.ui.Side

What side the button label text sits on, used in kIconWithLabel.

Type:

labelText :string

Button label text used in kIconWithLabel, kText, and kTextWithIcon.

Type:
  • string

outlineButton :boolean

Whether the button has an outline. Considered only for kText and kTextWithIcon type button.

Type:
  • boolean

type :lumin.ui.EclipseButtonType

Type of Eclipse Button.

Type:

width :number

Width of the Eclipse Button, (default 0 = auto calculated width).

Type:
  • number

lumin.ui. EclipseButtonParams

Button parameters for creating Eclipse buttons

Constructor

new EclipseButtonParams(a_type, a_iconType, a_heightopt)

Parameters:
Name Type Attributes Default Description
a_type lumin.ui.EclipseButtonType
a_iconType lumin.ui.SystemIcon
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 Button, (default 0 = default button height).

Type:
  • number

iconPath :string

Button icon path used in kIcon, kIconWithLabel, and kTextWithIcon.

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 button.

Type:

l10nKey :string

The localization key for the element label, used in kIconWithLabel, kText, and kTextWithIcon.

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 kIconWithLabel.

Type:

labelSide :lumin.ui.Side

What side the button label text sits on, used in kIconWithLabel.

Type:

labelText :string

Button label text used in kIconWithLabel, kText, and kTextWithIcon.

Type:
  • string

outlineButton :boolean

Whether the button has an outline. Considered only for kText and kTextWithIcon type button.

Type:
  • boolean

type :lumin.ui.EclipseButtonType

Type of Eclipse Button.

Type:

width :number

Width of the Eclipse Button, (default 0 = auto calculated width).

Type:
  • number