java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
Add a SubMenu to the Command Menu
A SubMenu can only be added to the Top Level Menu (i.e.a SubMenu cannot be added to a SubMenu), and may only contain commands as children
HMILevel needs to be FULL, LIMITED or BACKGROUND
Parameter List
Param Name | Type | Description | Req. | Notes | Version Available | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
menuID | Integer | Unique ID that identifies this sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added. | Y | SmartDeviceLink 1.0 | |||||||||||
position | Integer | Position within the items of the top level 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 | Min Value: 0 Max Value: 1000 If position is greater or equal than the number of items on top level, the sub menu will be appended by the end. If this parameter is omitted, the entry will be added at the end of the list. |
SmartDeviceLink 1.0 | ||||||||||
menuName | String | Text which is displayed representing this submenu item | Y | maxlength:500 | SmartDeviceLink 1.0 | ||||||||||
menuIcon | Image | Image to be be shown along with the submenu item | N | SmartDeviceLink 5.0 | |||||||||||
menuLayout | MenuLayout | Sets the layout of the submenu screen. | SmartDeviceLink 6.0 | ||||||||||||
parentID | Integer | unique ID of the sub menu, the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu. | N | Min Value: 0 Max Value: 2000000000 |
SmartDeviceLink 7.0.0 | ||||||||||
secondaryText | String | Optional secondary text to display | N | {"string_min_length": 1, "string_max_length": 500} |
Quick Jump
FieldsKEY_POSITIONpublic static final java.lang.String KEY_POSITION
KEY_MENU_NAMEpublic static final java.lang.String KEY_MENU_NAME
KEY_MENU_IDpublic static final java.lang.String KEY_MENU_ID
KEY_MENU_ICONpublic static final java.lang.String KEY_MENU_ICON
KEY_MENU_LAYOUTpublic static final java.lang.String KEY_MENU_LAYOUT
KEY_PARENT_IDpublic static final java.lang.String KEY_PARENT_ID
KEY_SECONDARY_TEXTpublic static final java.lang.String KEY_SECONDARY_TEXT
KEY_TERTIARY_TEXTpublic static final java.lang.String KEY_TERTIARY_TEXT
KEY_SECONDARY_IMAGEpublic static final java.lang.String KEY_SECONDARY_IMAGE
Inherited FieldsConstructorsAddSubMenu()Constructs a new AddSubMenu object public AddSubMenu()
AddSubMenu( java.util.Hashtable<java.lang.String, java.lang.Object> hash )Constructs a new AddSubMenu object indicated by the Hashtable parameter public AddSubMenu(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Parameters
AddSubMenu( Integer menuID, String menuName )Constructs a new AddSubMenu object public AddSubMenu(Integer menuID,String menuName)
Parameters
MethodsgetMenuID()Returns an Integer object representing the Menu ID that identifies a sub menu public java.lang.Integer getMenuID()
setMenuID( Integer menuID )
Sets a Menu ID that identifies a sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added public com.smartdevicelink.proxy.rpc.AddSubMenu setMenuID(Integer menuID)
Parameters
getPosition()
Returns an Integer object representing the position of menu public java.lang.Integer getPosition()
setPosition( Integer position )Sets a position of menu public com.smartdevicelink.proxy.rpc.AddSubMenu setPosition(Integer position)
Parameters
getMenuName()Returns String which is displayed representing this submenu item public java.lang.String getMenuName()
setMenuName( String menuName )Sets a menuName which is displayed representing this submenu item public com.smartdevicelink.proxy.rpc.AddSubMenu setMenuName(String menuName)
Parameters
getMenuIcon()Returns Image to be be shown along with the submenu item public com.smartdevicelink.proxy.rpc.Image getMenuIcon()
setMenuIcon( Image menuIcon )Sets image to be be shown along with the submenu item public com.smartdevicelink.proxy.rpc.AddSubMenu setMenuIcon(Image menuIcon)
Parameters
setMenuLayout( MenuLayout menuLayout )Sets the layout of the submenu screen. public com.smartdevicelink.proxy.rpc.AddSubMenu setMenuLayout(MenuLayout menuLayout)
Parameters
getMenuLayout()Gets the layout of the submenu screen. public com.smartdevicelink.proxy.rpc.enums.MenuLayout getMenuLayout()
setParentID( Integer parentID )Sets the parentID. public com.smartdevicelink.proxy.rpc.AddSubMenu setParentID(Integer parentID)
Parameters
getParentID()Gets the parentID. public java.lang.Integer getParentID()
setSecondaryText( String secondaryText )Sets the secondaryText. public com.smartdevicelink.proxy.rpc.AddSubMenu setSecondaryText(String secondaryText)
Parameters
getSecondaryText()Gets the secondaryText. public java.lang.String getSecondaryText()
setTertiaryText( String tertiaryText )Sets the tertiaryText. public com.smartdevicelink.proxy.rpc.AddSubMenu setTertiaryText(String tertiaryText)
Parameters
getTertiaryText()Gets the tertiaryText. public java.lang.String getTertiaryText()
setSecondaryImage( Image secondaryImage )Sets the secondaryImage. public com.smartdevicelink.proxy.rpc.AddSubMenu setSecondaryImage(Image secondaryImage)
Parameters
getSecondaryImage()Gets the secondaryImage. public com.smartdevicelink.proxy.rpc.Image getSecondaryImage()
Inherited Methods
|