Interface UIElement

Implemented by

Properties

dispose

dispose: function

- Returns this

isDisposed

isDisposed: function

- Returns boolean

restore

restore: function

- Returns this

Methods

getDraggingMode

getDraggingMode(): UIDraggingModes

Returns UIDraggingModes

Object itself

getIsUnderMouse

getIsUnderMouse(): boolean

Returns boolean

Boolean for is object under mouse currently

getMargin

getMargin(): Margin

Returns Margin

Margin datastructure

Abstract getMouseInteractions

getMouseInteractions(): boolean

Returns boolean

Mouse interactions state

getMouseStyle

getMouseStyle(): UIMouseStyle

Returns UIMouseStyle

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

getOrigin

getOrigin(): Point

Returns Point

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

getPosition

getPosition(relativePosition: Point, spaceOfInterest: UISpace): Point

Parameters
- Optional relativePosition: Point
- Optional spaceOfInterest: UISpace
Returns Point

Object itself for fluent itself

getSize

getSize(spaceOfInterest: UISpace): Point

Parameters
- Optional spaceOfInterest: UISpace
Returns Point

Object size in pixels

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

onMouseClick(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

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

onMouseDoubleClick

onMouseDoubleClick(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

onMouseDown

onMouseDown(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

onMouseDrag

onMouseDrag(listener: MouseDragEventHandler<this>): Token

Parameters
- listener: MouseDragEventHandler<this>
Returns Token

onMouseDragStart

onMouseDragStart(listener: MouseDragStartEventHandler<this>): Token

Parameters
- listener: MouseDragStartEventHandler<this>
Returns Token

onMouseDragStop

onMouseDragStop(listener: MouseDragStopEventHandler<this>): Token

Parameters
- listener: MouseDragStopEventHandler<this>
Returns Token

onMouseEnter

onMouseEnter(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

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

onMouseLeave

onMouseLeave(listener: AbruptMouseEventHandler<this>): Token

Parameters
- listener: AbruptMouseEventHandler<this>
Returns Token

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

onMouseMove

onMouseMove(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

Token of subscription

onMouseUp

onMouseUp(listener: MouseEventHandler<this>): Token

Parameters
- listener: MouseEventHandler<this>
Returns Token

onMouseWheel

onMouseWheel(listener: MouseWheelEventHandler<this>): Token

Parameters
- listener: MouseWheelEventHandler<this>
Returns Token

Token of subscription

onTouchEnd

onTouchEnd(listener: TouchEventHandler<this>): Token

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

onTouchMove

onTouchMove(listener: TouchEventHandler<this>): Token

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

onTouchStart

onTouchStart(listener: TouchEventHandler<this>): Token

Parameters
- listener: TouchEventHandler<this>
Returns Token

Token of subscription

setDraggingMode

setDraggingMode(draggingMode: UIDraggingModes): this

Parameters
- Optional draggingMode: UIDraggingModes
Returns this

Object itself

setMargin

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

Parameters
- margin: Partial<MMargin> | number
Returns this

Object itself

Abstract setMouseInteractions

setMouseInteractions(state: boolean): this

Parameters
- state: boolean
Returns this

setMouseStyle

setMouseStyle(mouseStyle: UIMouseStyle): this

Parameters
- mouseStyle: UIMouseStyle
Returns this

Object itself

setOrigin

setOrigin(origin: Point): this

Parameters
- origin: Point
Returns this

setPosition

setPosition(position: Point): this

Parameters
- position: Point
Returns this