Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UITextBox<BackgroundType>

Interface for 'TextBox'.

Index

Properties

dispose

dispose : function

Remove everything related to the object from all collections associated with rendering cycle and allows the object to be collected by GC

returns

Object itself for fluent interface

    • Returns this

isDisposed

isDisposed : function
returns

True if object and all of its sub-objects/elements have been disposed, false if not.

    • Returns boolean

restore

restore : function

Restore everything required for correct life cycle of the object

returns

Object itself for fluent interface

    • Returns this

Methods

getBackground

  • getBackground(): BackgroundType
  • Get elements Background object

    Type of Background is generic, see UIBackground for minimum interface.

    Returns BackgroundType

    Background object

getFont

getHighlighted

  • getHighlighted(isHighlighted: boolean): boolean
  • Parameters

    • isHighlighted: boolean

    Returns boolean

    True for highlighted state of object and false for basic

getMargin

  • Get margin around object in pixels.

    Returns Margin

    Margin datastructure

getMouseInteractions

  • getMouseInteractions(): boolean
  • Returns boolean

    Mouse interactions state

getMouseStyle

  • Get mouse style.

    Returns UIMouseStyle

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

getPadding

  • Get padding around object in pixels. Padding is empty space between the UiElements content and Background

    Returns Margin

    Margin datastructure

getText

  • getText(): string
  • Get the text of the entire shape.

    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

offHighlight

  • offHighlight(token: Token): boolean
  • Unsubscribe from Highlight object event. This is called whenever an object is highlighted

    Parameters

    • token: Token

      Token that was received when subscribing to the event.

    Returns boolean

    True if the unsubscription was successful.

offMouseClick

  • offMouseClick(token: Token): boolean
  • Remove event listener from Mouse Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean
  • Remove event listener from Mouse Double Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDown

  • offMouseDown(token: Token): boolean
  • Remove event listener from Mouse Down Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDrag

  • offMouseDrag(token: Token): boolean
  • Remove event listener from Mouse Drag Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDragStart

  • offMouseDragStart(token: Token): boolean
  • Remove event listener from Mouse Drag start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDragStop

  • offMouseDragStop(token: Token): boolean
  • Remove event listener from Mouse Drag stop Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseEnter

  • offMouseEnter(token: Token): boolean
  • Remove event listener from Mouse Enter Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseLeave

  • offMouseLeave(token: Token): boolean
  • Remove event listener from Mouse Leave Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseMove

  • offMouseMove(token: Token): boolean
  • Remove event listener from Mouse Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseUp

  • offMouseUp(token: Token): boolean
  • Remove event listener from Mouse Up Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseWheel

  • offMouseWheel(token: Token): boolean
  • Remove event listener from Mouse Wheel Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchEnd

  • offTouchEnd(token: Token): boolean
  • Remove event listener from Touch End Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchMove

  • offTouchMove(token: Token): boolean
  • Remove event listener from Touch Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchStart

  • offTouchStart(token: Token): boolean
  • Remove event listener from Touch Start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

onHighlight

  • onHighlight(handler: function): Token
  • Subscribe to highlight object event. This is called whenever an object is highlighted.

    Parameters

    • handler: function

      Function that is called when event is triggered.

        • Parameters

          • isHighlighted: boolean

          Returns void

    Returns Token

    Token that can be used to unsubscribe from the event.

onMouseClick

  • Subscribe on Mouse Enter click

    Parameters

    Returns Token

    Token of subscription

onMouseDoubleClick

  • Subscribe to Mouse Double Click event

    Parameters

    Returns Token

    Token of subscription

onMouseDown

  • Subscribe to Mouse Down event

    Parameters

    Returns Token

    Token of subscription

onMouseDrag

  • Subscribe to Mouse Drag event

    Parameters

    Returns Token

    Token of subscription

onMouseDragStart

  • Subscribe to Mouse Drag Start event

    Parameters

    Returns Token

    Token of subscription

onMouseDragStop

  • Subscribe to Mouse Drag Stop event

    Parameters

    Returns Token

    Token of subscription

onMouseEnter

  • Subscribe on Mouse Enter event

    Parameters

    Returns Token

    Token of subscription

onMouseLeave

  • Subscribe on Mouse Enter leave

    Parameters

    Returns Token

    Token of subscription

onMouseMove

  • Subscribe to Mouse Move event

    Parameters

    Returns Token

    Token of subscription

onMouseUp

  • Subscribe to Mouse Up event

    Parameters

    Returns Token

    Token of subscription

onMouseWheel

  • Subscribe to Mouse Wheel event

    Parameters

    Returns Token

    Token of subscription

onTouchEnd

  • Subscribe to Touch End event

    Parameters

    Returns Token

    Token of subscription

onTouchMove

  • Subscribe to Touch Move event

    Parameters

    Returns Token

    Token of subscription

onTouchStart

  • Subscribe to Touch Start event

    Parameters

    Returns Token

    Token of subscription

setBackground

  • setBackground(mutator: Mutator<BackgroundType>): this
  • Method for mutating Background of object.

    Type of Background is generic, see UIBackground for minimum interface.

    Parameters

    • mutator: Mutator<BackgroundType>

      Mutator function for Background

    Returns this

    Object itself for fluent interface

setFont

setHighlighted

  • setHighlighted(isHighlighted: boolean): this
  • Set highlighted state of the Object

    Parameters

    • isHighlighted: boolean

      Highlight state of the object

    Returns this

    Object itself for fluent interface

setMargin

  • setMargin(margin: Partial<MMargin> | number): this
  • Set margin around object in pixels.

    Parameters

    • margin: Partial<MMargin> | number

      Number with pixel margins for all sides or datastructure with individual pixel margins for each side. Any side can be omitted, only passed values will be overridden.

    Returns this

    Object itself

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Set mouse interactions enabled or disabled

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns this

    Object itself for fluent interface

setMouseStyle

  • Set mouse style when hovering over UI object.

    Parameters

    • mouseStyle: UIMouseStyle

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

    Returns this

    Object itself

setPadding

  • setPadding(padding: Partial<Margin> | number): this
  • Set padding around object in pixels. Padding is empty space between the UiElements content and Background

    Parameters

    • padding: Partial<Margin> | number

      Number with pixel margins for all sides or datastructure with individual pixel paddings for each side. Any side can be omitted, only passed values will be overridden.

    Returns this

    Object itself

setText

  • setText(text: string): this
  • Specify a text string.

    Parameters

    • text: string

      The string to be rendered.

    Returns this

    Object itself for fluent interface.

setTextFillStyle

  • Set text fill style object

    Parameters

    Returns this

    Object itself for fluent interface

setTextFillStyleHighlight

  • Set text fill style object when highlighted

    Parameters

    Returns this

    Object itself for fluent interface