Class UIElementStyle

UI element style that determines the look of a UI element, as well as the element's default layout options. Different looks can be provided for different element states.

Constructors

constructor

new UIElementStyle(isInternalConstructor?: boolean): UIElementStyle
Parameters
- OptionalisInternalConstructor: boolean
Returns UIElementStyle

Overrides FrameworkObject.constructor

Accessors

active

get active(): Immutable<UIElementStateStyle>

Style used when the user is actively interacting with the element. Used when the element is in the 'off' state.

Returns Immutable<UIElementStateStyle>
set active(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

activeOn

get activeOn(): Immutable<UIElementStateStyle>

Same as UIElementStyle::Active, except it's used when element is in the 'on' state.

Returns Immutable<UIElementStateStyle>
set activeOn(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

border

get border(): Immutable<RectOffset>

Determines how the element is scaled (using the typical Scale9Grid approach).

Returns Immutable<RectOffset>
set border(value: Immutable<RectOffset>): void
Parameters
- value: Immutable<RectOffset>
Returns void

contentAlignment

get contentAlignment(): EnumValue<UIContentAlignment>

The full content alignment.

Returns EnumValue<UIContentAlignment>
set contentAlignment(value: EnumValue<UIContentAlignment>): void
Parameters
- value: EnumValue<UIContentAlignment>
Returns void

contentOffset

get contentOffset(): Immutable<RectOffset>

Additional offset to the content, that doesn't effect the bounds. Applied on top of the margins offsets.

Returns Immutable<RectOffset>
set contentOffset(value: Immutable<RectOffset>): void
Parameters
- value: Immutable<RectOffset>
Returns void

contentPriority

get contentPriority(): EnumValue<UIContentPriority>

The priority for the current content.

Returns EnumValue<UIContentPriority>
set contentPriority(value: EnumValue<UIContentPriority>): void
Parameters
- value: EnumValue<UIContentPriority>
Returns void

focused

get focused(): Immutable<UIElementStateStyle>

Style used when the element has focus but the pointer is not hovering over the element. Used when the element is in the 'off' state.

Returns Immutable<UIElementStateStyle>
set focused(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

focusedActive

get focusedActive(): Immutable<UIElementStateStyle>

Same as UIElementStyle::Active, except it's used when element is in the 'focused' state.

Returns Immutable<UIElementStateStyle>
set focusedActive(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

focusedActiveOn

get focusedActiveOn(): Immutable<UIElementStateStyle>

Same as UIElementStyle::ActiveOn, except it's used when element is in the 'focused' state.

Returns Immutable<UIElementStateStyle>
set focusedActiveOn(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

focusedHover

get focusedHover(): Immutable<UIElementStateStyle>

Style used when the element has focus and the pointer is hovering over the element. Used when the element is in the 'off' state.

Returns Immutable<UIElementStateStyle>
set focusedHover(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

focusedHoverOn

get focusedHoverOn(): Immutable<UIElementStateStyle>

Same as UIElementStyle::FocusedHover, except it's used when element is in the 'on' state.

Returns Immutable<UIElementStateStyle>
set focusedHoverOn(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

focusedOn

get focusedOn(): Immutable<UIElementStateStyle>

Same as UIElementStyle::Focused, except it's used when element is in the 'on' state.

Returns Immutable<UIElementStateStyle>
set focusedOn(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

font

get font(): Font

Font to use for all text within the UI element.

Returns Font
set font(value: Font | ResourceHandle<Font>): void
Parameters
- value: Font | ResourceHandle<Font>
Returns void

height

get height(): number

Wanted height of the UI element in pixels. Only used if IsHeightFixed is enabled.

Returns number
set height(value: number): void
Parameters
- value: number
Returns void

hover

get hover(): Immutable<UIElementStateStyle>

Style used when the user is hovering the pointer over the element, while the element doesn't have focus. Used when the element is in the 'off' state.

Returns Immutable<UIElementStateStyle>
set hover(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

hoverOn

get hoverOn(): Immutable<UIElementStateStyle>

Same as UIElementStyle::Hover, except it's used when element is in the 'on' state.

Returns Immutable<UIElementStateStyle>
set hoverOn(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

iconStyle

get iconStyle(): EnumValue<StockIcon>

Determines the icon to be shown within the element.

Returns EnumValue<StockIcon>
set iconStyle(value: EnumValue<StockIcon>): void
Parameters
- value: EnumValue<StockIcon>
Returns void

imagePosition

get imagePosition(): EnumValue<UIImagePosition>

Position of content image relative to text.

Returns EnumValue<UIImagePosition>
set imagePosition(value: EnumValue<UIImagePosition>): void
Parameters
- value: EnumValue<UIImagePosition>
Returns void

isDefault

get isDefault(): boolean

Determines if the style is the default style.

Returns boolean

isDrawEnabled

get isDrawEnabled(): boolean

Determines whether the UI drawing for the element is enabled or not. If false, the UIElement will not draw any of it's contents.

Returns boolean
set isDrawEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isHeightFixed

get isHeightFixed(): boolean

Determines should the layout resize the element depending on available size. If true no resizing will be done.

Returns boolean
set isHeightFixed(value: boolean): void
Parameters
- value: boolean
Returns void

isUsingWordWrap

get isUsingWordWrap(): boolean

Should the text word wrap if it doesn't fit.

Returns boolean
set isUsingWordWrap(value: boolean): void
Parameters
- value: boolean
Returns void

isWidthFixed

get isWidthFixed(): boolean

Determines should the layout resize the element depending on available size. If true no resizing will be done.

Returns boolean
set isWidthFixed(value: boolean): void
Parameters
- value: boolean
Returns void

margins

get margins(): Immutable<RectOffset>

Determines offset from the background graphics to the content. Input uses bounds offset by this value.

Returns Immutable<RectOffset>
set margins(value: Immutable<RectOffset>): void
Parameters
- value: Immutable<RectOffset>
Returns void

maximumHeight

get maximumHeight(): number

Maximum height allowed for the UI element. Used by the layout only when exact height is not specified.

Returns number
set maximumHeight(value: number): void
Parameters
- value: number
Returns void

maximumWidth

get maximumWidth(): number

Maximum width allowed for the UI element. Used by the layout only when exact width is not specified.

Returns number
set maximumWidth(value: number): void
Parameters
- value: number
Returns void

minimumHeight

get minimumHeight(): number

Minimum height allowed for the UI element. Used by the layout only when exact height is not specified.

Returns number
set minimumHeight(value: number): void
Parameters
- value: number
Returns void

minimumWidth

get minimumWidth(): number

Minimum width allowed for the UI element. Used by the layout only when exact width is not specified.

Returns number
set minimumWidth(value: number): void
Parameters
- value: number
Returns void

normal

get normal(): Immutable<UIElementStateStyle>

Style used when the element doesn't have focus nor is the user interacting with the element. Used when the element is in the 'off' state.

Returns Immutable<UIElementStateStyle>
set normal(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

normalOn

get normalOn(): Immutable<UIElementStateStyle>

Same as UIElementStyle::Normal, except it's used when element is in the 'on' state.

Returns Immutable<UIElementStateStyle>
set normalOn(value: Immutable<UIElementStateStyle>): void
Parameters
- value: Immutable<UIElementStateStyle>
Returns void

padding

get padding(): Immutable<RectOffset>

Determines extra distance between this and other elements in a layout.

Returns Immutable<RectOffset>
set padding(value: Immutable<RectOffset>): void
Parameters
- value: Immutable<RectOffset>
Returns void

textHorizontalAlign

get textHorizontalAlign(): EnumValue<TextHorizontalAlignType>

Horizontal alignment of text within the UI element.

Returns EnumValue<TextHorizontalAlignType>
set textHorizontalAlign(value: EnumValue<TextHorizontalAlignType>): void
Parameters
- value: EnumValue<TextHorizontalAlignType>
Returns void

textVerticalAlign

get textVerticalAlign(): EnumValue<TextVerticalAlignType>

Vertical alignment of text within the UI element.

Returns EnumValue<TextVerticalAlignType>
set textVerticalAlign(value: EnumValue<TextVerticalAlignType>): void
Parameters
- value: EnumValue<TextVerticalAlignType>
Returns void

width

get width(): number

Wanted width of the UI element in pixels. Only used if IsWidthFixed is enabled.

Returns number
set width(value: number): void
Parameters
- value: number
Returns void

Methods

addSubStyle

addSubStyle(uiType: string, styleName: string): void
Registers a new sub-style that is used by complex UI elements that contain one or multiple sub-elements.
Parameters
- uiType: string
  Name of the sub-element this style is to be used for. This depends on UI element the style is applied to.
- styleName: string
  Name of the style in UI skin to use for the sub-element.
Returns void

calculateSizeHintInPixels

calculateSizeHintInPixels(): Vector2

Gets the optimal size for a style.

Returns Vector2

getColor

getColor(name: string): Immutable<SRGBColor>
Returns a named color from the style defined in the style. This can be used by complex UI elements that wish to customize the colors they are rendered in.
Parameters
- name: string
  The color parameter name. This depends on UI element the style is applied to.
Returns Immutable<SRGBColor>
getColor(name: string, defaultColor: Immutable<SRGBColor>): SRGBColor
Returns a named color from the style defined in the style. This can be used by complex UI elements that wish to customize the colors they are rendered in.
Parameters
- name: string
  The color parameter name. This depends on UI element the style is applied to.
- defaultColor: Immutable<SRGBColor>
  The default color to be used if the style doesn't define a color with the given name.
Returns SRGBColor
getColor(
name: string,
state: Immutable<UIElementStateStyle>,
): Immutable<SRGBColor>
Returns a named color from the style defined in the style. This can be used by complex UI elements that wish to customize the colors they are rendered in.

Searches for a override in the given UIElementStateStyle. If no such override is found, it will look for a default color in the parent style. If no such color is defined in the style, returns the given default color.
Parameters
- name: string
  The color parameter name. This depends on UI element the style is applied to.
- state: Immutable<UIElementStateStyle>
  The state style to look for a color first. If no such color is defined in the state, search will fallback to looking the style.
Returns Immutable<SRGBColor>
getColor(
    name: string,
    state: Immutable<UIElementStateStyle>,
    defaultColor: Immutable<SRGBColor>,
): SRGBColor
Returns a named color from the style defined in the style. This can be used by complex UI elements that wish to customize the colors they are rendered in.

Searches for a override in the given UIElementStateStyle. If no such override is found, it will look for a default color in the parent style. If no such color is defined in the style, returns the given default color.
Parameters
- name: string
  The color parameter name. This depends on UI element the style is applied to.
- state: Immutable<UIElementStateStyle>
  The state style to look for a color first. If no such color is defined in the state, search will fallback to looking the style.
- defaultColor: Immutable<SRGBColor>
  The default color to be used if the style doesn't define a color with the given name.
Returns SRGBColor

getStateStyle

getStateStyle(state: EnumValue<UIElementState>): Immutable<UIElementStateStyle>
Gets the UIElementStateStyle for the given state.
Parameters
- state: EnumValue<UIElementState>
Returns Immutable<UIElementStateStyle>

getValue

getValue(name: string, defaultValue?: number): number
Returns a named float parameter from the style defined in the style. This can be used by complex UI elements that wish to customize rendering parameters such as a rounder border radius.
Parameters
- name: string
  The float parameter name. This depends on UI element the style is applied to.
- OptionaldefaultValue: number
  The default value to be used if the style doesn't define a parameter with the given name.
Returns number
getValue(
    name: string,
    state: Immutable<UIElementStateStyle>,
    defaultValue?: number,
): number
Returns a named float parameter from the style defined in the given state or style. This can be used by complex UI elements that wish to customize rendering parameters such as a rounder border radius.

Searches for a override in the given UIElementStateStyle. If no such override is found, it will look for a default value in the parent style. If no such value is defined in the style, returns the given default value.
Parameters
- name: string
  The float parameter name. This depends on UI element the style is applied to.
- state: Immutable<UIElementStateStyle>
  The state style to look for a value first. If no such value is defined in the state, search will fallback to looking the style.
- OptionaldefaultValue: number
  The default value to be used if the style doesn't define a parameter with the given name.
Returns number

Class UIElementStyle

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns UIElementStyle

Accessors

active

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

activeOn

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

border

Returns Immutable<RectOffset>

Parameters

Returns void

contentAlignment

Returns EnumValue<UIContentAlignment>

Parameters

Returns void

contentOffset

Returns Immutable<RectOffset>

Parameters

Returns void

contentPriority

Returns EnumValue<UIContentPriority>

Parameters

Returns void

focused

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

focusedActive

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

focusedActiveOn

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

focusedHover

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

focusedHoverOn

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

focusedOn

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

font

Returns Font

Parameters

Returns void

fontSize

Returns number

Parameters

Returns void

height

Returns number

Parameters

Returns void

hover

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

hoverOn

Returns Immutable<UIElementStateStyle>

Parameters

Returns void

iconStyle

Returns EnumValue<StockIcon>