Interface Interactable

Interface for object that can have mouse-event-subscriptions.

Hierarchy

Interactable
- UIPart

Implemented by

Methods

getMouseInteractions

getMouseInteractions(): boolean
Returns
Mouse interactions state

Returns boolean

offMouseClick

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseDoubleClick

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseDown

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseDrag

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseDragStart

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseDragStop

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseEnter

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseLeave

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseMove

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseUp

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offMouseWheel

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offTouchEnd

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offTouchMove

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

offTouchStart

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

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

onMouseClick

onMouseClick(listener: MouseEventHandler<Interactable>): Token
Subscribe on Mouse Enter click

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseDoubleClick

onMouseDoubleClick(listener: MouseEventHandler<Interactable>): Token
Subscribe to Mouse Double Click event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseDown

onMouseDown(listener: MouseEventHandler<Interactable>): Token
Subscribe to Mouse Down event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseDrag

onMouseDrag(listener: MouseDragEventHandler<Interactable>): Token
Subscribe to Mouse Drag event

Returns
Token of subscription
Parameters
- listener: MouseDragEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseDragStart

onMouseDragStart(listener: MouseDragStartEventHandler<Interactable>): Token
Subscribe to Mouse Drag Start event

Returns
Token of subscription
Parameters
- listener: MouseDragStartEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseDragStop

onMouseDragStop(listener: MouseDragStopEventHandler<Interactable>): Token
Subscribe to Mouse Drag Stop event

Returns
Token of subscription
Parameters
- listener: MouseDragStopEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseEnter

onMouseEnter(listener: MouseEventHandler<Interactable>): Token
Subscribe on Mouse Enter event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseLeave

onMouseLeave(listener: AbruptMouseEventHandler<Interactable>): Token
Subscribe on Mouse Enter leave

Returns
Token of subscription
Parameters
- listener: AbruptMouseEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseMove

onMouseMove(listener: MouseEventHandler<Interactable>): Token
Subscribe to Mouse Move event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseUp

onMouseUp(listener: MouseEventHandler<Interactable>): Token
Subscribe to Mouse Up event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<Interactable>
  
  Event handler function
Returns Token

onMouseWheel

onMouseWheel(listener: MouseWheelEventHandler<Interactable>): Token
Subscribe to Mouse Wheel event

Returns
Token of subscription
Parameters
- listener: MouseWheelEventHandler<Interactable>
  
  Event handler function
Returns Token

onTouchEnd

onTouchEnd(listener: TouchEventHandler<Interactable>): Token
Subscribe to Touch End event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<Interactable>
  
  Event handler function
Returns Token

onTouchMove

onTouchMove(listener: TouchEventHandler<Interactable>): Token
Subscribe to Touch Move event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<Interactable>
  
  Event handler function
Returns Token

onTouchStart

onTouchStart(listener: TouchEventHandler<Interactable>): Token
Subscribe to Touch Start event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<Interactable>
  
  Event handler function
Returns Token

setMouseInteractions

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

Returns
Object itself for fluent interface
Parameters
- state: boolean
  
  Specifies state of mouse interactions
Returns Interactable