Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class ButtonName

Hierarchy

java.lang.Object
     java.lang.Enum

Package
com.smartdevicelink.proxy.rpc.enums

Overview

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.

Methods

values()

public static com.smartdevicelink.proxy.rpc.enums.ButtonName values()

valueOf( String name )

public static com.smartdevicelink.proxy.rpc.enums.ButtonName valueOf(String name)

Parameters

name

valueForString( String value )

public static com.smartdevicelink.proxy.rpc.enums.ButtonName valueForString(String value)

Parameters

value

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.

public static java.lang.Integer indexForPresetButton(ButtonName buttonName)

Parameters

buttonName

Inherited Methods

From Class Methods
java.lang.Enum name, ordinal, toString, equals, hashCode, clone, compareTo, getDeclaringClass, valueOf, finalize
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section