ButtonName (sdl_android 5.3.1 API)

java.lang.Object
- java.lang.Enum<ButtonName>
- - com.smartdevicelink.proxy.rpc.enums.ButtonName

All Implemented Interfaces:

Serializable, Comparable<ButtonName>
```
public enum ButtonName
extends Enum<ButtonName>
```
Defines logical buttons which, on a given SDL unit, would correspond to either physical or soft (touchscreen) buttons. These logical buttons present a standard functional abstraction which the developer can rely upon, independent of the SDL unit. For example, the developer can rely upon the OK button having the same meaning to the user across SDL platforms.

The preset buttons (0-9) can typically be interpreted by the application as corresponding to some user-configured choices, though the application is free to interpret these button presses as it sees fit.

The application can discover which buttons a given SDL unit implements by interrogating the ButtonCapabilities parameter of the RegisterAppInterface response.

Since:

SmartDeviceLink 1.0

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AC`
`AC_MAX`
`CUSTOM_BUTTON`
`DEFROST`
`DEFROST_MAX`
`DEFROST_REAR`
`EJECT`
`FAN_DOWN`
`FAN_UP`
`LOWER_VENT`
`NAV_CENTER_LOCATION` Represents the center location button.
`NAV_HEADING_TOGGLE` Represents the heading toggle button If supported, this toggles between locking the orientation to north or to the vehicle's heading.
`NAV_PAN_DOWN` Represents the pan down button.
`NAV_PAN_DOWN_LEFT` Represents the pan down-left button.
`NAV_PAN_DOWN_RIGHT` Represents the pan down-right button.
`NAV_PAN_LEFT` Represents the pan left button.
`NAV_PAN_RIGHT` Represents the pan right button.
`NAV_PAN_UP` Represents the pan up button.
`NAV_PAN_UP_LEFT` Represents the pan up-left button.
`NAV_PAN_UP_RIGHT` Represents the pan up-right button.
`NAV_ROTATE_CLOCKWISE` Represents the rotate clockwise button
`NAV_ROTATE_COUNTERCLOCKWISE` Represents the rotate counterclockwise button
`NAV_TILT_TOGGLE` Represents the title toggle button If supported, this toggles between a top-down view and an angled/3D view.
`NAV_ZOOM_IN` Represents the the zoom in button.
`NAV_ZOOM_OUT` Represents the zoom out button.
`OK` THIS ENUM VALUE WILL CHANGE IN FUNCTIONALITY DURING THE NEXT MAJOR RELEASE! This ButtonName value originally was used for both the OK button and PLAY_PAUSE button.
`PLAY_PAUSE` Represents the play/pause button.
`PRESET_0` Represents the preset 0 button.
`PRESET_1` Represents the preset 1 button.
`PRESET_2` Represents the preset 2 button.
`PRESET_3` Represents the preset 3 button.
`PRESET_4` Represents the preset 4 button.
`PRESET_5` Represents the preset 5 button.
`PRESET_6` Represents the preset 6 button.
`PRESET_7` Represents the preset 7 button.
`PRESET_8` Represents the preset 8 button.
`PRESET_9` Represents the preset 9 button.
`RECIRCULATE`
`REPEAT`
`SEARCH`
`SEEKLEFT` Represents the seek-left button.
`SEEKRIGHT` Represents the seek-right button.
`SHUFFLE`
`SOURCE`
`TEMP_DOWN`
`TEMP_UP`
`TUNEDOWN` Represents a turn of the tuner knob in the counter-clockwise direction one tick.
`TUNEUP` Represents a turn of the tuner knob in the clockwise direction one tick.
`UPPER_VENT`
`VOLUME_DOWN`
`VOLUME_UP`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Integer`	`indexForPresetButton(ButtonName buttonName)` indexForPresetButton returns the integer index for preset buttons which match the preset order.
`static ButtonName`	`valueForString(String value)`
`static ButtonName`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ButtonName[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - OK
```
public static final ButtonName OK
```
    THIS ENUM VALUE WILL CHANGE IN FUNCTIONALITY DURING THE NEXT MAJOR RELEASE!
    
    This ButtonName value originally was used for both the OK button and PLAY_PAUSE button. As of SmartDeviceLink 5.0.0, the functionality was broken out into the OK and PLAY_PAUSE buttons.
    
    For this version of the library OK will be received for both OK and PLAY_PAUSE to mitigate a potential break in functionality. If the desire is only for the OK functionality, this button should still be used. If the desired functionality was actually for the play/pause toggle, then the new PLAY_PAUSE should be used.
    
    Represents the button usually labeled "OK". A typical use of this button is for the user to press it to make a selection (and until a major library version release, play pause toggle).
    
    Since:
    
    SmartDeviceLink 1.0
    
    See Also:
    
    PLAY_PAUSE
  - SEEKLEFT
```
public static final ButtonName SEEKLEFT
```
    Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.
    
    Since:
    
    SmartDeviceLink 1.0
  - SEEKRIGHT
```
public static final ButtonName SEEKRIGHT
```
    Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.
    
    Since:
    
    SmartDeviceLink 1.0
  - TUNEUP
```
public static final ButtonName TUNEUP
```
    Represents a turn of the tuner knob in the clockwise direction one tick.
    
    Since:
    
    SmartDeviceLink 1.0
  - TUNEDOWN
```
public static final ButtonName TUNEDOWN
```
    Represents a turn of the tuner knob in the counter-clockwise direction one tick.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_0
```
public static final ButtonName PRESET_0
```
    Represents the preset 0 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_1
```
public static final ButtonName PRESET_1
```
    Represents the preset 1 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_2
```
public static final ButtonName PRESET_2
```
    Represents the preset 2 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_3
```
public static final ButtonName PRESET_3
```
    Represents the preset 3 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_4
```
public static final ButtonName PRESET_4
```
    Represents the preset 4 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_5
```
public static final ButtonName PRESET_5
```
    Represents the preset 5 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_6
```
public static final ButtonName PRESET_6
```
    Represents the preset 6 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_7
```
public static final ButtonName PRESET_7
```
    Represents the preset 7 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_8
```
public static final ButtonName PRESET_8
```
    Represents the preset 8 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - PRESET_9
```
public static final ButtonName PRESET_9
```
    Represents the preset 9 button.
    
    Since:
    
    SmartDeviceLink 1.0
  - CUSTOM_BUTTON
```
public static final ButtonName CUSTOM_BUTTON
```
  - SEARCH
```
public static final ButtonName SEARCH
```
  - AC_MAX
```
public static final ButtonName AC_MAX
```
  - AC
```
public static final ButtonName AC
```
  - RECIRCULATE
```
public static final ButtonName RECIRCULATE
```
  - FAN_UP
```
public static final ButtonName FAN_UP
```
  - FAN_DOWN
```
public static final ButtonName FAN_DOWN
```
  - TEMP_UP
```
public static final ButtonName TEMP_UP
```
  - TEMP_DOWN
```
public static final ButtonName TEMP_DOWN
```
  - DEFROST_MAX
```
public static final ButtonName DEFROST_MAX
```
  - DEFROST
```
public static final ButtonName DEFROST
```
  - DEFROST_REAR
```
public static final ButtonName DEFROST_REAR
```
  - UPPER_VENT
```
public static final ButtonName UPPER_VENT
```
  - LOWER_VENT
```
public static final ButtonName LOWER_VENT
```
  - VOLUME_UP
```
public static final ButtonName VOLUME_UP
```
  - VOLUME_DOWN
```
public static final ButtonName VOLUME_DOWN
```
  - EJECT
```
public static final ButtonName EJECT
```
  - SOURCE
```
public static final ButtonName SOURCE
```
  - SHUFFLE
```
public static final ButtonName SHUFFLE
```
  - REPEAT
```
public static final ButtonName REPEAT
```
  - PLAY_PAUSE
```
public static final ButtonName PLAY_PAUSE
```
    Represents the play/pause button. A typical use of this button is for the user to press it to toggle between media playing and pausing.
    
    NOTE: This functionality used to be represented by the OK button.
    
    Since:
    
    SmartDeviceLink 5.0
    
    See Also:
    
    OK
  - NAV_CENTER_LOCATION
```
public static final ButtonName NAV_CENTER_LOCATION
```
    Represents the center location button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_ZOOM_IN
```
public static final ButtonName NAV_ZOOM_IN
```
    Represents the the zoom in button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_ZOOM_OUT
```
public static final ButtonName NAV_ZOOM_OUT
```
    Represents the zoom out button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_PAN_UP
```
public static final ButtonName NAV_PAN_UP
```
    Represents the pan up button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_PAN_UP_RIGHT
```
public static final ButtonName NAV_PAN_UP_RIGHT
```
    Represents the pan up-right button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_PAN_RIGHT
```
public static final ButtonName NAV_PAN_RIGHT
```
    Represents the pan right button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_PAN_DOWN_RIGHT
```
public static final ButtonName NAV_PAN_DOWN_RIGHT
```
    Represents the pan down-right button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_PAN_DOWN
```
public static final ButtonName NAV_PAN_DOWN
```
    Represents the pan down button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_PAN_DOWN_LEFT
```
public static final ButtonName NAV_PAN_DOWN_LEFT
```
    Represents the pan down-left button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_PAN_LEFT
```
public static final ButtonName NAV_PAN_LEFT
```
    Represents the pan left button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_PAN_UP_LEFT
```
public static final ButtonName NAV_PAN_UP_LEFT
```
    Represents the pan up-left button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_TILT_TOGGLE
```
public static final ButtonName NAV_TILT_TOGGLE
```
    Represents the title toggle button If supported, this toggles between a top-down view and an angled/3D view. If your app supports different, but substantially similar options, then you may implement those. If you don't implement these or similar options, do not subscribe to this button.
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_ROTATE_CLOCKWISE
```
public static final ButtonName NAV_ROTATE_CLOCKWISE
```
    Represents the rotate clockwise button
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_ROTATE_COUNTERCLOCKWISE
```
public static final ButtonName NAV_ROTATE_COUNTERCLOCKWISE
```
    Represents the rotate counterclockwise button
    
    Since:
    
    SmartDeviceLink 6.0
  - NAV_HEADING_TOGGLE
```
public static final ButtonName NAV_HEADING_TOGGLE
```
    Represents the heading toggle button If supported, this toggles between locking the orientation to north or to the vehicle's heading. If your app supports different, but substantially similar options, then you may implement those. If you don't implement these or similar options, do not subscribe to this button.
    
    Since:
    
    SmartDeviceLink 6.0
- Method Detail
  - values
```
public static ButtonName[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ButtonName c : ButtonName.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ButtonName valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - valueForString
```
public static ButtonName valueForString(String value)
```
  - indexForPresetButton
```
public static Integer indexForPresetButton(ButtonName buttonName)
```
    indexForPresetButton returns the integer index for preset buttons which match the preset order. E.G.: indexForPresetButton(PRESET_1) returns the value 1. If the buttonName given is not a preset button, the method will return null.
    
    Parameters:
    
    buttonName - the buttonName of PRESET_0 through PRESET_9 to
    
    Returns:
    
    Integer that represents which preset the supplied button name represents. It will return null if the ButtonName is not one of the PRESET_# names.

Enum ButtonName

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OK

SEEKLEFT

SEEKRIGHT

TUNEUP

TUNEDOWN

PRESET_0

PRESET_1

PRESET_2

PRESET_3

PRESET_4

PRESET_5

PRESET_6

PRESET_7

PRESET_8

PRESET_9

CUSTOM_BUTTON

SEARCH

AC_MAX

AC

RECIRCULATE

FAN_UP

FAN_DOWN

TEMP_UP

TEMP_DOWN

DEFROST_MAX

DEFROST

DEFROST_REAR

UPPER_VENT

LOWER_VENT

VOLUME_UP

VOLUME_DOWN

EJECT

SOURCE

SHUFFLE

REPEAT

PLAY_PAUSE

NAV_CENTER_LOCATION

NAV_ZOOM_IN

NAV_ZOOM_OUT

NAV_PAN_UP

NAV_PAN_UP_RIGHT

NAV_PAN_RIGHT

NAV_PAN_DOWN_RIGHT

NAV_PAN_DOWN

NAV_PAN_DOWN_LEFT

NAV_PAN_LEFT

NAV_PAN_UP_LEFT

NAV_TILT_TOGGLE

NAV_ROTATE_CLOCKWISE

NAV_ROTATE_COUNTERCLOCKWISE

NAV_HEADING_TOGGLE

Method Detail

values

valueOf

valueForString

indexForPresetButton