Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UIElement

Interface for a stand-alone UIElement.

Adds ability for:

  • Setting position
  • Specifying draggability

Implemented by

Index

Methods

Methods

dispose

  • dispose(): this

  • Remove the component from rendering.

    If the Component supports it, this can be reverted with restore() method.

    Returns this

    Object itself for fluent interface.

getDraggingMode

  • Get dragging mode of object. Defines how the object can be dragged by mouse.

    Returns UIDraggingModes

    Object itself

getIsUnderMouse

  • getIsUnderMouse(): boolean

  • Get boolean flag for whether object is currently under mouse or not

    Returns boolean

    Boolean for is object under mouse currently

getMargin

  • Get margin around object in pixels.

    Returns Margin

    Margin datastructure

Abstract 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

getOrigin

  • Returns the position origin of this UiElement.

    Returns Point

    Relative position vector (-1 to 1, where 0 is center of the object).

getPosition

  • Returns the position of this UiElement at given location relative to elements size.

    Parameters

    • relativePosition: Point

      Relative position vector (-1 to 1 which specifies position of origin, 0 is center of the object)

    • spaceOfInterest: UISpace

      Parameter to disregard parts of object when calculating the asked position. Defaults to Margin.

    Returns Point

    Object itself for fluent itself

getSize

  • Returns the size of the UiElements in pixels including any Margins or Paddings

    Parameters

    • spaceOfInterest: UISpace

      Parameter to disregard parts of object when calculating the position. Defaults to Margin, which includes everything. Should only ever be necessary for sub-classes

    Returns Point

    Object size in pixels

isDisposed

  • isDisposed(): boolean

  • Returns boolean

    True if the component is currently disposed, and thus not being rendered. If the Component supports it, this can be reverted with restore() method.

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

onMouseClick

  • Subscribe to Mouse Click event

    Parameters

    • listener: MouseEventHandler<this>

      Function that will be called when mouse clicks the bounds of UiObject.

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseDoubleClick

  • Subscribe to Mouse Double Click event

    Parameters

    Returns Token

onMouseDown

  • Subscribe to Mouse Down event

    Parameters

    Returns Token

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

  • Subscribe to Mouse Enter event

    Parameters

    • listener: MouseEventHandler<this>

      Function that will be called when mouse enters the bounds of UiObject.

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseLeave

  • Subscribe to Mouse Leave event

    Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseMove

  • Subscribe to Mouse Move event

    Parameters

    Returns Token

    Token of subscription

onMouseUp

  • Subscribe to Mouse Up event

    Parameters

    Returns Token

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

restore

  • restore(): this

  • After the Components dispose() method has been called, removing it from rendering, restore() can be used to return it back.

    Returns this

    Object itself for fluent interface.

setDraggingMode

  • Set dragging mode of object. Defines how the object can be dragged by mouse.

    See UIDraggingModes collection for options.

    Parameters

    • draggingMode: UIDraggingModes

      DraggingMode or undefined to disable dragging

    Returns this

    Object itself

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

Abstract setMouseInteractions

  • setMouseInteractions(state: boolean): this

  • Set mouse interactions enabled. Implementations should update the mouse-interactions of any Shapes they may contain here.

    Parameters

    • state: boolean

    Returns this

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

setOrigin

  • setOrigin(origin: Point): this

  • Sets the position origin of this UiElement.

    Parameters

    • origin: Point

      Relative position vector (-1 to 1, where 0 is center of the object). UIOrigins, enum-like object can be used for easy selection of common values

    Returns this

setPosition

  • setPosition(position: Point): this

  • Sets the position of this UiElement relative to its origin

    Parameters

    • position: Point

      Position

    Returns this