Winter Cardinal UI - v0.442.0 / DThemeDarkTextBase

Class: DThemeDarkTextBase<VALUE>

DTextBase theme.

Type parameters

Name	Type
VALUE	unknown

Hierarchy

• DThemeDarkBase

  ↳ DThemeDarkTextBase

  ↳↳ DThemeDarkImageBase

  ↳↳ DThemeDarkSliderLabel

  ↳↳ DThemeDarkSliderValue

  ↳↳ DThemeDarkText

Implements

• DThemeTextBase<VALUE>

Table of contents

Constructors

• constructor

Methods

• getAlpha
• getBackgroundAlpha
• getBackgroundColor
• getBackgroundTexture
• getBorderAlign
• getBorderAlpha
• getBorderColor
• getBorderMask
• getBorderTexture
• getBorderWidth
• getClearType
• getColor
• getCornerMask
• getCornerRadius
• getCursor
• getFontFamilly
• getFontSize
• getFontStyle
• getFontVariant
• getFontWeight
• getHeight
• getInteractive
• getLineHeight
• getOutlineAlign
• getOutlineAlpha
• getOutlineColor
• getOutlineMask
• getOutlineOffset
• getOutlineWidth
• getPaddingBottom
• getPaddingLeft
• getPaddingRight
• getPaddingTop
• getShadow
• getTextAlignHorizontal
• getTextAlignVertical
• getTextFormatter
• getTextStyleClipping
• getTextStyleFitting
• getTextStyleWordWrap
• getTextValue
• getTitle
• getWeight
• getWidth
• getX
• getY
• isOverflowMaskEnabled
• newShadow
• newShadowWeak
• newState
• newTextValue

Constructors

constructor

• new DThemeDarkTextBase<VALUE>(): DThemeDarkTextBase<VALUE>

Type parameters

Name	Type
VALUE	unknown

Returns

DThemeDarkTextBase<VALUE>

Inherited from

DThemeDarkBase.constructor

Methods

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeTextBase.getAlpha

Inherited from

DThemeDarkBase.getAlpha

Defined in

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

---

getBackgroundAlpha

▸ getBackgroundAlpha(state): number

Returns a background alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getBackgroundAlpha

Inherited from

DThemeDarkBase.getBackgroundAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:84

---

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

Implementation of

DThemeTextBase.getBackgroundColor

Inherited from

DThemeDarkBase.getBackgroundColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:80

---

getBackgroundTexture

▸ getBackgroundTexture(): Texture

Returns a background texture.

Returns

Texture

Implementation of

DThemeTextBase.getBackgroundTexture

Inherited from

DThemeDarkBase.getBackgroundTexture

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:88

---

getBorderAlign

▸ getBorderAlign(state): number

Returns a border align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getBorderAlign

Inherited from

DThemeDarkBase.getBorderAlign

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:104

---

getBorderAlpha

▸ getBorderAlpha(state): number

Returns a border alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getBorderAlpha

Inherited from

DThemeDarkBase.getBorderAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:96

---

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

Implementation of

DThemeTextBase.getBorderColor

Inherited from

DThemeDarkBase.getBorderColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:92

---

getBorderMask

▸ getBorderMask(state): number

Returns a border mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a mask

Returns

number

Implementation of

DThemeTextBase.getBorderMask

Inherited from

DThemeDarkBase.getBorderMask

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:108

---

getBorderTexture

▸ getBorderTexture(): Texture

Returns a border texture.

Returns

Texture

Implementation of

DThemeTextBase.getBorderTexture

Inherited from

DThemeDarkBase.getBorderTexture

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:112

---

getBorderWidth

▸ getBorderWidth(state): number

Returns a border width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getBorderWidth

Inherited from

DThemeDarkBase.getBorderWidth

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:100

---

getClearType

▸ getClearType(): number

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

Returns

number

Implementation of

DThemeTextBase.getClearType

Inherited from

DThemeDarkBase.getClearType

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:167

---

getColor

▸ getColor(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeTextBase.getColor

Inherited from

DThemeDarkBase.getColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:19

---

getCornerMask

▸ getCornerMask(): number

Returns a corner mask.

Returns

number

Implementation of

DThemeTextBase.getCornerMask

Inherited from

DThemeDarkBase.getCornerMask

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:136

---

getCornerRadius

▸ getCornerRadius(): number

Returns a corner radius.

Returns

number

Implementation of

DThemeTextBase.getCornerRadius

Inherited from

DThemeDarkBase.getCornerRadius

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:132

---

getCursor

▸ getCursor(state): string

Returns a cursor.

Parameters

Name	Type
state	DBaseStateSet

Returns

string

Implementation of

DThemeTextBase.getCursor

Inherited from

DThemeDarkBase.getCursor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:199

---

getFontFamilly

▸ getFontFamilly(): string

Returns

string

Implementation of

DThemeTextBase.getFontFamilly

Inherited from

DThemeDarkBase.getFontFamilly

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:11

---

getFontSize

▸ getFontSize(): number

Returns

number

Implementation of

DThemeTextBase.getFontSize

Inherited from

DThemeDarkBase.getFontSize

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:15

---

getFontStyle

▸ getFontStyle(): DFontStyle

Returns

DFontStyle

Implementation of

DThemeTextBase.getFontStyle

Inherited from

DThemeDarkBase.getFontStyle

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:27

---

getFontVariant

▸ getFontVariant(): DFontVariant

Returns

DFontVariant

Implementation of

DThemeTextBase.getFontVariant

Inherited from

DThemeDarkBase.getFontVariant

Defined in

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

---

getFontWeight

▸ getFontWeight(): DFontWeight

Returns

DFontWeight

Implementation of

DThemeTextBase.getFontWeight

Inherited from

DThemeDarkBase.getFontWeight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:23

---

getHeight

▸ getHeight(): DCoordinateSize

Returns a height.

Returns

DCoordinateSize

Implementation of

DThemeTextBase.getHeight

Inherited from

DThemeDarkBase.getHeight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:72

---

getInteractive

▸ getInteractive(): number

Returns an interactivity.

Returns

number

Implementation of

DThemeTextBase.getInteractive

Inherited from

DThemeDarkBase.getInteractive

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:175

---

getLineHeight

▸ getLineHeight(): number

Returns

number

Implementation of

DThemeTextBase.getLineHeight

Inherited from

DThemeDarkBase.getLineHeight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:42

---

getOutlineAlign

▸ getOutlineAlign(state): number

Returns an outline align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getOutlineAlign

Inherited from

DThemeDarkBase.getOutlineAlign

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:159

---

getOutlineAlpha

▸ getOutlineAlpha(state): number

Returns an outline alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getOutlineAlpha

Inherited from

DThemeDarkBase.getOutlineAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:144

---

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

Implementation of

DThemeTextBase.getOutlineColor

Inherited from

DThemeDarkBase.getOutlineColor

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:140

---

getOutlineMask

▸ getOutlineMask(state): number

Returns an outline mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getOutlineMask

Inherited from

DThemeDarkBase.getOutlineMask

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:163

---

getOutlineOffset

▸ getOutlineOffset(state): number

Returns an outline offset.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getOutlineOffset

Inherited from

DThemeDarkBase.getOutlineOffset

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:155

---

getOutlineWidth

▸ getOutlineWidth(state): number

Returns an outline width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeTextBase.getOutlineWidth

Inherited from

DThemeDarkBase.getOutlineWidth

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:151

---

getPaddingBottom

▸ getPaddingBottom(): number

Returns a bottom padding.

Returns

number

Implementation of

DThemeTextBase.getPaddingBottom

Inherited from

DThemeDarkBase.getPaddingBottom

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:128

---

getPaddingLeft

▸ getPaddingLeft(): number

Returns a left padding.

Returns

number

Implementation of

DThemeTextBase.getPaddingLeft

Inherited from

DThemeDarkBase.getPaddingLeft

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:116

---

getPaddingRight

▸ getPaddingRight(): number

Returns a right padding.

Returns

number

Implementation of

DThemeTextBase.getPaddingRight

Inherited from

DThemeDarkBase.getPaddingRight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:120

---

getPaddingTop

▸ getPaddingTop(): number

Returns a top padding.

Returns

number

Implementation of

DThemeTextBase.getPaddingTop

Inherited from

DThemeDarkBase.getPaddingTop

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:124

---

getShadow

▸ getShadow(): null | DShadow

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

Returns

null | DShadow

Implementation of

DThemeTextBase.getShadow

Inherited from

DThemeDarkBase.getShadow

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:171

---

getTextAlignHorizontal

▸ getTextAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Implementation of

DThemeTextBase.getTextAlignHorizontal

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:23

---

getTextAlignVertical

▸ getTextAlignVertical(): DAlignVertical

Returns

DAlignVertical

Implementation of

DThemeTextBase.getTextAlignVertical

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:19

---

getTextFormatter

▸ getTextFormatter(): (value: VALUE, caller: any) => string

Returns

fn

▸ (value, caller): string

Parameters

Name	Type
value	VALUE
caller	any

Returns

string

Implementation of

DThemeTextBase.getTextFormatter

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:43

---

getTextStyleClipping

▸ getTextStyleClipping(): boolean

Returns

boolean

Implementation of

DThemeTextBase.getTextStyleClipping

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:31

---

getTextStyleFitting

▸ getTextStyleFitting(): boolean

Returns

boolean

Implementation of

DThemeTextBase.getTextStyleFitting

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:35

---

getTextStyleWordWrap

▸ getTextStyleWordWrap(): DDynamicTextStyleWordWrap

Returns

DDynamicTextStyleWordWrap

Implementation of

DThemeTextBase.getTextStyleWordWrap

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:39

---

getTextValue

▸ getTextValue(state): undefined | VALUE

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 | VALUE

Implementation of

DThemeTextBase.getTextValue

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:47

---

getTitle

▸ getTitle(): string

Returns a tooltip text.

Returns

string

Implementation of

DThemeTextBase.getTitle

Inherited from

DThemeDarkBase.getTitle

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:183

---

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

Implementation of

DThemeTextBase.getWeight

Inherited from

DThemeDarkBase.getWeight

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:187

---

getWidth

▸ getWidth(): DCoordinateSize

Returns a width.

Returns

DCoordinateSize

Implementation of

DThemeTextBase.getWidth

Inherited from

DThemeDarkBase.getWidth

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:76

---

getX

▸ getX(): DCoordinatePosition

Returns a X coordinate.

Returns

DCoordinatePosition

Implementation of

DThemeTextBase.getX

Inherited from

DThemeDarkBase.getX

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:64

---

getY

▸ getY(): DCoordinatePosition

Returns a Y coordinate.

Returns

DCoordinatePosition

Implementation of

DThemeTextBase.getY

Inherited from

DThemeDarkBase.getY

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:68

---

isOverflowMaskEnabled

▸ isOverflowMaskEnabled(): boolean

Returns

boolean

Implementation of

DThemeTextBase.isOverflowMaskEnabled

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:27

---

newShadow

▸ newShadow(): null | DShadow

Creates a new shadow.

Returns

null | DShadow

Implementation of

DThemeTextBase.newShadow

Inherited from

DThemeDarkBase.newShadow

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:191

---

newShadowWeak

▸ newShadowWeak(): null | DShadow

Creates a new weak shadow.

Returns

null | DShadow

Implementation of

DThemeTextBase.newShadowWeak

Inherited from

DThemeDarkBase.newShadowWeak

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:195

---

newState

▸ newState(state): void

Returns true if focusable.

Parameters

Name	Type
state	DBaseStateSet

Returns

void

Implementation of

DThemeTextBase.newState

Inherited from

DThemeDarkBase.newState

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:179

---

newTextValue

▸ newTextValue(): DStateAwareOrValueMightBe<VALUE>

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

Returns

DStateAwareOrValueMightBe<VALUE>

Implementation of

DThemeTextBase.newTextValue

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:51

Edit this page.