Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UITextBox <BackgroundType >

Index

Properties

dispose

dispose: function
    • Returns this

isDisposed

isDisposed: function
    • Returns boolean

restore

restore: function
    • Returns this

Methods

getBackground

  • getBackground(): BackgroundType
  • Returns BackgroundType

    Background object

getFont

getHighlighted

  • getHighlighted(): boolean
  • Returns boolean

    True for highlighted state of object and false for basic

getMargin

  • Returns Margin

    Margin datastructure

getMouseInteractions

  • getMouseInteractions(): boolean
  • Returns boolean

    Mouse interactions state

getMouseStyle

  • Returns UIMouseStyle

    Interface for defining how mouse should look when hovering over UI object

getPadding

  • Returns Margin

    Margin datastructure

getText

  • getText(): string
  • Returns string

    The entire text string.

getTextFillStyle

  • Returns FillStyle

    Current text fill style object

getTextFillStyleHighlight

  • getTextFillStyleHighlight(): FillStyle | undefined
  • Returns FillStyle | undefined

    Current text fill style object when highlighted or undefined for auto assignment

offMouseClick

  • offMouseClick(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDown

  • offMouseDown(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDrag

  • offMouseDrag(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDragStart

  • offMouseDragStart(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseDragStop

  • offMouseDragStop(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseEnter

  • offMouseEnter(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseLeave

  • offMouseLeave(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseMove

  • offMouseMove(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseUp

  • offMouseUp(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offMouseWheel

  • offMouseWheel(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchEnd

  • offTouchEnd(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchMove

  • offTouchMove(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

offTouchStart

  • offTouchStart(token: Token): boolean
  • Parameters

    • token: Token

    Returns boolean

    True if the listener is successfully removed and false if it is not found

onMouseClick

onMouseDoubleClick

onMouseDown

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

onMouseLeave

onMouseMove

onMouseUp

onMouseWheel

onTouchEnd

onTouchMove

onTouchStart

setBackground

  • setBackground(mutator: Mutator<BackgroundType>): this
  • Parameters

    Returns this

    Object itself for fluent interface

setFont

setHighlighted

  • setHighlighted(isHighlighted: boolean): this
  • Parameters

    • isHighlighted: boolean

    Returns this

    Object itself for fluent interface

setMargin

  • setMargin(margin: Partial<MMargin> | number): this
  • Parameters

    • margin: Partial<MMargin> | number

    Returns this

    Object itself

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

    Object itself for fluent interface

setMouseStyle

  • Parameters

    Returns this

    Object itself

setPadding

  • setPadding(padding: Partial<Margin> | number): this
  • Parameters

    • padding: Partial<Margin> | number

    Returns this

    Object itself

setText

  • setText(text: string): this
  • Parameters

    • text: string

    Returns this

    Object itself for fluent interface.

setTextFillStyle

setTextFillStyleHighlight