Winter Cardinal UI - v0.442.0 / DThemeWhiteLayoutVertical

Class: DThemeWhiteLayoutVertical

DBase theme.

Hierarchy

• DThemeWhiteLayout

  ↳ DThemeWhiteLayoutVertical

  ↳↳ DThemeWhiteDialogLayeredContent

  ↳↳ DThemeWhiteExpandable

  ↳↳ DThemeWhiteMenuItemExpandableBody

  ↳↳ DThemeWhiteMenuItemExpandable

  ↳↳ DThemeWhiteMenuSidedContent

  ↳↳ DThemeWhiteMenu

Implements

• DThemeLayoutVertical

Table of contents

Constructors

• constructor

Methods

• getAlpha
• getBackgroundAlpha
• getBackgroundColor
• getBackgroundTexture
• getBorderAlign
• getBorderAlpha
• getBorderColor
• getBorderMask
• getBorderTexture
• getBorderWidth
• getClearType
• getColor
• getCornerAdjust
• getCornerMask
• getCornerRadius
• getCursor
• getDirection
• getFontFamilly
• getFontSize
• getFontStyle
• getFontVariant
• getFontWeight
• getHeight
• getInteractive
• getLineHeight
• getMargin
• getMultiplicity
• getOutlineAlign
• getOutlineAlpha
• getOutlineColor
• getOutlineMask
• getOutlineOffset
• getOutlineWidth
• getPaddingBottom
• getPaddingLeft
• getPaddingRight
• getPaddingTop
• getReverse
• getShadow
• getTitle
• getWeight
• getWidth
• getX
• getY
• newShadow
• newShadowWeak
• newState

Constructors

constructor

• new DThemeWhiteLayoutVertical(): DThemeWhiteLayoutVertical

Returns

DThemeWhiteLayoutVertical

Inherited from

DThemeWhiteLayout.constructor

Methods

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeLayoutVertical.getAlpha

Inherited from

DThemeWhiteLayout.getAlpha

Defined in

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

---

getBackgroundAlpha

▸ getBackgroundAlpha(state): number

Returns a background alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getBackgroundAlpha

Inherited from

DThemeWhiteLayout.getBackgroundAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-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

DThemeLayoutVertical.getBackgroundColor

Inherited from

DThemeWhiteLayout.getBackgroundColor

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout.ts:13

---

getBackgroundTexture

▸ getBackgroundTexture(): Texture

Returns a background texture.

Returns

Texture

Implementation of

DThemeLayoutVertical.getBackgroundTexture

Inherited from

DThemeWhiteLayout.getBackgroundTexture

Defined in

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

---

getBorderAlign

▸ getBorderAlign(state): number

Returns a border align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getBorderAlign

Inherited from

DThemeWhiteLayout.getBorderAlign

Defined in

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

---

getBorderAlpha

▸ getBorderAlpha(state): number

Returns a border alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getBorderAlpha

Inherited from

DThemeWhiteLayout.getBorderAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-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

DThemeLayoutVertical.getBorderColor

Inherited from

DThemeWhiteLayout.getBorderColor

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout.ts:17

---

getBorderMask

▸ getBorderMask(state): number

Returns a border mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a mask

Returns

number

Implementation of

DThemeLayoutVertical.getBorderMask

Inherited from

DThemeWhiteLayout.getBorderMask

Defined in

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

---

getBorderTexture

▸ getBorderTexture(): Texture

Returns a border texture.

Returns

Texture

Implementation of

DThemeLayoutVertical.getBorderTexture

Inherited from

DThemeWhiteLayout.getBorderTexture

Defined in

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

---

getBorderWidth

▸ getBorderWidth(state): number

Returns a border width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getBorderWidth

Inherited from

DThemeWhiteLayout.getBorderWidth

Defined in

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

---

getClearType

▸ getClearType(): number

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

Returns

number

Implementation of

DThemeLayoutVertical.getClearType

Inherited from

DThemeWhiteLayout.getClearType

Defined in

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

---

getColor

▸ getColor(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeLayoutVertical.getColor

Inherited from

DThemeWhiteLayout.getColor

Defined in

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

---

getCornerAdjust

▸ getCornerAdjust(): boolean

Returns

boolean

Implementation of

DThemeLayoutVertical.getCornerAdjust

Inherited from

DThemeWhiteLayout.getCornerAdjust

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout.ts:38

---

getCornerMask

▸ getCornerMask(): number

Returns a corner mask.

Returns

number

Implementation of

DThemeLayoutVertical.getCornerMask

Inherited from

DThemeWhiteLayout.getCornerMask

Defined in

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

---

getCornerRadius

▸ getCornerRadius(): number

Returns a corner radius.

Returns

number

Implementation of

DThemeLayoutVertical.getCornerRadius

Inherited from

DThemeWhiteLayout.getCornerRadius

Defined in

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

---

getCursor

▸ getCursor(state): string

Returns a cursor.

Parameters

Name	Type
state	DBaseStateSet

Returns

string

Implementation of

DThemeLayoutVertical.getCursor

Inherited from

DThemeWhiteLayout.getCursor

Defined in

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

---

getDirection

▸ getDirection(): DLayoutDirection

Returns

DLayoutDirection

Implementation of

DThemeLayoutVertical.getDirection

Overrides

DThemeWhiteLayout.getDirection

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout-vertical.ts:12

---

getFontFamilly

▸ getFontFamilly(): string

Returns

string

Implementation of

DThemeLayoutVertical.getFontFamilly

Inherited from

DThemeWhiteLayout.getFontFamilly

Defined in

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

---

getFontSize

▸ getFontSize(): number

Returns

number

Implementation of

DThemeLayoutVertical.getFontSize

Inherited from

DThemeWhiteLayout.getFontSize

Defined in

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

---

getFontStyle

▸ getFontStyle(): DFontStyle

Returns

DFontStyle

Implementation of

DThemeLayoutVertical.getFontStyle

Inherited from

DThemeWhiteLayout.getFontStyle

Defined in

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

---

getFontVariant

▸ getFontVariant(): DFontVariant

Returns

DFontVariant

Implementation of

DThemeLayoutVertical.getFontVariant

Inherited from

DThemeWhiteLayout.getFontVariant

Defined in

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

---

getFontWeight

▸ getFontWeight(): DFontWeight

Returns

DFontWeight

Implementation of

DThemeLayoutVertical.getFontWeight

Inherited from

DThemeWhiteLayout.getFontWeight

Defined in

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

---

getHeight

▸ getHeight(): DCoordinateSize

Returns a height.

Returns

DCoordinateSize

Implementation of

DThemeLayoutVertical.getHeight

Inherited from

DThemeWhiteLayout.getHeight

Defined in

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

---

getInteractive

▸ getInteractive(): number

Returns an interactivity.

Returns

number

Implementation of

DThemeLayoutVertical.getInteractive

Inherited from

DThemeWhiteLayout.getInteractive

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout.ts:25

---

getLineHeight

▸ getLineHeight(): number

Returns

number

Implementation of

DThemeLayoutVertical.getLineHeight

Inherited from

DThemeWhiteLayout.getLineHeight

Defined in

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

---

getMargin

▸ getMargin(): number

Returns

number

Implementation of

DThemeLayoutVertical.getMargin

Inherited from

DThemeWhiteLayout.getMargin

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout.ts:21

---

getMultiplicity

▸ getMultiplicity(): number

Returns

number

Implementation of

DThemeLayoutVertical.getMultiplicity

Inherited from

DThemeWhiteLayout.getMultiplicity

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout.ts:42

---

getOutlineAlign

▸ getOutlineAlign(state): number

Returns an outline align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getOutlineAlign

Inherited from

DThemeWhiteLayout.getOutlineAlign

Defined in

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

---

getOutlineAlpha

▸ getOutlineAlpha(state): number

Returns an outline alpha.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getOutlineAlpha

Inherited from

DThemeWhiteLayout.getOutlineAlpha

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-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

DThemeLayoutVertical.getOutlineColor

Inherited from

DThemeWhiteLayout.getOutlineColor

Defined in

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

---

getOutlineMask

▸ getOutlineMask(state): number

Returns an outline mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getOutlineMask

Inherited from

DThemeWhiteLayout.getOutlineMask

Defined in

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

---

getOutlineOffset

▸ getOutlineOffset(state): number

Returns an outline offset.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getOutlineOffset

Inherited from

DThemeWhiteLayout.getOutlineOffset

Defined in

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

---

getOutlineWidth

▸ getOutlineWidth(state): number

Returns an outline width.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeLayoutVertical.getOutlineWidth

Inherited from

DThemeWhiteLayout.getOutlineWidth

Defined in

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

---

getPaddingBottom

▸ getPaddingBottom(): number

Returns a bottom padding.

Returns

number

Implementation of

DThemeLayoutVertical.getPaddingBottom

Inherited from

DThemeWhiteLayout.getPaddingBottom

Defined in

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

---

getPaddingLeft

▸ getPaddingLeft(): number

Returns a left padding.

Returns

number

Implementation of

DThemeLayoutVertical.getPaddingLeft

Inherited from

DThemeWhiteLayout.getPaddingLeft

Defined in

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

---

getPaddingRight

▸ getPaddingRight(): number

Returns a right padding.

Returns

number

Implementation of

DThemeLayoutVertical.getPaddingRight

Inherited from

DThemeWhiteLayout.getPaddingRight

Defined in

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

---

getPaddingTop

▸ getPaddingTop(): number

Returns a top padding.

Returns

number

Implementation of

DThemeLayoutVertical.getPaddingTop

Inherited from

DThemeWhiteLayout.getPaddingTop

Defined in

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

---

getReverse

▸ getReverse(): boolean

Returns

boolean

Implementation of

DThemeLayoutVertical.getReverse

Inherited from

DThemeWhiteLayout.getReverse

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout.ts:46

---

getShadow

▸ getShadow(): null | DShadow

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

Returns

null | DShadow

Implementation of

DThemeLayoutVertical.getShadow

Inherited from

DThemeWhiteLayout.getShadow

Defined in

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

---

getTitle

▸ getTitle(): string

Returns a tooltip text.

Returns

string

Implementation of

DThemeLayoutVertical.getTitle

Inherited from

DThemeWhiteLayout.getTitle

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-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

DThemeLayoutVertical.getWeight

Inherited from

DThemeWhiteLayout.getWeight

Defined in

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

---

getWidth

▸ getWidth(): DCoordinateSize

Returns a width.

Returns

DCoordinateSize

Implementation of

DThemeLayoutVertical.getWidth

Overrides

DThemeWhiteLayout.getWidth

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout-vertical.ts:16

---

getX

▸ getX(): DCoordinatePosition

Returns a X coordinate.

Returns

DCoordinatePosition

Implementation of

DThemeLayoutVertical.getX

Inherited from

DThemeWhiteLayout.getX

Defined in

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

---

getY

▸ getY(): DCoordinatePosition

Returns a Y coordinate.

Returns

DCoordinatePosition

Implementation of

DThemeLayoutVertical.getY

Inherited from

DThemeWhiteLayout.getY

Defined in

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

---

newShadow

▸ newShadow(): null | DShadow

Creates a new shadow.

Returns

null | DShadow

Implementation of

DThemeLayoutVertical.newShadow

Inherited from

DThemeWhiteLayout.newShadow

Defined in

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

---

newShadowWeak

▸ newShadowWeak(): null | DShadow

Creates a new weak shadow.

Returns

null | DShadow

Implementation of

DThemeLayoutVertical.newShadowWeak

Inherited from

DThemeWhiteLayout.newShadowWeak

Defined in

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

---

newState

▸ newState(state): void

Returns true if focusable.

Parameters

Name	Type
state	DBaseStateSet

Returns

void

Implementation of

DThemeLayoutVertical.newState

Inherited from

DThemeWhiteLayout.newState

Defined in

src/main/typescript/wcardinal/ui/theme/white/d-theme-white-layout.ts:29

Edit this page.