Winter Cardinal UI - v0.442.0 / DThemeDarkMenu

Class: DThemeDarkMenu

DBase theme.

Hierarchy

• DThemeDarkLayoutVertical

  ↳ DThemeDarkMenu

Implements

• DThemeMenu

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
• getOffsetX
• getOffsetY
• getOutlineAlign
• getOutlineAlpha
• getOutlineColor
• getOutlineMask
• getOutlineOffset
• getOutlineWidth
• getPaddingBottom
• getPaddingLeft
• getPaddingRight
• getPaddingTop
• getReverse
• getShadow
• getTitle
• getWeight
• getWidth
• getX
• getY
• newShadow
• newShadowWeak
• newState

Constructors

constructor

• new DThemeDarkMenu(): DThemeDarkMenu

Returns

DThemeDarkMenu

Inherited from

DThemeDarkLayoutVertical.constructor

Methods

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Implementation of

DThemeMenu.getAlpha

Inherited from

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

DThemeMenu.getBackgroundAlpha

Inherited from

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

DThemeMenu.getBackgroundColor

Overrides

DThemeDarkLayoutVertical.getBackgroundColor

Defined in

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

---

getBackgroundTexture

▸ getBackgroundTexture(): Texture

Returns a background texture.

Returns

Texture

Implementation of

DThemeMenu.getBackgroundTexture

Inherited from

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

DThemeMenu.getBorderAlign

Inherited from

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

DThemeMenu.getBorderAlpha

Inherited from

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

DThemeMenu.getBorderColor

Inherited from

DThemeDarkLayoutVertical.getBorderColor

Defined in

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

---

getBorderMask

▸ getBorderMask(state): number

Returns a border mask.

Parameters

Name	Type	Description
state	DBaseStateSet	a mask

Returns

number

Implementation of

DThemeMenu.getBorderMask

Inherited from

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

DThemeMenu.getBorderTexture

Inherited from

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

DThemeMenu.getBorderWidth

Inherited from

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

DThemeMenu.getClearType

Inherited from

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

DThemeMenu.getColor

Inherited from

DThemeDarkLayoutVertical.getColor

Defined in

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

---

getCornerAdjust

▸ getCornerAdjust(): boolean

Returns

boolean

Implementation of

DThemeMenu.getCornerAdjust

Inherited from

DThemeDarkLayoutVertical.getCornerAdjust

Defined in

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

---

getCornerMask

▸ getCornerMask(): number

Returns a corner mask.

Returns

number

Implementation of

DThemeMenu.getCornerMask

Inherited from

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

DThemeMenu.getCornerRadius

Inherited from

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

DThemeMenu.getCursor

Inherited from

DThemeDarkLayoutVertical.getCursor

Defined in

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

---

getDirection

▸ getDirection(): DLayoutDirection

Returns

DLayoutDirection

Implementation of

DThemeMenu.getDirection

Inherited from

DThemeDarkLayoutVertical.getDirection

Defined in

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

---

getFontFamilly

▸ getFontFamilly(): string

Returns

string

Implementation of

DThemeMenu.getFontFamilly

Inherited from

DThemeDarkLayoutVertical.getFontFamilly

Defined in

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

---

getFontSize

▸ getFontSize(): number

Returns

number

Implementation of

DThemeMenu.getFontSize

Inherited from

DThemeDarkLayoutVertical.getFontSize

Defined in

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

---

getFontStyle

▸ getFontStyle(): DFontStyle

Returns

DFontStyle

Implementation of

DThemeMenu.getFontStyle

Inherited from

DThemeDarkLayoutVertical.getFontStyle

Defined in

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

---

getFontVariant

▸ getFontVariant(): DFontVariant

Returns

DFontVariant

Implementation of

DThemeMenu.getFontVariant

Inherited from

DThemeDarkLayoutVertical.getFontVariant

Defined in

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

---

getFontWeight

▸ getFontWeight(): DFontWeight

Returns

DFontWeight

Implementation of

DThemeMenu.getFontWeight

Inherited from

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

DThemeMenu.getHeight

Overrides

DThemeDarkLayoutVertical.getHeight

Defined in

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

---

getInteractive

▸ getInteractive(): number

Returns an interactivity.

Returns

number

Implementation of

DThemeMenu.getInteractive

Overrides

DThemeDarkLayoutVertical.getInteractive

Defined in

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

---

getLineHeight

▸ getLineHeight(): number

Returns

number

Implementation of

DThemeMenu.getLineHeight

Inherited from

DThemeDarkLayoutVertical.getLineHeight

Defined in

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

---

getMargin

▸ getMargin(): number

Returns

number

Implementation of

DThemeMenu.getMargin

Overrides

DThemeDarkLayoutVertical.getMargin

Defined in

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

---

getMultiplicity

▸ getMultiplicity(): number

Returns

number

Implementation of

DThemeMenu.getMultiplicity

Inherited from

DThemeDarkLayoutVertical.getMultiplicity

Defined in

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

---

getOffsetX

▸ getOffsetX(): number

Returns

number

Implementation of

DThemeMenu.getOffsetX

Defined in

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

---

getOffsetY

▸ getOffsetY(): number

Returns

number

Implementation of

DThemeMenu.getOffsetY

Defined in

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

---

getOutlineAlign

▸ getOutlineAlign(state): number

Returns an outline align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Implementation of

DThemeMenu.getOutlineAlign

Inherited from

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

DThemeMenu.getOutlineAlpha

Inherited from

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

DThemeMenu.getOutlineColor

Inherited from

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

DThemeMenu.getOutlineMask

Inherited from

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

DThemeMenu.getOutlineOffset

Inherited from

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

DThemeMenu.getOutlineWidth

Inherited from

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

DThemeMenu.getPaddingBottom

Overrides

DThemeDarkLayoutVertical.getPaddingBottom

Defined in

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

---

getPaddingLeft

▸ getPaddingLeft(): number

Returns a left padding.

Returns

number

Implementation of

DThemeMenu.getPaddingLeft

Inherited from

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

DThemeMenu.getPaddingRight

Inherited from

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

DThemeMenu.getPaddingTop

Overrides

DThemeDarkLayoutVertical.getPaddingTop

Defined in

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

---

getReverse

▸ getReverse(): boolean

Returns

boolean

Implementation of

DThemeMenu.getReverse

Inherited from

DThemeDarkLayoutVertical.getReverse

Defined in

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

---

getShadow

▸ getShadow(): null | DShadow

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

Returns

null | DShadow

Implementation of

DThemeMenu.getShadow

Overrides

DThemeDarkLayoutVertical.getShadow

Defined in

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

---

getTitle

▸ getTitle(): string

Returns a tooltip text.

Returns

string

Implementation of

DThemeMenu.getTitle

Inherited from

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

DThemeMenu.getWeight

Inherited from

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

DThemeMenu.getWidth

Overrides

DThemeDarkLayoutVertical.getWidth

Defined in

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

---

getX

▸ getX(): DCoordinatePosition

Returns a X coordinate.

Returns

DCoordinatePosition

Implementation of

DThemeMenu.getX

Inherited from

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

DThemeMenu.getY

Inherited from

DThemeDarkLayoutVertical.getY

Defined in

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

---

newShadow

▸ newShadow(): null | DShadow

Creates a new shadow.

Returns

null | DShadow

Implementation of

DThemeMenu.newShadow

Inherited from

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

DThemeMenu.newShadowWeak

Inherited from

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

DThemeMenu.newState

Overrides

DThemeDarkLayoutVertical.newState

Defined in

src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-menu.ts:55

Edit this page.