Interface Switchable

Interface for object that can be switched on/off and that can have respective event-subscriptions

Hierarchy

Switchable
- UICheckBox

Index

Methods

getLocked getOn offSwitch onSwitch setLocked setOn

Methods

getLocked

getLocked(): boolean
Returns
State of isLocked boolean flag

Returns boolean

getOn

getOn(): boolean
Returns
State as boolean flag

Returns boolean

offSwitch

offSwitch(token: Token): boolean
Remove event listener from Switch 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

onSwitch

onSwitch(listener: ((obj: Switchable, state: boolean) => void)): Token
Subscribe to Switch event

Returns
Token of subscription
Parameters
- listener: ((obj: Switchable, state: boolean) => void)
  - - (obj: Switchable, state: boolean): void
    - Parameters
      
      obj: Switchable
      
      state: boolean
      
      Returns void
Returns Token

setLocked

setLocked(isLocked: boolean): Switchable
Set whether Switchable is locked or not. When locked, clicking on the UI component will not switch its state.

Returns
State as boolean flag
Parameters
- isLocked: boolean
  
  state
Returns Switchable

setOn

setOn(isOn: boolean): Switchable
Set state of switchable object.

NOTE: If Switchable.getLocked() == true, this method will not do anything.!

Returns
Object itself for fluent interface
Parameters
- isOn: boolean
  
  State as boolean flag
Returns Switchable