SoftButtonObject Class Reference
Constructors
Instance Methods
- clone() ⇒
SoftButtonObject - equals(other) ⇒
Boolean - getButtonId() ⇒
Number - getCurrentState() ⇒
[SoftButtonState, null] - getCurrentStateName() ⇒
[String, null] - getCurrentStateSoftButton() ⇒
[SoftButton, null] - getName() ⇒
String - getOnEventListener() ⇒
[function, null] - getStates() ⇒
Array.<SoftButtonState> - setName(name) ⇒
SoftButtonObject - setOnEventListener(onEventListener) ⇒
SoftButtonObject - transitionToNextState()
- transitionToStateByName(newStateName) ⇒
Boolean
Constructors
new SoftButtonObject(name, states, initialStateName, onEventListener)
Create a new instance of the SoftButtonObject with multiple states
Instance Methods
softButtonObject.clone() ⇒ SoftButtonObject
Creates a deep copy of the object
Kind: Instance method of SoftButtonObject
Returns: SoftButtonObject deep copy of the object
softButtonObject.equals(other) ⇒ Boolean
Checks whether two SoftButtonObjects can be considered equivalent, but does NOT compare the listener objects
Kind: Instance method of SoftButtonObject
Returns: Boolean - Whether the objects are the same or not
| Param | Type | Description |
|---|---|---|
| other | SoftButtonObject |
The object to compare |
softButtonObject.getButtonId() ⇒ Number
Get the id of the SoftButtonObject
Kind: Instance method of SoftButtonObject
Returns: Number - an int value that represents the id of the SoftButtonObject
softButtonObject.getCurrentState() ⇒ [SoftButtonState, null]
Get the current state for the SoftButtonObject
Kind: Instance method of SoftButtonObject
Returns: [SoftButtonState, null] - a SoftButtonState represents the current state
softButtonObject.getCurrentStateName() ⇒ [String, null]
Get the name of the current state
Kind: Instance method of SoftButtonObject
Returns: [String, null] - a String that represents the name of the current state
softButtonObject.getCurrentStateSoftButton() ⇒ [SoftButton, null]
Get the SoftButton object for the current state
Kind: Instance method of SoftButtonObject
Returns: [SoftButton, null] - a SoftButton object that is associated with the current state
softButtonObject.getName() ⇒ String
Get the name of the SoftButtonObject
Kind: Instance method of SoftButtonObject
Returns: String - a String that represents the name of the SoftButtonObject
softButtonObject.getOnEventListener() ⇒ [function, null]
Get the event listener for the SoftButtonObject
Kind: Instance method of SoftButtonObject
Returns: [function, null] - The event listener function.
softButtonObject.getStates() ⇒ Array.<SoftButtonState>
Get the SoftButtonState list
Kind: Instance method of SoftButtonObject
Returns: Array.<SoftButtonState> - a list of the object's soft button states
softButtonObject.setName(name) ⇒ SoftButtonObject
Set the name of the SoftButtonObject
Kind: Instance method of SoftButtonObject
Returns: SoftButtonObject - A reference to this instance to support method chaining.
| Param | Type | Description |
|---|---|---|
| name | String |
a String that represents the name of the SoftButtonObject |
softButtonObject.setOnEventListener(onEventListener) ⇒ SoftButtonObject
Set the event listener for the SoftButtonObject
Kind: Instance method of SoftButtonObject
Returns: SoftButtonObject - A reference to this instance to support method chaining.
| Param | Type | Description |
|---|---|---|
| onEventListener | function |
a listener that has a callback that will be triggered when a button event or button press happens |
softButtonObject.transitionToNextState()
Transition the SoftButtonObject to the next state
Kind: Instance method of SoftButtonObject
softButtonObject.transitionToStateByName(newStateName) ⇒ Boolean
Transition the SoftButtonObject to a specific state
Kind: Instance method of SoftButtonObject
Returns: Boolean - a boolean value that represents whether the transition succeeded or failed
| Param | Type | Description |
|---|---|---|
| newStateName | String |
a String value represents the name fo the state that we want to transition the SoftButtonObject to |