Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UIMenuListItem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new UIMenuListItem(text: string, items: ListItem[], startIndex?: number, description?: string, arrowOnlyOnSelected?: boolean): UIMenuListItem

Properties

Private _arrowOnlyOnSelected

_arrowOnlyOnSelected: boolean = false

Private _index

_index: number = 0

Private _itemText

_itemText: Text

Private _items

_items: ListItem[] = []

Private _leftArrow

_leftArrow: Sprite

Private _rightArrow

_rightArrow: Sprite

Private _textWidth

_textWidth: number = 0

Readonly activated

activated: LiteEvent = ...

Protected Readonly badgeLeft

badgeLeft: Sprite

Protected Readonly badgeRight

badgeRight: Sprite

enabled

enabled: boolean = true

hovered

hovered: boolean = false

Readonly id

id: string = ...

Protected Readonly labelText

labelText: Text

Readonly listChanged

listChanged: LiteEvent = ...

Readonly listSelected

listSelected: LiteEvent = ...

offset

offset: Point = ...

Readonly panelActivated

panelActivated: LiteEvent = ...

parent

parent: undefined | Menu

Protected Readonly rectangle

rectangle: Rectangle

selected

selected: boolean = false

Protected Readonly selectedSprite

selectedSprite: Sprite

Protected supportsDescription

supportsDescription: boolean = true

Protected supportsLeftBadge

supportsLeftBadge: boolean = true

Protected supportsPanels

supportsPanels: boolean = true

Protected supportsRightBadge

supportsRightBadge: boolean = false

Protected supportsRightLabel

supportsRightLabel: boolean = false

Protected Readonly text

text: Text

Static defaultBackColor

defaultBackColor: Color = Color.empty

Static defaultForeColor

defaultForeColor: Color = Color.whiteSmoke

Static defaultHighlightedBackColor

defaultHighlightedBackColor: Color = Color.white

Static defaultHighlightedForeColor

defaultHighlightedForeColor: Color = Color.black

Static defaultHoveredBackColor

defaultHoveredBackColor: Color = ...

Static defaultHoveredForeColor

defaultHoveredForeColor: Color = UIMenuItem.defaultForeColor

Accessors

ArrowOnlyOnSelected

  • get ArrowOnlyOnSelected(): boolean
  • set ArrowOnlyOnSelected(value: boolean): void

BackColor

  • get BackColor(): Color
  • set BackColor(value: Color): void

Description

  • get Description(): string
  • set Description(value: string): void

ForeColor

  • get ForeColor(): Color
  • set ForeColor(value: Color): void

FormattedDescription

  • get FormattedDescription(): string

HighlightedBackColor

  • get HighlightedBackColor(): Color
  • set HighlightedBackColor(value: Color): void

HighlightedForeColor

  • get HighlightedForeColor(): Color
  • set HighlightedForeColor(value: Color): void

Index

  • get Index(): number
  • set Index(value: number): void

IsMouseInBounds

  • get IsMouseInBounds(): boolean

IsMouseInBoundsOfLeftArrow

  • get IsMouseInBoundsOfLeftArrow(): boolean

IsMouseInBoundsOfRightArrow

  • get IsMouseInBoundsOfRightArrow(): boolean

Items

LeftBadge

Panels

RightBadge

RightLabel

  • get RightLabel(): string
  • set RightLabel(value: string): void

SelectedItem

SelectedValue

  • get SelectedValue(): unknown

Text

  • get Text(): string
  • set Text(value: string): void

Methods

Private _getSelectedItemCaption

  • _getSelectedItemCaption(): string

addEvent

  • addEvent(event: string, ...args: unknown[]): void

addPanel

badgeToColor

badgeToTextureName

draw

  • draw(): void

findPanelIndex

fireEvent

  • fireEvent(): void

formatDescription

  • formatDescription(): void

removePanel

setVerticalPosition

  • setVerticalPosition(y: number): void

Static badgeToTextureDict

Static getBadgeSize

Static getBadgeSpriteHeightOffset

  • getBadgeSpriteHeightOffset(sprite: Sprite): number

Static getBadgeSpriteWidthOffset

  • getBadgeSpriteWidthOffset(sprite: Sprite): number

Generated using TypeDoc