Class MenuParams
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
- Package
- com.smartdevicelink.proxy.rpc
Overview
Used when adding a sub menu to an application menu or existing sub menu.Parameter List
| Name | Type | Description | Req. | SmartDeviceLink Ver. Available |
|---|---|---|---|---|
| parentID | Integer | The unique ID of an existing submenu to which a command will be added.
If this element is not provided, the command will be added to the top level of the Command Menu.
|
N | SmartDeviceLink 1.0 |
| position | Integer | Position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc.
Position of any submenu will always be located before the return and exit options.
|
N | SmartDeviceLink 1.0 |
| menuName | String | Text which appears in menu, representing this command.
|
Y | SmartDeviceLink 1.0 |
| secondaryText | String | Optional secondary text to display {"string_min_length": 1, "string_max_length": 500} |
N | SmartDeviceLink 7.1.0 |
| tertiaryText | String | Optional tertiary text to display {"string_min_length": 1, "string_max_length": 500} |
N | SmartDeviceLink 7.1.0 |
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_PARENT_ID
public static final java.lang.String KEY_PARENT_ID
- Constant Value
- "parentID"
KEY_POSITION
public static final java.lang.String KEY_POSITION
- Constant Value
- "position"
KEY_MENU_NAME
public static final java.lang.String KEY_MENU_NAME
- Constant Value
- "menuName"
KEY_SECONDARY_TEXT
public static final java.lang.String KEY_SECONDARY_TEXT
- Constant Value
- "secondaryText"
KEY_TERTIARY_TEXT
public static final java.lang.String KEY_TERTIARY_TEXT
- Constant Value
- "tertiaryText"
Inherited Fields
| From Class | Fields |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | KEY_BULK_DATA, KEY_PROTECTED, store |
Constructors
MenuParams()
Constructs a newly allocated MenuParams object
public MenuParams()
MenuParams( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a newly allocated MenuParams object indicated by the Hashtable parameter
public MenuParams(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
MenuParams( String menuName )
Constructs a newly allocated MenuParams object
public MenuParams(String menuName)
Constructor Parameters
- menuName
- the menu name
Methods
getParentID()
Get the unique ID of an existing submenu to which a command will be added. If this element is not provided, the command will be added to the top level of the Command Menu.
public java.lang.Integer getParentID()
setParentID( Integer parentID )
Set the unique ID of an existing submenu to which a command will be added. If this element is not provided, the command will be added to the top level of the Command Menu.
public com.smartdevicelink.proxy.rpc.MenuParams setParentID(Integer parentID)
Method Parameters
- parentID
- Min: 0; Max: 2000000000
getPosition()
Get the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.
- Min Value: 0
- Max Value: 1000
- If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
- If this element is omitted, the entry will be added at the end of the parent menu.
public java.lang.Integer getPosition()
setPosition( Integer position )
Set the position within the items of the parent Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.
- Min Value: 0
- Max Value: 1000
- If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
- If this element is omitted, the entry will be added at the end of the parent menu.
public com.smartdevicelink.proxy.rpc.MenuParams setPosition(Integer position)
Method Parameters
- position
- Mix: 0 Max: 1000
getMenuName()
Get the text which appears in menu, representing this command.
- Min: 1
- Max: 100
public java.lang.String getMenuName()
setMenuName( String menuName )
Set text which appears in menu, representing this command.
- Min: 1
- Max: 100
public com.smartdevicelink.proxy.rpc.MenuParams setMenuName(String menuName)
Method Parameters
- menuName
- the menu name
setSecondaryText( String secondaryText )
Sets the secondaryText.
public com.smartdevicelink.proxy.rpc.MenuParams setSecondaryText(String secondaryText)
Method Parameters
- secondaryText
- Optional secondary text to display {"string_min_length": 1, "string_max_length": 500}
getSecondaryText()
Gets the secondaryText.
public java.lang.String getSecondaryText()
setTertiaryText( String tertiaryText )
Sets the tertiaryText.
public com.smartdevicelink.proxy.rpc.MenuParams setTertiaryText(String tertiaryText)
Method Parameters
- tertiaryText
- Optional tertiary text to display {"string_min_length": 1, "string_max_length": 500}
getTertiaryText()
Gets the tertiaryText.
public java.lang.String getTertiaryText()
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |