Winter Cardinal UI - v0.457.0 / DThemeInputBooleanButtonOn

Interface: DThemeInputBooleanButtonOn

DButton theme.

Hierarchy

• DThemeButton<string>

  ↳ DThemeInputBooleanButtonOn

Implemented by

• DThemeDarkInputBooleanButtonOn
• DThemeWhiteInputBooleanButtonOn

Table of contents

Methods

• getAlpha
• getBackgroundAlpha
• getBackgroundColor
• getBackgroundTexture
• getBorderAlign
• getBorderAlpha
• getBorderColor
• getBorderMask
• getBorderTexture
• getBorderWidth
• getClearType
• getColor
• getCornerMask
• getCornerRadius
• getCursor
• getFontFamilly
• getFontSize
• getFontStyle
• getFontVariant
• getFontWeight
• getHeight
• getImageAlignHorizontal
• getImageAlignVertical
• getImageAlignWith
• getImageMarginHorizontal
• getImageMarginVertial
• getImageRotation
• getImageSource
• getImageTintAlpha
• getImageTintColor
• getInteractive
• getLineHeight
• getOutlineAlign
• getOutlineAlpha
• getOutlineColor
• getOutlineMask
• getOutlineOffset
• getOutlineWidth
• getPaddingBottom
• getPaddingLeft
• getPaddingRight
• getPaddingTop
• getSecondaryImageAlignHorizontal
• getSecondaryImageAlignVertical
• getSecondaryImageAlignWith
• getSecondaryImageMarginHorizontal
• getSecondaryImageMarginVertial
• getSecondaryImageRotation
• getSecondaryImageSource
• getSecondaryImageTintAlpha
• getSecondaryImageTintColor
• getShadow
• getTertiaryImageAlignHorizontal
• getTertiaryImageAlignVertical
• getTertiaryImageAlignWith
• getTertiaryImageMarginHorizontal
• getTertiaryImageMarginVertial
• getTertiaryImageRotation
• getTertiaryImageSource
• getTertiaryImageTintAlpha
• getTertiaryImageTintColor
• getTextAlignHorizontal
• getTextAlignVertical
• getTextFormatter
• getTextStyleClipping
• getTextStyleFitting
• getTextStyleWordWrap
• getTextValue
• getTitle
• getWeight
• getWhen
• getWidth
• getX
• getY
• isOverflowMaskEnabled
• isToggle
• newShadow
• newShadowWeak
• newState
• newTextValue

Methods

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeButton.getAlpha

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:34

---

getBackgroundAlpha

▸ getBackgroundAlpha(state): number

Returns a background alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getBackgroundAlpha

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:551

---

getBackgroundColor

▸ getBackgroundColor(state): null | number

Returns a background color. If the color is null, backgrounds are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Inherited from

DThemeButton.getBackgroundColor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:544

---

getBackgroundTexture

▸ getBackgroundTexture(): Texture

Returns a background texture.

Returns

Texture

Inherited from

DThemeButton.getBackgroundTexture

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:556

---

getBorderAlign

▸ getBorderAlign(state): number

Returns a border align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getBorderAlign

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:585

---

getBorderAlpha

▸ getBorderAlpha(state): number

Returns a border alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getBorderAlpha

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:571

---

getBorderColor

▸ getBorderColor(state): null | number

Returns a border color. If the color is null, borders are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Inherited from

DThemeButton.getBorderColor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:564

---

getBorderMask

▸ getBorderMask(state): number

Returns a border mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a mask

Returns

number

Inherited from

DThemeButton.getBorderMask

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:592

---

getBorderTexture

▸ getBorderTexture(): Texture

Returns a border texture.

Returns

Texture

Inherited from

DThemeButton.getBorderTexture

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:597

---

getBorderWidth

▸ getBorderWidth(state): number

Returns a border width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getBorderWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:578

---

getClearType

▸ getClearType(): number

Returns a clear type. A clear type is for layout classes including DLayoutVertical.

Returns

number

Inherited from

DThemeButton.getClearType

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:697

---

getColor

▸ getColor(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeButton.getColor

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:33

---

getCornerMask

▸ getCornerMask(): number

Returns a corner mask.

Returns

number

Inherited from

DThemeButton.getCornerMask

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:627

---

getCornerRadius

▸ getCornerRadius(): number

Returns a corner radius.

Returns

number

Inherited from

DThemeButton.getCornerRadius

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:622

---

getCursor

▸ getCursor(state): string

Returns a cursor.

Parameters

Name	Type
state	DBaseStateSet

Returns

string

Inherited from

DThemeButton.getCursor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:719

---

getFontFamilly

▸ getFontFamilly(): string

Returns

string

Inherited from

DThemeButton.getFontFamilly

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:28

---

getFontSize

▸ getFontSize(): number

Returns

number

Inherited from

DThemeButton.getFontSize

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:29

---

getFontStyle

▸ getFontStyle(): DFontStyle

Returns

DFontStyle

Inherited from

DThemeButton.getFontStyle

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:31

---

getFontVariant

▸ getFontVariant(): DFontVariant

Returns

DFontVariant

Inherited from

DThemeButton.getFontVariant

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:32

---

getFontWeight

▸ getFontWeight(): DFontWeight

Returns

DFontWeight

Inherited from

DThemeButton.getFontWeight

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:30

---

getHeight

▸ getHeight(): DCoordinateSize

Returns a height.

Returns

DCoordinateSize

Inherited from

DThemeButton.getHeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:531

---

getImageAlignHorizontal

▸ getImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Inherited from

DThemeButton.getImageAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:20

---

getImageAlignVertical

▸ getImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Inherited from

DThemeButton.getImageAlignVertical

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:21

---

getImageAlignWith

▸ getImageAlignWith(): DAlignWith

Returns

DAlignWith

Inherited from

DThemeButton.getImageAlignWith

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:22

---

getImageMarginHorizontal

▸ getImageMarginHorizontal(): number

Returns

number

Inherited from

DThemeButton.getImageMarginHorizontal

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:23

---

getImageMarginVertial

▸ getImageMarginVertial(): number

Returns

number

Inherited from

DThemeButton.getImageMarginVertial

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:24

---

getImageRotation

▸ getImageRotation(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeButton.getImageRotation

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:28

---

getImageSource

▸ getImageSource(state): null | DisplayObject | Texture

Parameters

Name	Type
state	DBaseStateSet

Returns

null | DisplayObject | Texture

Inherited from

DThemeButton.getImageSource

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:27

---

getImageTintAlpha

▸ getImageTintAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeButton.getImageTintAlpha

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:26

---

getImageTintColor

▸ getImageTintColor(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Inherited from

DThemeButton.getImageTintColor

Defined in

src/main/typescript/wcardinal/ui/d-image-piece.ts:25

---

getInteractive

▸ getInteractive(): number

Returns an interactivity.

Returns

number

Inherited from

DThemeButton.getInteractive

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:681

---

getLineHeight

▸ getLineHeight(): number

Returns

number

Inherited from

DThemeButton.getLineHeight

Defined in

src/main/typescript/wcardinal/ui/d-font.ts:35

---

getOutlineAlign

▸ getOutlineAlign(state): number

Returns an outline align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getOutlineAlign

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:663

---

getOutlineAlpha

▸ getOutlineAlpha(state): number

Returns an outline alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getOutlineAlpha

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:642

---

getOutlineColor

▸ getOutlineColor(state): null | number

Returns an outline color. If the color is null, outlines are not be rendered.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

null | number

Inherited from

DThemeButton.getOutlineColor

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:635

---

getOutlineMask

▸ getOutlineMask(state): number

Returns an outline mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getOutlineMask

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:670

---

getOutlineOffset

▸ getOutlineOffset(state): number

Returns an outline offset.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getOutlineOffset

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:656

---

getOutlineWidth

▸ getOutlineWidth(state): number

Returns an outline width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

DThemeButton.getOutlineWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:649

---

getPaddingBottom

▸ getPaddingBottom(): number

Returns a bottom padding.

Returns

number

Inherited from

DThemeButton.getPaddingBottom

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:617

---

getPaddingLeft

▸ getPaddingLeft(): number

Returns a left padding.

Returns

number

Inherited from

DThemeButton.getPaddingLeft

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:602

---

getPaddingRight

▸ getPaddingRight(): number

Returns a right padding.

Returns

number

Inherited from

DThemeButton.getPaddingRight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:607

---

getPaddingTop

▸ getPaddingTop(): number

Returns a top padding.

Returns

number

Inherited from

DThemeButton.getPaddingTop

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:612

---

getSecondaryImageAlignHorizontal

▸ getSecondaryImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Inherited from

DThemeButton.getSecondaryImageAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:9

---

getSecondaryImageAlignVertical

▸ getSecondaryImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Inherited from

DThemeButton.getSecondaryImageAlignVertical

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:10

---

getSecondaryImageAlignWith

▸ getSecondaryImageAlignWith(): DAlignWith

Returns

DAlignWith

Inherited from

DThemeButton.getSecondaryImageAlignWith

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:11

---

getSecondaryImageMarginHorizontal

▸ getSecondaryImageMarginHorizontal(): number

Returns

number

Inherited from

DThemeButton.getSecondaryImageMarginHorizontal

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:12

---

getSecondaryImageMarginVertial

▸ getSecondaryImageMarginVertial(): number

Returns

number

Inherited from

DThemeButton.getSecondaryImageMarginVertial

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:13

---

getSecondaryImageRotation

▸ getSecondaryImageRotation(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeButton.getSecondaryImageRotation

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:16

---

getSecondaryImageSource

▸ getSecondaryImageSource(state): null | DisplayObject | Texture

Parameters

Name	Type
state	DBaseStateSet

Returns

null | DisplayObject | Texture

Inherited from

DThemeButton.getSecondaryImageSource

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:17

---

getSecondaryImageTintAlpha

▸ getSecondaryImageTintAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeButton.getSecondaryImageTintAlpha

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:15

---

getSecondaryImageTintColor

▸ getSecondaryImageTintColor(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Inherited from

DThemeButton.getSecondaryImageTintColor

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-secondary.ts:14

---

getShadow

▸ getShadow(): null | DShadow

Returns a shadow. If a shadow is null, no shadow is rendered.

Returns

null | DShadow

Inherited from

DThemeButton.getShadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:676

---

getTertiaryImageAlignHorizontal

▸ getTertiaryImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Inherited from

DThemeButton.getTertiaryImageAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:9

---

getTertiaryImageAlignVertical

▸ getTertiaryImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Inherited from

DThemeButton.getTertiaryImageAlignVertical

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:10

---

getTertiaryImageAlignWith

▸ getTertiaryImageAlignWith(): DAlignWith

Returns

DAlignWith

Inherited from

DThemeButton.getTertiaryImageAlignWith

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:11

---

getTertiaryImageMarginHorizontal

▸ getTertiaryImageMarginHorizontal(): number

Returns

number

Inherited from

DThemeButton.getTertiaryImageMarginHorizontal

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:12

---

getTertiaryImageMarginVertial

▸ getTertiaryImageMarginVertial(): number

Returns

number

Inherited from

DThemeButton.getTertiaryImageMarginVertial

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:13

---

getTertiaryImageRotation

▸ getTertiaryImageRotation(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeButton.getTertiaryImageRotation

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:16

---

getTertiaryImageSource

▸ getTertiaryImageSource(state): null | DisplayObject | Texture

Parameters

Name	Type
state	DBaseStateSet

Returns

null | DisplayObject | Texture

Inherited from

DThemeButton.getTertiaryImageSource

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:17

---

getTertiaryImageTintAlpha

▸ getTertiaryImageTintAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeButton.getTertiaryImageTintAlpha

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:15

---

getTertiaryImageTintColor

▸ getTertiaryImageTintColor(state): null | number

Parameters

Name	Type
state	DBaseStateSet

Returns

null | number

Inherited from

DThemeButton.getTertiaryImageTintColor

Defined in

src/main/typescript/wcardinal/ui/d-image-base-theme-wrapper-tertiary.ts:14

---

getTextAlignHorizontal

▸ getTextAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Inherited from

DThemeButton.getTextAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:46

---

getTextAlignVertical

▸ getTextAlignVertical(): DAlignVertical

Returns

DAlignVertical

Inherited from

DThemeButton.getTextAlignVertical

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:45

---

getTextFormatter

▸ getTextFormatter(): DTextPieceFormatter<string>

Returns

DTextPieceFormatter<string>

Inherited from

DThemeButton.getTextFormatter

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:29

---

getTextStyleClipping

▸ getTextStyleClipping(): boolean

Returns

boolean

Inherited from

DThemeButton.getTextStyleClipping

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:47

---

getTextStyleFitting

▸ getTextStyleFitting(): boolean

Returns

boolean

Inherited from

DThemeButton.getTextStyleFitting

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:48

---

getTextStyleWordWrap

▸ getTextStyleWordWrap(): DDynamicTextStyleWordWrap

Returns

DDynamicTextStyleWordWrap

Inherited from

DThemeButton.getTextStyleWordWrap

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:49

---

getTextValue

▸ getTextValue(state): undefined | string

Returns a text value. Called to get a text vale if there is no text value.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

undefined | string

Inherited from

DThemeButton.getTextValue

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:43

---

getTitle

▸ getTitle(): string

Returns a tooltip text.

Returns

string

Inherited from

DThemeButton.getTitle

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:691

---

getWeight

▸ getWeight(): number

Returns a weight. Weights are for layout classes including DLayoutVertical. If a weight is less than or equals to zero, layout classes are supposed not to change a width / height.

Returns

number

Inherited from

DThemeButton.getWeight

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:704

---

getWhen

▸ getWhen(): DButtonBaseWhen

Returns when to activate a button.

Returns

DButtonBaseWhen

Inherited from

DThemeButton.getWhen

Defined in

src/main/typescript/wcardinal/ui/d-button-base.ts:98

---

getWidth

▸ getWidth(): DCoordinateSize

Returns a width.

Returns

DCoordinateSize

Inherited from

DThemeButton.getWidth

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:536

---

getX

▸ getX(): DCoordinatePosition

Returns a X coordinate.

Returns

DCoordinatePosition

Inherited from

DThemeButton.getX

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:521

---

getY

▸ getY(): DCoordinatePosition

Returns a Y coordinate.

Returns

DCoordinatePosition

Inherited from

DThemeButton.getY

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:526

---

isOverflowMaskEnabled

▸ isOverflowMaskEnabled(): boolean

Returns

boolean

Inherited from

DThemeButton.isOverflowMaskEnabled

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:50

---

isToggle

▸ isToggle(): boolean

Returns true to turn a toggle mode on.

Returns

boolean

Inherited from

DThemeButton.isToggle

Defined in

src/main/typescript/wcardinal/ui/d-button-base.ts:93

---

newShadow

▸ newShadow(): null | DShadow

Creates a new shadow.

Returns

null | DShadow

Inherited from

DThemeButton.newShadow

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:709

---

newShadowWeak

▸ newShadowWeak(): null | DShadow

Creates a new weak shadow.

Returns

null | DShadow

Inherited from

DThemeButton.newShadowWeak

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:714

---

newState

▸ newState(state): void

Returns true if focusable.

Parameters

Name	Type
state	DBaseStateSet

Returns

void

Inherited from

DThemeButton.newState

Defined in

src/main/typescript/wcardinal/ui/d-base.ts:686

---

newTextValue

▸ newTextValue(): DStateAwareOrValueMightBe<string>

Returns a new text value. Called to initialize a text value if a text value is not given.

Returns

DStateAwareOrValueMightBe<string>

Inherited from

DThemeButton.newTextValue

Defined in

src/main/typescript/wcardinal/ui/d-text-piece.ts:35

Edit this page.