Winter Cardinal UI - v0.457.0 / DThemeDialogSelect

Interface: DThemeDialogSelect<VALUE, CATEGORY_ID>

DDialogSelect theme.

Type parameters

Name	Type
VALUE	unknown
CATEGORY_ID	unknown

Hierarchy

• DThemeDialogLayered

  ↳ DThemeDialogSelect

Implemented by

• DThemeDarkDialogSelect
• DThemeWhiteDialogSelect

Table of contents

Methods

• closeOn
• getAlign
• getAlpha
• getBackgroundAlpha
• getBackgroundColor
• getBackgroundTexture
• getBorderAlign
• getBorderAlpha
• getBorderColor
• getBorderMask
• getBorderTexture
• getBorderWidth
• getCategoryDismissLabel
• getClearType
• getColor
• getContent
• getCornerMask
• getCornerRadius
• getCursor
• getDismissLabel
• getFontFamilly
• getFontSize
• getFontStyle
• getFontVariant
• getFontWeight
• getFooter
• getGestureMode
• getHeader
• getHeight
• getInputMargin
• getInteractive
• getLayout
• getLineHeight
• getMode
• getOffsetX
• getOffsetY
• getOutlineAlign
• getOutlineAlpha
• getOutlineColor
• getOutlineMask
• getOutlineOffset
• getOutlineWidth
• getPaddingBottom
• getPaddingLeft
• getPaddingRight
• getPaddingTop
• getShadow
• getTitle
• getWeight
• getWidth
• getX
• getY
• isAlwaysOnTop
• isCategoryDismissable
• isDismissable
• isGestureEnabled
• isSticky
• newAnimation
• newShadow
• newShadowWeak
• newState

Methods

closeOn

▸ closeOn(mode): number

Parameters

Name	Type
mode	DDialogMode

Returns

number

Inherited from

DThemeDialogLayered.closeOn

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:88

---

getAlign

▸ getAlign(mode): null | UtilAttachAlign

Parameters

Name	Type
mode	DDialogMode

Returns

null | UtilAttachAlign

Inherited from

DThemeDialogLayered.getAlign

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:95

---

getAlpha

▸ getAlpha(state): number

Parameters

Name	Type
state	DBaseStateSet

Returns

number

Inherited from

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

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

DThemeDialogLayered.getBackgroundColor

Defined in

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

---

getBackgroundTexture

▸ getBackgroundTexture(): Texture

Returns a background texture.

Returns

Texture

Inherited from

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

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

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

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

DThemeDialogLayered.getBorderMask

Defined in

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

---

getBorderTexture

▸ getBorderTexture(): Texture

Returns a border texture.

Returns

Texture

Inherited from

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

DThemeDialogLayered.getBorderWidth

Defined in

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

---

getCategoryDismissLabel

▸ getCategoryDismissLabel(): string

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:129

---

getClearType

▸ getClearType(): number

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

Returns

number

Inherited from

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

DThemeDialogLayered.getColor

Defined in

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

---

getContent

▸ getContent(): undefined | DDialogLayeredContentOptions<DThemeDialogLayeredContent>

Returns

undefined | DDialogLayeredContentOptions<DThemeDialogLayeredContent>

Inherited from

DThemeDialogLayered.getContent

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:83

---

getCornerMask

▸ getCornerMask(): number

Returns a corner mask.

Returns

number

Inherited from

DThemeDialogLayered.getCornerMask

Defined in

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

---

getCornerRadius

▸ getCornerRadius(): number

Returns a corner radius.

Returns

number

Inherited from

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

DThemeDialogLayered.getCursor

Defined in

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

---

getDismissLabel

▸ getDismissLabel(): string

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:127

---

getFontFamilly

▸ getFontFamilly(): string

Returns

string

Inherited from

DThemeDialogLayered.getFontFamilly

Defined in

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

---

getFontSize

▸ getFontSize(): number

Returns

number

Inherited from

DThemeDialogLayered.getFontSize

Defined in

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

---

getFontStyle

▸ getFontStyle(): DFontStyle

Returns

DFontStyle

Inherited from

DThemeDialogLayered.getFontStyle

Defined in

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

---

getFontVariant

▸ getFontVariant(): DFontVariant

Returns

DFontVariant

Inherited from

DThemeDialogLayered.getFontVariant

Defined in

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

---

getFontWeight

▸ getFontWeight(): DFontWeight

Returns

DFontWeight

Inherited from

DThemeDialogLayered.getFontWeight

Defined in

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

---

getFooter

▸ getFooter(): undefined | null | DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>

Returns

undefined | null | DDialogLayeredFooterOptions<DThemeDialogLayeredFooter>

Inherited from

DThemeDialogLayered.getFooter

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:84

---

getGestureMode

▸ getGestureMode(mode): DDialogGestureMode

Parameters

Name	Type
mode	DDialogMode

Returns

DDialogGestureMode

Inherited from

DThemeDialogLayered.getGestureMode

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:92

---

getHeader

▸ getHeader(): undefined | null | DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>

Returns

undefined | null | DDialogLayeredHeaderOptions<DThemeDialogLayeredHeader>

Inherited from

DThemeDialogLayered.getHeader

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:82

---

getHeight

▸ getHeight(): DCoordinateSize

Returns a height.

Returns

DCoordinateSize

Inherited from

DThemeDialogLayered.getHeight

Defined in

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

---

getInputMargin

▸ getInputMargin(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:125

---

getInteractive

▸ getInteractive(): number

Returns an interactivity.

Returns

number

Inherited from

DThemeDialogLayered.getInteractive

Defined in

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

---

getLayout

▸ getLayout(): undefined | DLayoutVerticalOptions<DThemeLayoutVertical>

Returns

undefined | DLayoutVerticalOptions<DThemeLayoutVertical>

Inherited from

DThemeDialogLayered.getLayout

Defined in

src/main/typescript/wcardinal/ui/d-dialog-layered.ts:81

---

getLineHeight

▸ getLineHeight(): number

Returns

number

Inherited from

DThemeDialogLayered.getLineHeight

Defined in

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

---

getMode

▸ getMode(): DDialogMode

Returns

DDialogMode

Inherited from

DThemeDialogLayered.getMode

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:87

---

getOffsetX

▸ getOffsetX(mode): number

Parameters

Name	Type
mode	DDialogMode

Returns

number

Inherited from

DThemeDialogLayered.getOffsetX

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:93

---

getOffsetY

▸ getOffsetY(mode): number

Parameters

Name	Type
mode	DDialogMode

Returns

number

Inherited from

DThemeDialogLayered.getOffsetY

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:94

---

getOutlineAlign

▸ getOutlineAlign(state): number

Returns an outline align.

Parameters

Name	Type	Description
state	DBaseStateSet	a state

Returns

number

Inherited from

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

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

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

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

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

DThemeDialogLayered.getOutlineWidth

Defined in

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

---

getPaddingBottom

▸ getPaddingBottom(): number

Returns a bottom padding.

Returns

number

Inherited from

DThemeDialogLayered.getPaddingBottom

Defined in

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

---

getPaddingLeft

▸ getPaddingLeft(): number

Returns a left padding.

Returns

number

Inherited from

DThemeDialogLayered.getPaddingLeft

Defined in

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

---

getPaddingRight

▸ getPaddingRight(): number

Returns a right padding.

Returns

number

Inherited from

DThemeDialogLayered.getPaddingRight

Defined in

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

---

getPaddingTop

▸ getPaddingTop(): number

Returns a top padding.

Returns

number

Inherited from

DThemeDialogLayered.getPaddingTop

Defined in

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

---

getShadow

▸ getShadow(): null | DShadow

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

Returns

null | DShadow

Inherited from

DThemeDialogLayered.getShadow

Defined in

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

---

getTitle

▸ getTitle(): string

Returns a tooltip text.

Returns

string

Inherited from

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

DThemeDialogLayered.getWeight

Defined in

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

---

getWidth

▸ getWidth(): DCoordinateSize

Returns a width.

Returns

DCoordinateSize

Inherited from

DThemeDialogLayered.getWidth

Defined in

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

---

getX

▸ getX(): DCoordinatePosition

Returns a X coordinate.

Returns

DCoordinatePosition

Inherited from

DThemeDialogLayered.getX

Defined in

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

---

getY

▸ getY(): DCoordinatePosition

Returns a Y coordinate.

Returns

DCoordinatePosition

Inherited from

DThemeDialogLayered.getY

Defined in

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

---

isAlwaysOnTop

▸ isAlwaysOnTop(): boolean

Returns

boolean

Inherited from

DThemeDialogLayered.isAlwaysOnTop

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:90

---

isCategoryDismissable

▸ isCategoryDismissable(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:128

---

isDismissable

▸ isDismissable(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-dialog-select.ts:126

---

isGestureEnabled

▸ isGestureEnabled(mode): boolean

Parameters

Name	Type
mode	DDialogMode

Returns

boolean

Inherited from

DThemeDialogLayered.isGestureEnabled

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:91

---

isSticky

▸ isSticky(mode): boolean

Parameters

Name	Type
mode	DDialogMode

Returns

boolean

Inherited from

DThemeDialogLayered.isSticky

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:89

---

newAnimation

▸ newAnimation(mode): null | DAnimation<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Parameters

Name	Type
mode	DDialogMode

Returns

null | DAnimation<DBase<DThemeBase, DBaseOptions<DThemeBase, any>>>

Inherited from

DThemeDialogLayered.newAnimation

Defined in

src/main/typescript/wcardinal/ui/d-dialog.ts:96

---

newShadow

▸ newShadow(): null | DShadow

Creates a new shadow.

Returns

null | DShadow

Inherited from

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

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

DThemeDialogLayered.newState

Defined in

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

Edit this page.