Winter Cardinal UI - v0.442.0 / DThemeDarkButtonBase
DButtonBase theme.
Name | Type |
---|---|
VALUE |
unknown |
DThemeDarkImageBase
<VALUE
>
↳ DThemeDarkButtonBase
DThemeButtonBase
<VALUE
>• new DThemeDarkButtonBase<VALUE
>(backgroundColor?
, hover?
, pressed?
): DThemeDarkButtonBase
<VALUE
>
Name | Type |
---|---|
VALUE |
unknown |
Name | Type | Default value |
---|---|---|
backgroundColor |
number |
0x484848 |
hover |
number |
0.017 |
pressed |
number |
0.034 |
DThemeDarkButtonBase
<VALUE
>
DThemeDarkImageBase.constructor
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:25
• Protected
Readonly
BACKGROUND_COLOR: number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:19
• Protected
Readonly
BACKGROUND_COLOR_HOVERED: number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:20
• Protected
Readonly
BACKGROUND_COLOR_PRESSED: number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:21
• Protected
Readonly
OUTLINE_COLOR: number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:23
▸ getAlpha(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:35
▸ getBackgroundAlpha(state
): number
Returns a background alpha.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getBackgroundAlpha
DThemeDarkImageBase.getBackgroundAlpha
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:84
▸ getBackgroundColor(state
): null
| number
Returns a background color. If the color is null, backgrounds are not be rendered.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
null
| number
DThemeButtonBase.getBackgroundColor
DThemeDarkImageBase.getBackgroundColor
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:38
▸ getBackgroundTexture(): Texture
Returns a background texture.
Texture
DThemeButtonBase.getBackgroundTexture
DThemeDarkImageBase.getBackgroundTexture
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:88
▸ getBorderAlign(state
): number
Returns a border align.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getBorderAlign
DThemeDarkImageBase.getBorderAlign
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:104
▸ getBorderAlpha(state
): number
Returns a border alpha.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getBorderAlpha
DThemeDarkImageBase.getBorderAlpha
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:96
▸ getBorderColor(state
): null
| number
Returns a border color. If the color is null, borders are not be rendered.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
null
| number
DThemeButtonBase.getBorderColor
DThemeDarkImageBase.getBorderColor
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:60
▸ getBorderMask(state
): number
Returns a border mask.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a mask |
number
DThemeButtonBase.getBorderMask
DThemeDarkImageBase.getBorderMask
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:108
▸ getBorderTexture(): Texture
Returns a border texture.
Texture
DThemeButtonBase.getBorderTexture
DThemeDarkImageBase.getBorderTexture
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:112
▸ getBorderWidth(state
): number
Returns a border width.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getBorderWidth
DThemeDarkImageBase.getBorderWidth
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:100
▸ getClearType(): number
Returns a clear type. A clear type is for layout classes including DLayoutVertical.
number
DThemeDarkImageBase.getClearType
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:167
▸ getColor(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:52
▸ getCornerMask(): number
Returns a corner mask.
number
DThemeButtonBase.getCornerMask
DThemeDarkImageBase.getCornerMask
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:136
▸ getCornerRadius(): number
Returns a corner radius.
number
DThemeButtonBase.getCornerRadius
DThemeDarkImageBase.getCornerRadius
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:132
▸ getCursor(state
): string
Returns a cursor.
Name | Type |
---|---|
state |
DBaseStateSet |
string
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:126
▸ getFontFamilly(): string
string
DThemeButtonBase.getFontFamilly
DThemeDarkImageBase.getFontFamilly
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:11
▸ getFontSize(): number
number
DThemeDarkImageBase.getFontSize
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:15
▸ getFontStyle(): DFontStyle
DThemeDarkImageBase.getFontStyle
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:27
▸ getFontVariant(): DFontVariant
DThemeButtonBase.getFontVariant
DThemeDarkImageBase.getFontVariant
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:31
▸ getFontWeight(): DFontWeight
DThemeButtonBase.getFontWeight
DThemeDarkImageBase.getFontWeight
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:23
▸ getHeight(): DCoordinateSize
Returns a height.
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:98
▸ getImageAlignHorizontal(): DAlignHorizontal
DThemeButtonBase.getImageAlignHorizontal
DThemeDarkImageBase.getImageAlignHorizontal
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:18
▸ getImageAlignVertical(): DAlignVertical
DThemeButtonBase.getImageAlignVertical
DThemeDarkImageBase.getImageAlignVertical
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:22
▸ getImageAlignWith(): DAlignWith
DThemeButtonBase.getImageAlignWith
DThemeDarkImageBase.getImageAlignWith
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:26
▸ getImageMarginHorizontal(): number
number
DThemeButtonBase.getImageMarginHorizontal
DThemeDarkImageBase.getImageMarginHorizontal
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:30
▸ getImageMarginVertial(): number
number
DThemeButtonBase.getImageMarginVertial
DThemeDarkImageBase.getImageMarginVertial
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:34
▸ getImageRotation(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
DThemeButtonBase.getImageRotation
DThemeDarkImageBase.getImageRotation
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:46
▸ getImageSource(state
): null
| DisplayObject
| Texture
Name | Type |
---|---|
state |
DBaseStateSet |
null
| DisplayObject
| Texture
DThemeButtonBase.getImageSource
DThemeDarkImageBase.getImageSource
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:50
▸ getImageTintAlpha(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
DThemeButtonBase.getImageTintAlpha
DThemeDarkImageBase.getImageTintAlpha
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:42
▸ getImageTintColor(state
): null
| number
Name | Type |
---|---|
state |
DBaseStateSet |
null
| number
DThemeButtonBase.getImageTintColor
DThemeDarkImageBase.getImageTintColor
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:38
▸ getInteractive(): number
Returns an interactivity.
number
DThemeButtonBase.getInteractive
DThemeDarkImageBase.getInteractive
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:175
▸ getLineHeight(): number
number
DThemeButtonBase.getLineHeight
DThemeDarkImageBase.getLineHeight
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-font.ts:42
▸ getOutlineAlign(state
): number
Returns an outline align.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getOutlineAlign
DThemeDarkImageBase.getOutlineAlign
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:159
▸ getOutlineAlpha(state
): number
Returns an outline alpha.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getOutlineAlpha
DThemeDarkImageBase.getOutlineAlpha
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:144
▸ getOutlineColor(state
): null
| number
Returns an outline color. If the color is null, outlines are not be rendered.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
null
| number
DThemeButtonBase.getOutlineColor
DThemeDarkImageBase.getOutlineColor
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:68
▸ getOutlineColorActive(state
): null
| number
Name | Type |
---|---|
state |
DBaseStateSet |
null
| number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:75
▸ getOutlineColorNonActive(state
): null
| number
Name | Type |
---|---|
state |
DBaseStateSet |
null
| number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:79
▸ getOutlineMask(state
): number
Returns an outline mask.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getOutlineMask
DThemeDarkImageBase.getOutlineMask
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:163
▸ getOutlineOffset(state
): number
Returns an outline offset.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getOutlineOffset
DThemeDarkImageBase.getOutlineOffset
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:83
▸ getOutlineOffsetActive(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:90
▸ getOutlineOffsetNonActive(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:94
▸ getOutlineWidth(state
): number
Returns an outline width.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
number
DThemeButtonBase.getOutlineWidth
DThemeDarkImageBase.getOutlineWidth
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:151
▸ getPaddingBottom(): number
Returns a bottom padding.
number
DThemeButtonBase.getPaddingBottom
DThemeDarkImageBase.getPaddingBottom
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:128
▸ getPaddingLeft(): number
Returns a left padding.
number
DThemeButtonBase.getPaddingLeft
DThemeDarkImageBase.getPaddingLeft
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:110
▸ getPaddingRight(): number
Returns a right padding.
number
DThemeButtonBase.getPaddingRight
DThemeDarkImageBase.getPaddingRight
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:114
▸ getPaddingTop(): number
Returns a top padding.
number
DThemeButtonBase.getPaddingTop
DThemeDarkImageBase.getPaddingTop
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:124
▸ getSecondaryImageAlignHorizontal(): DAlignHorizontal
DThemeButtonBase.getSecondaryImageAlignHorizontal
DThemeDarkImageBase.getSecondaryImageAlignHorizontal
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:54
▸ getSecondaryImageAlignVertical(): DAlignVertical
DThemeButtonBase.getSecondaryImageAlignVertical
DThemeDarkImageBase.getSecondaryImageAlignVertical
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:58
▸ getSecondaryImageAlignWith(): DAlignWith
DThemeButtonBase.getSecondaryImageAlignWith
DThemeDarkImageBase.getSecondaryImageAlignWith
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:62
▸ getSecondaryImageMarginHorizontal(): number
number
DThemeButtonBase.getSecondaryImageMarginHorizontal
DThemeDarkImageBase.getSecondaryImageMarginHorizontal
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:66
▸ getSecondaryImageMarginVertial(): number
number
DThemeButtonBase.getSecondaryImageMarginVertial
DThemeDarkImageBase.getSecondaryImageMarginVertial
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:70
▸ getSecondaryImageRotation(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
DThemeButtonBase.getSecondaryImageRotation
DThemeDarkImageBase.getSecondaryImageRotation
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:82
▸ getSecondaryImageTintAlpha(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
DThemeButtonBase.getSecondaryImageTintAlpha
DThemeDarkImageBase.getSecondaryImageTintAlpha
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:78
▸ getSecondaryImageTintColor(state
): null
| number
Name | Type |
---|---|
state |
DBaseStateSet |
null
| number
DThemeButtonBase.getSecondaryImageTintColor
DThemeDarkImageBase.getSecondaryImageTintColor
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:74
▸ getShadow(): null
| DShadow
Returns a shadow. If a shadow is null, no shadow is rendered.
null
| DShadow
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:171
▸ getTertiaryImageAlignHorizontal(): DAlignHorizontal
DThemeButtonBase.getTertiaryImageAlignHorizontal
DThemeDarkImageBase.getTertiaryImageAlignHorizontal
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:86
▸ getTertiaryImageAlignVertical(): DAlignVertical
DThemeButtonBase.getTertiaryImageAlignVertical
DThemeDarkImageBase.getTertiaryImageAlignVertical
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:90
▸ getTertiaryImageAlignWith(): DAlignWith
DThemeButtonBase.getTertiaryImageAlignWith
DThemeDarkImageBase.getTertiaryImageAlignWith
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:94
▸ getTertiaryImageMarginHorizontal(): number
number
DThemeButtonBase.getTertiaryImageMarginHorizontal
DThemeDarkImageBase.getTertiaryImageMarginHorizontal
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:98
▸ getTertiaryImageMarginVertial(): number
number
DThemeButtonBase.getTertiaryImageMarginVertial
DThemeDarkImageBase.getTertiaryImageMarginVertial
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:102
▸ getTertiaryImageRotation(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
DThemeButtonBase.getTertiaryImageRotation
DThemeDarkImageBase.getTertiaryImageRotation
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:114
▸ getTertiaryImageTintAlpha(state
): number
Name | Type |
---|---|
state |
DBaseStateSet |
number
DThemeButtonBase.getTertiaryImageTintAlpha
DThemeDarkImageBase.getTertiaryImageTintAlpha
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:110
▸ getTertiaryImageTintColor(state
): null
| number
Name | Type |
---|---|
state |
DBaseStateSet |
null
| number
DThemeButtonBase.getTertiaryImageTintColor
DThemeDarkImageBase.getTertiaryImageTintColor
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-image-base.ts:106
▸ getTextAlignHorizontal(): DAlignHorizontal
DThemeButtonBase.getTextAlignHorizontal
DThemeDarkImageBase.getTextAlignHorizontal
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:106
▸ getTextAlignVertical(): DAlignVertical
DThemeButtonBase.getTextAlignVertical
DThemeDarkImageBase.getTextAlignVertical
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:19
▸ getTextFormatter(): (value
: VALUE
, caller
: any
) => string
fn
▸ (value
, caller
): string
Name | Type |
---|---|
value |
VALUE |
caller |
any |
string
DThemeButtonBase.getTextFormatter
DThemeDarkImageBase.getTextFormatter
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:43
▸ getTextStyleClipping(): boolean
boolean
DThemeButtonBase.getTextStyleClipping
DThemeDarkImageBase.getTextStyleClipping
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:31
▸ getTextStyleFitting(): boolean
boolean
DThemeButtonBase.getTextStyleFitting
DThemeDarkImageBase.getTextStyleFitting
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:35
▸ getTextStyleWordWrap(): DDynamicTextStyleWordWrap
DThemeButtonBase.getTextStyleWordWrap
DThemeDarkImageBase.getTextStyleWordWrap
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:39
▸ getTextValue(state
): undefined
| VALUE
Returns a text value. Called to get a text vale if there is no text value.
Name | Type | Description |
---|---|---|
state |
DBaseStateSet |
a state |
undefined
| VALUE
DThemeDarkImageBase.getTextValue
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:47
▸ getTitle(): string
Returns a tooltip text.
string
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:183
▸ 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.
number
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:187
▸ getWhen(): DButtonBaseWhen
Returns when to activate a button.
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:122
▸ getWidth(): DCoordinateSize
Returns a width.
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:102
▸ getX(): DCoordinatePosition
Returns a X coordinate.
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:64
▸ getY(): DCoordinatePosition
Returns a Y coordinate.
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:68
▸ isOverflowMaskEnabled(): boolean
boolean
DThemeButtonBase.isOverflowMaskEnabled
DThemeDarkImageBase.isOverflowMaskEnabled
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:27
▸ isToggle(): boolean
Returns true to turn a toggle mode on.
boolean
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-button-base.ts:118
▸ newShadow(): null
| DShadow
Creates a new shadow.
null
| DShadow
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:191
▸ newShadowWeak(): null
| DShadow
Creates a new weak shadow.
null
| DShadow
DThemeButtonBase.newShadowWeak
DThemeDarkImageBase.newShadowWeak
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:195
▸ newState(state
): void
Returns true if focusable.
Name | Type |
---|---|
state |
DBaseStateSet |
void
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-base.ts:179
▸ newTextValue(): DStateAwareOrValueMightBe
<VALUE
>
Returns a new text value. Called to initialize a text value if a text value is not given.
DStateAwareOrValueMightBe
<VALUE
>
DThemeDarkImageBase.newTextValue
src/main/typescript/wcardinal/ui/theme/dark/d-theme-dark-text-base.ts:51