SoftButtonCapabilities Class Reference
Constructors
Instance Methods
- getImageSupported() ⇒
Boolean - getLongPressAvailable() ⇒
Boolean - getShortPressAvailable() ⇒
Boolean - getTextSupported() ⇒
Boolean - getUpDownAvailable() ⇒
Boolean - setImageSupported(supported) ⇒
SoftButtonCapabilities - setLongPressAvailable(available) ⇒
SoftButtonCapabilities - setShortPressAvailable(available) ⇒
SoftButtonCapabilities - setTextSupported(supported) ⇒
SoftButtonCapabilities - setUpDownAvailable(available) ⇒
SoftButtonCapabilities
Constructors
new SoftButtonCapabilities(parameters)
Initializes an instance of SoftButtonCapabilities.
Instance Methods
softButtonCapabilities.getImageSupported() ⇒ Boolean
Get the ImageSupported
Kind: Instance method of SoftButtonCapabilities
Returns: Boolean - the KEY_IMAGE_SUPPORTED value
softButtonCapabilities.getLongPressAvailable() ⇒ Boolean
Get the LongPressAvailable
Kind: Instance method of SoftButtonCapabilities
Returns: Boolean - the KEY_LONG_PRESS_AVAILABLE value
softButtonCapabilities.getShortPressAvailable() ⇒ Boolean
Get the ShortPressAvailable
Kind: Instance method of SoftButtonCapabilities
Returns: Boolean - the KEY_SHORT_PRESS_AVAILABLE value
softButtonCapabilities.getTextSupported() ⇒ Boolean
Get the TextSupported
Kind: Instance method of SoftButtonCapabilities
Returns: Boolean - the KEY_TEXT_SUPPORTED value
softButtonCapabilities.getUpDownAvailable() ⇒ Boolean
Get the UpDownAvailable
Kind: Instance method of SoftButtonCapabilities
Returns: Boolean - the KEY_UP_DOWN_AVAILABLE value
softButtonCapabilities.setImageSupported(supported) ⇒ SoftButtonCapabilities
Set the ImageSupported
Kind: Instance method of SoftButtonCapabilities
Returns: SoftButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| supported | Boolean |
The button supports referencing a static or dynamic image. - The desired ImageSupported. |
softButtonCapabilities.setLongPressAvailable(available) ⇒ SoftButtonCapabilities
Set the LongPressAvailable
Kind: Instance method of SoftButtonCapabilities
Returns: SoftButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
The button supports a LONG press. Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. - The desired LongPressAvailable. |
softButtonCapabilities.setShortPressAvailable(available) ⇒ SoftButtonCapabilities
Set the ShortPressAvailable
Kind: Instance method of SoftButtonCapabilities
Returns: SoftButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
The button supports a short press. Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. - The desired ShortPressAvailable. |
softButtonCapabilities.setTextSupported(supported) ⇒ SoftButtonCapabilities
Set the TextSupported
Kind: Instance method of SoftButtonCapabilities
Returns: SoftButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| supported | Boolean |
The button supports the use of text. If not included, the default value should be considered true that the button will support text. - The desired TextSupported. |
softButtonCapabilities.setUpDownAvailable(available) ⇒ SoftButtonCapabilities
Set the UpDownAvailable
Kind: Instance method of SoftButtonCapabilities
Returns: SoftButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
The button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. Whenever the button is released, onButtonEvent( UP) will be invoked. - The desired UpDownAvailable. |