Winter Cardinal UI - v0.442.0 / DThemeTextPiece

Interface: DThemeTextPiece<VALUE>

Type parameters

Name
VALUE

Hierarchy

• DThemeFont

  ↳ DThemeTextPiece

  ↳↳ DThemeTextBase

Table of contents

Methods

• getAlpha
• getColor
• getFontFamilly
• getFontSize
• getFontStyle
• getFontVariant
• getFontWeight
• getLineHeight
• getTextAlignHorizontal
• getTextAlignVertical
• getTextFormatter
• getTextStyleClipping
• getTextStyleFitting
• getTextStyleWordWrap
• getTextValue
• isOverflowMaskEnabled
• newTextValue

Methods

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeFont.getAlpha

Defined in

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

---

getColor

▸ getColor(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

DThemeFont.getColor

Defined in

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

---

getFontFamilly

▸ getFontFamilly(): string

Returns

string

Inherited from

DThemeFont.getFontFamilly

Defined in

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

---

getFontSize

▸ getFontSize(): number

Returns

number

Inherited from

DThemeFont.getFontSize

Defined in

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

---

getFontStyle

▸ getFontStyle(): DFontStyle

Returns

DFontStyle

Inherited from

DThemeFont.getFontStyle

Defined in

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

---

getFontVariant

▸ getFontVariant(): DFontVariant

Returns

DFontVariant

Inherited from

DThemeFont.getFontVariant

Defined in

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

---

getFontWeight

▸ getFontWeight(): DFontWeight

Returns

DFontWeight

Inherited from

DThemeFont.getFontWeight

Defined in

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

---

getLineHeight

▸ getLineHeight(): number

Returns

number

Inherited from

DThemeFont.getLineHeight

Defined in

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

---

getTextAlignHorizontal

▸ getTextAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Defined in

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

---

getTextAlignVertical

▸ getTextAlignVertical(): DAlignVertical

Returns

DAlignVertical

Defined in

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

---

getTextFormatter

▸ getTextFormatter(): DTextPieceFormatter<VALUE>

Returns

DTextPieceFormatter<VALUE>

Defined in

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

---

getTextStyleClipping

▸ getTextStyleClipping(): boolean

Returns

boolean

Defined in

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

---

getTextStyleFitting

▸ getTextStyleFitting(): boolean

Returns

boolean

Defined in

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

---

getTextStyleWordWrap

▸ getTextStyleWordWrap(): DDynamicTextStyleWordWrap

Returns

DDynamicTextStyleWordWrap

Defined in

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

---

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

Defined in

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

---

isOverflowMaskEnabled

▸ isOverflowMaskEnabled(): boolean

Returns

boolean

Defined in

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

---

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>

Defined in

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

Edit this page.