Winter Cardinal UI - v0.442.0 / DThemeMenuItemLink

Interface: DThemeMenuItemLink

DImageBase theme.

Hierarchy

Implemented by

Table of contents

Methods

Methods

getAlpha

getAlpha(state): number

Parameters

Name Type
state DBaseStateSet

Returns

number

Inherited from

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

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

DThemeMenuItemText.getBackgroundColor

Defined in

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


getBackgroundTexture

getBackgroundTexture(): Texture

Returns a background texture.

Returns

Texture

Inherited from

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

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

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

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

DThemeMenuItemText.getBorderMask

Defined in

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


getBorderTexture

getBorderTexture(): Texture

Returns a border texture.

Returns

Texture

Inherited from

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

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

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

DThemeMenuItemText.getColor

Defined in

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


getCornerMask

getCornerMask(): number

Returns a corner mask.

Returns

number

Inherited from

DThemeMenuItemText.getCornerMask

Defined in

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


getCornerRadius

getCornerRadius(): number

Returns a corner radius.

Returns

number

Inherited from

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

DThemeMenuItemText.getCursor

Defined in

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


getFontFamilly

getFontFamilly(): string

Returns

string

Inherited from

DThemeMenuItemText.getFontFamilly

Defined in

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


getFontSize

getFontSize(): number

Returns

number

Inherited from

DThemeMenuItemText.getFontSize

Defined in

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


getFontStyle

getFontStyle(): DFontStyle

Returns

DFontStyle

Inherited from

DThemeMenuItemText.getFontStyle

Defined in

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


getFontVariant

getFontVariant(): DFontVariant

Returns

DFontVariant

Inherited from

DThemeMenuItemText.getFontVariant

Defined in

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


getFontWeight

getFontWeight(): DFontWeight

Returns

DFontWeight

Inherited from

DThemeMenuItemText.getFontWeight

Defined in

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


getHeight

getHeight(): DCoordinateSize

Returns a height.

Returns

DCoordinateSize

Inherited from

DThemeMenuItemText.getHeight

Defined in

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


getImageAlignHorizontal

getImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Inherited from

DThemeMenuItemText.getImageAlignHorizontal

Defined in

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


getImageAlignVertical

getImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Inherited from

DThemeMenuItemText.getImageAlignVertical

Defined in

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


getImageAlignWith

getImageAlignWith(): DAlignWith

Returns

DAlignWith

Inherited from

DThemeMenuItemText.getImageAlignWith

Defined in

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


getImageMarginHorizontal

getImageMarginHorizontal(): number

Returns

number

Inherited from

DThemeMenuItemText.getImageMarginHorizontal

Defined in

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


getImageMarginVertial

getImageMarginVertial(): number

Returns

number

Inherited from

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

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

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

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

DThemeMenuItemText.getImageTintColor

Defined in

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


getInteractive

getInteractive(): number

Returns an interactivity.

Returns

number

Inherited from

DThemeMenuItemText.getInteractive

Defined in

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


getLineHeight

getLineHeight(): number

Returns

number

Inherited from

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

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

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

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

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

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

DThemeMenuItemText.getOutlineWidth

Defined in

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


getPaddingBottom

getPaddingBottom(): number

Returns a bottom padding.

Returns

number

Inherited from

DThemeMenuItemText.getPaddingBottom

Defined in

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


getPaddingLeft

getPaddingLeft(): number

Returns a left padding.

Returns

number

Inherited from

DThemeMenuItemText.getPaddingLeft

Defined in

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


getPaddingRight

getPaddingRight(): number

Returns a right padding.

Returns

number

Inherited from

DThemeMenuItemText.getPaddingRight

Defined in

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


getPaddingTop

getPaddingTop(): number

Returns a top padding.

Returns

number

Inherited from

DThemeMenuItemText.getPaddingTop

Defined in

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


getSecondaryImageAlignHorizontal

getSecondaryImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Inherited from

DThemeMenuItemText.getSecondaryImageAlignHorizontal

Defined in

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


getSecondaryImageAlignVertical

getSecondaryImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Inherited from

DThemeMenuItemText.getSecondaryImageAlignVertical

Defined in

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


getSecondaryImageAlignWith

getSecondaryImageAlignWith(): DAlignWith

Returns

DAlignWith

Inherited from

DThemeMenuItemText.getSecondaryImageAlignWith

Defined in

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


getSecondaryImageMarginHorizontal

getSecondaryImageMarginHorizontal(): number

Returns

number

Inherited from

DThemeMenuItemText.getSecondaryImageMarginHorizontal

Defined in

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


getSecondaryImageMarginVertial

getSecondaryImageMarginVertial(): number

Returns

number

Inherited from

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

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

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

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

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

DThemeMenuItemText.getShadow

Defined in

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


getShortcutAlpha

getShortcutAlpha(state): number

Parameters

Name Type
state DBaseStateSet

Returns

number

Inherited from

DThemeMenuItemText.getShortcutAlpha

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:23


getShortcutColor

getShortcutColor(state): number

Parameters

Name Type
state DBaseStateSet

Returns

number

Inherited from

DThemeMenuItemText.getShortcutColor

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:22


getShortcutTextMargin

getShortcutTextMargin(): number

Returns

number

Inherited from

DThemeMenuItemText.getShortcutTextMargin

Defined in

src/main/typescript/wcardinal/ui/d-menu-item-text.ts:21


getTertiaryImageAlignHorizontal

getTertiaryImageAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Inherited from

DThemeMenuItemText.getTertiaryImageAlignHorizontal

Defined in

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


getTertiaryImageAlignVertical

getTertiaryImageAlignVertical(): DAlignVertical

Returns

DAlignVertical

Inherited from

DThemeMenuItemText.getTertiaryImageAlignVertical

Defined in

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


getTertiaryImageAlignWith

getTertiaryImageAlignWith(): DAlignWith

Returns

DAlignWith

Inherited from

DThemeMenuItemText.getTertiaryImageAlignWith

Defined in

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


getTertiaryImageMarginHorizontal

getTertiaryImageMarginHorizontal(): number

Returns

number

Inherited from

DThemeMenuItemText.getTertiaryImageMarginHorizontal

Defined in

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


getTertiaryImageMarginVertial

getTertiaryImageMarginVertial(): number

Returns

number

Inherited from

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

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

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

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

DThemeMenuItemText.getTertiaryImageTintColor

Defined in

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


getTextAlignHorizontal

getTextAlignHorizontal(): DAlignHorizontal

Returns

DAlignHorizontal

Inherited from

DThemeMenuItemText.getTextAlignHorizontal

Defined in

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


getTextAlignVertical

getTextAlignVertical(): DAlignVertical

Returns

DAlignVertical

Inherited from

DThemeMenuItemText.getTextAlignVertical

Defined in

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


getTextFormatter

getTextFormatter(): DTextPieceFormatter<string>

Returns

DTextPieceFormatter<string>

Inherited from

DThemeMenuItemText.getTextFormatter

Defined in

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


getTextStyleClipping

getTextStyleClipping(): boolean

Returns

boolean

Inherited from

DThemeMenuItemText.getTextStyleClipping

Defined in

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


getTextStyleFitting

getTextStyleFitting(): boolean

Returns

boolean

Inherited from

DThemeMenuItemText.getTextStyleFitting

Defined in

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


getTextStyleWordWrap

getTextStyleWordWrap(): DDynamicTextStyleWordWrap

Returns

DDynamicTextStyleWordWrap

Inherited from

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

DThemeMenuItemText.getTextValue

Defined in

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


getTitle

getTitle(): string

Returns a tooltip text.

Returns

string

Inherited from

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

DThemeMenuItemText.getWeight

Defined in

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


getWidth

getWidth(): DCoordinateSize

Returns a width.

Returns

DCoordinateSize

Inherited from

DThemeMenuItemText.getWidth

Defined in

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


getX

getX(): DCoordinatePosition

Returns a X coordinate.

Returns

DCoordinatePosition

Inherited from

DThemeMenuItemText.getX

Defined in

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


getY

getY(): DCoordinatePosition

Returns a Y coordinate.

Returns

DCoordinatePosition

Inherited from

DThemeMenuItemText.getY

Defined in

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


isOverflowMaskEnabled

isOverflowMaskEnabled(): boolean

Returns

boolean

Inherited from

DThemeMenuItemText.isOverflowMaskEnabled

Defined in

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


newShadow

newShadow(): null | DShadow

Creates a new shadow.

Returns

null | DShadow

Inherited from

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

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

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

DThemeMenuItemText.newTextValue

Defined in

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