Class UIObject`Abstract`

Base class for Mouse-interactable ui-objects.

Hierarchy

UIObject

Implements

Constructors

constructor

new UIObject(): UIObject
Returns UIObject

Methods

getIsUnderMouse

getIsUnderMouse(): boolean
Get boolean flag for whether object is currently under mouse or not

Returns
Boolean for is object under mouse currently

Returns boolean

`Abstract` getMouseInteractions

getMouseInteractions(): boolean
Returns
Mouse interactions state

Returns boolean

Implementation of Interactable.getMouseInteractions

getVisible

getVisible(): boolean
Get element visibility.

Returns
true when element is set to be visible and false otherwise.

Returns boolean

Implementation of Hideable.getVisible

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

Implementation of Interactable.offMouseClick

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

Implementation of Interactable.offMouseDoubleClick

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

Implementation of Interactable.offMouseDown

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

Implementation of Interactable.offMouseDrag

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

Implementation of Interactable.offMouseDragStart

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

Implementation of Interactable.offMouseDragStop

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

Implementation of Interactable.offMouseEnter

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

Implementation of Interactable.offMouseLeave

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

Implementation of Interactable.offMouseMove

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

Implementation of Interactable.offMouseUp

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

Implementation of Interactable.offMouseWheel

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

Implementation of Interactable.offTouchEnd

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

Implementation of Interactable.offTouchMove

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

Implementation of Interactable.offTouchStart

offVisibleStateChanged

offVisibleStateChanged(token: Token): boolean
Remove event listener from visibleStateChanged
Parameters
- token: Token
Returns boolean

Implementation of HideableEvents.offVisibleStateChanged

onMouseClick

onMouseClick(listener: MouseEventHandler<UIObject>): Token
Subscribe to Mouse Click event

Returns
Token-object that is a reference ID to the listener created.
Parameters
- listener: MouseEventHandler<UIObject>
  
  Function that will be called when mouse clicks the bounds of UiObject.
Returns Token

Implementation of Interactable.onMouseClick

onMouseDoubleClick

onMouseDoubleClick(listener: MouseEventHandler<UIObject>): Token
Subscribe to Mouse Double Click event
Parameters
- listener: MouseEventHandler<UIObject>
Returns Token

Implementation of Interactable.onMouseDoubleClick

onMouseDown

onMouseDown(listener: MouseEventHandler<UIObject>): Token
Subscribe to Mouse Down event
Parameters
- listener: MouseEventHandler<UIObject>
Returns Token

Implementation of Interactable.onMouseDown

onMouseDrag

onMouseDrag(listener: MouseDragEventHandler<UIObject>): Token
Subscribe to Mouse Drag event
Parameters
- listener: MouseDragEventHandler<UIObject>
Returns Token

Implementation of Interactable.onMouseDrag

onMouseDragStart

onMouseDragStart(listener: MouseDragStartEventHandler<UIObject>): Token
Subscribe to Mouse Drag Start event
Parameters
- listener: MouseDragStartEventHandler<UIObject>
Returns Token

Implementation of Interactable.onMouseDragStart

onMouseDragStop

onMouseDragStop(listener: MouseDragStopEventHandler<UIObject>): Token
Subscribe to Mouse Drag Stop event
Parameters
- listener: MouseDragStopEventHandler<UIObject>
Returns Token

Implementation of Interactable.onMouseDragStop

onMouseEnter

onMouseEnter(listener: MouseEventHandler<UIObject>): Token
Subscribe to Mouse Enter event

Returns
Token-object that is a reference ID to the listener created.
Parameters
- listener: MouseEventHandler<UIObject>
  
  Function that will be called when mouse enters the bounds of UiObject.
Returns Token

Implementation of Interactable.onMouseEnter

onMouseLeave

onMouseLeave(listener: AbruptMouseEventHandler<UIObject>): Token
Subscribe to Mouse Leave event

Returns
Token-object that is a reference ID to the listener created.
Parameters
- listener: AbruptMouseEventHandler<UIObject>
  
  Function that will be called when mouse leaves the bounds of UiObject.
Returns Token

Implementation of Interactable.onMouseLeave

onMouseMove

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

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

Implementation of Interactable.onMouseMove

onMouseUp

onMouseUp(listener: MouseEventHandler<UIObject>): Token
Subscribe to Mouse Up event
Parameters
- listener: MouseEventHandler<UIObject>
Returns Token

Implementation of Interactable.onMouseUp

onMouseWheel

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

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

Implementation of Interactable.onMouseWheel

onTouchEnd

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

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

Implementation of Interactable.onTouchEnd

onTouchMove

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

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

Implementation of Interactable.onTouchMove

onTouchStart

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

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

Implementation of Interactable.onTouchStart

onVisibleStateChanged

onVisibleStateChanged(listener: VisibleStateChangedHandler<UIObject>): Token
Register new event listener to visibleStateChanged event.
Parameters
- listener: VisibleStateChangedHandler<UIObject>
  
  Event listener for visibleStateChanged
Returns Token

Implementation of HideableEvents.onVisibleStateChanged

`Abstract` setMouseInteractions

setMouseInteractions(state: boolean): UIObject
Set mouse interactions enabled. Implementations should update the mouse-interactions of any Shapes they may contain here.
Parameters
- state: boolean
Returns UIObject

Implementation of Interactable.setMouseInteractions

setVisible

setVisible(state: boolean): UIObject
Set element visibility.

Returns
Object itself.
Parameters
- state: boolean
  
  true when element should be visible and false when element should be hidden.
Returns UIObject

Implementation of Hideable.setVisible