Merge pull request #370 from smartdevicelink/feature/main_menu_ui_updates

Main Menu UI Updates

Author: renonick87

lib/js/src/rpc/enums/ImageFieldName.js

@@ -196,6 +196,26 @@ class ImageFieldName extends Enum {
         return ImageFieldName._MAP.subtleAlertIcon;
     }
 
+    /**
+     * Get the enum value for menuCommandSecondaryImage.
+     * @since SmartDeviceLink 7.1.0
+     * The secondary image field for AddCommand
+     * @returns {String} - The enum value.
+     */
+    static get menuCommandSecondaryImage () {
+        return ImageFieldName._MAP.menuCommandSecondaryImage;
+    }
+
+    /**
+     * Get the enum value for menuSubMenuSecondaryImage.
+     * @since SmartDeviceLink 7.1.0
+     * The secondary image field for AddSubMenu
+     * @returns {String} - The enum value.
+     */
+    static get menuSubMenuSecondaryImage () {
+        return ImageFieldName._MAP.menuSubMenuSecondaryImage;
+    }
+
     /**
      * Get the value for the given enum key
      * @param {*} key - A key to find in the map of the subclass
@@ -240,6 +260,8 @@ ImageFieldName._MAP = Object.freeze({
     'alertIcon': 'alertIcon',
     'subMenuIcon': 'subMenuIcon',
     'subtleAlertIcon': 'subtleAlertIcon',
+    'menuCommandSecondaryImage': 'menuCommandSecondaryImage',
+    'menuSubMenuSecondaryImage': 'menuSubMenuSecondaryImage',
 });
 
 export { ImageFieldName };

lib/js/src/rpc/enums/TextFieldName.js

@@ -377,6 +377,46 @@ class TextFieldName extends Enum {
         return TextFieldName._MAP.subtleAlertSoftButtonText;
     }
 
+    /**
+     * Get the enum value for menuCommandSecondaryText.
+     * @since SmartDeviceLink 7.1.0
+     * Secondary text for AddCommand
+     * @returns {String} - The enum value.
+     */
+    static get menuCommandSecondaryText () {
+        return TextFieldName._MAP.menuCommandSecondaryText;
+    }
+
+    /**
+     * Get the enum value for menuCommandTertiaryText.
+     * @since SmartDeviceLink 7.1.0
+     * Tertiary text for AddCommand
+     * @returns {String} - The enum value.
+     */
+    static get menuCommandTertiaryText () {
+        return TextFieldName._MAP.menuCommandTertiaryText;
+    }
+
+    /**
+     * Get the enum value for menuSubMenuSecondaryText.
+     * @since SmartDeviceLink 7.1.0
+     * Secondary text for AddSubMenu
+     * @returns {String} - The enum value.
+     */
+    static get menuSubMenuSecondaryText () {
+        return TextFieldName._MAP.menuSubMenuSecondaryText;
+    }
+
+    /**
+     * Get the enum value for menuSubMenuTertiaryText.
+     * @since SmartDeviceLink 7.1.0
+     * Tertiary text for AddSubMenu
+     * @returns {String} - The enum value.
+     */
+    static get menuSubMenuTertiaryText () {
+        return TextFieldName._MAP.menuSubMenuTertiaryText;
+    }
+
     /**
      * Get the value for the given enum key
      * @param {*} key - A key to find in the map of the subclass
@@ -439,6 +479,10 @@ TextFieldName._MAP = Object.freeze({
     'subtleAlertText1': 'subtleAlertText1',
     'subtleAlertText2': 'subtleAlertText2',
     'subtleAlertSoftButtonText': 'subtleAlertSoftButtonText',
+    'menuCommandSecondaryText': 'menuCommandSecondaryText',
+    'menuCommandTertiaryText': 'menuCommandTertiaryText',
+    'menuSubMenuSecondaryText': 'menuSubMenuSecondaryText',
+    'menuSubMenuTertiaryText': 'menuSubMenuTertiaryText',
 });
 
 export { TextFieldName };

lib/js/src/rpc/messages/AddCommand.js

@@ -127,11 +127,32 @@ class AddCommand extends RpcRequest {
     getCmdIcon () {
         return this.getObject(Image, AddCommand.KEY_CMD_ICON);
     }
+
+    /**
+     * Set the SecondaryImage
+     * @since SmartDeviceLink 7.1.0
+     * @param {Image} image - Optional secondary image struct for menu cell - The desired SecondaryImage.
+     * @returns {AddCommand} - The class instance for method chaining.
+     */
+    setSecondaryImage (image) {
+        this._validateType(Image, image);
+        this.setParameter(AddCommand.KEY_SECONDARY_IMAGE, image);
+        return this;
+    }
+
+    /**
+     * Get the SecondaryImage
+     * @returns {Image} - the KEY_SECONDARY_IMAGE value
+     */
+    getSecondaryImage () {
+        return this.getObject(Image, AddCommand.KEY_SECONDARY_IMAGE);
+    }
 }
 
 AddCommand.KEY_CMD_ID = 'cmdID';
 AddCommand.KEY_MENU_PARAMS = 'menuParams';
 AddCommand.KEY_VR_COMMANDS = 'vrCommands';
 AddCommand.KEY_CMD_ICON = 'cmdIcon';
+AddCommand.KEY_SECONDARY_IMAGE = 'secondaryImage';
 
 export { AddCommand };

lib/js/src/rpc/messages/AddSubMenu.js

@@ -167,6 +167,66 @@ class AddSubMenu extends RpcRequest {
     getParentID () {
         return this.getParameter(AddSubMenu.KEY_PARENT_ID);
     }
+
+    /**
+     * Set the SecondaryText
+     * @since SmartDeviceLink 7.1.0
+     * @param {String} text - Optional secondary text to display - The desired SecondaryText.
+     * {'string_min_length': 1, 'string_max_length': 500}
+     * @returns {AddSubMenu} - The class instance for method chaining.
+     */
+    setSecondaryText (text) {
+        this.setParameter(AddSubMenu.KEY_SECONDARY_TEXT, text);
+        return this;
+    }
+
+    /**
+     * Get the SecondaryText
+     * @returns {String} - the KEY_SECONDARY_TEXT value
+     */
+    getSecondaryText () {
+        return this.getParameter(AddSubMenu.KEY_SECONDARY_TEXT);
+    }
+
+    /**
+     * Set the TertiaryText
+     * @since SmartDeviceLink 7.1.0
+     * @param {String} text - Optional tertiary text to display - The desired TertiaryText.
+     * {'string_min_length': 1, 'string_max_length': 500}
+     * @returns {AddSubMenu} - The class instance for method chaining.
+     */
+    setTertiaryText (text) {
+        this.setParameter(AddSubMenu.KEY_TERTIARY_TEXT, text);
+        return this;
+    }
+
+    /**
+     * Get the TertiaryText
+     * @returns {String} - the KEY_TERTIARY_TEXT value
+     */
+    getTertiaryText () {
+        return this.getParameter(AddSubMenu.KEY_TERTIARY_TEXT);
+    }
+
+    /**
+     * Set the SecondaryImage
+     * @since SmartDeviceLink 7.1.0
+     * @param {Image} image - Optional secondary image struct for sub-menu cell - The desired SecondaryImage.
+     * @returns {AddSubMenu} - The class instance for method chaining.
+     */
+    setSecondaryImage (image) {
+        this._validateType(Image, image);
+        this.setParameter(AddSubMenu.KEY_SECONDARY_IMAGE, image);
+        return this;
+    }
+
+    /**
+     * Get the SecondaryImage
+     * @returns {Image} - the KEY_SECONDARY_IMAGE value
+     */
+    getSecondaryImage () {
+        return this.getObject(Image, AddSubMenu.KEY_SECONDARY_IMAGE);
+    }
 }
 
 AddSubMenu.KEY_MENU_ID = 'menuID';
@@ -175,5 +235,8 @@ AddSubMenu.KEY_MENU_NAME = 'menuName';
 AddSubMenu.KEY_MENU_ICON = 'menuIcon';
 AddSubMenu.KEY_MENU_LAYOUT = 'menuLayout';
 AddSubMenu.KEY_PARENT_ID = 'parentID';
+AddSubMenu.KEY_SECONDARY_TEXT = 'secondaryText';
+AddSubMenu.KEY_TERTIARY_TEXT = 'tertiaryText';
+AddSubMenu.KEY_SECONDARY_IMAGE = 'secondaryImage';
 
 export { AddSubMenu };

lib/js/src/rpc/structs/MenuParams.js

@@ -100,10 +100,52 @@ class MenuParams extends RpcStruct {
     getMenuName () {
         return this.getParameter(MenuParams.KEY_MENU_NAME);
     }
+
+    /**
+     * Set the SecondaryText
+     * @since SmartDeviceLink 7.1.0
+     * @param {String} text - Optional secondary text to display - The desired SecondaryText.
+     * {'string_min_length': 1, 'string_max_length': 500}
+     * @returns {MenuParams} - The class instance for method chaining.
+     */
+    setSecondaryText (text) {
+        this.setParameter(MenuParams.KEY_SECONDARY_TEXT, text);
+        return this;
+    }
+
+    /**
+     * Get the SecondaryText
+     * @returns {String} - the KEY_SECONDARY_TEXT value
+     */
+    getSecondaryText () {
+        return this.getParameter(MenuParams.KEY_SECONDARY_TEXT);
+    }
+
+    /**
+     * Set the TertiaryText
+     * @since SmartDeviceLink 7.1.0
+     * @param {String} text - Optional tertiary text to display - The desired TertiaryText.
+     * {'string_min_length': 1, 'string_max_length': 500}
+     * @returns {MenuParams} - The class instance for method chaining.
+     */
+    setTertiaryText (text) {
+        this.setParameter(MenuParams.KEY_TERTIARY_TEXT, text);
+        return this;
+    }
+
+    /**
+     * Get the TertiaryText
+     * @returns {String} - the KEY_TERTIARY_TEXT value
+     */
+    getTertiaryText () {
+        return this.getParameter(MenuParams.KEY_TERTIARY_TEXT);
+    }
 }
 
 MenuParams.KEY_PARENT_ID = 'parentID';
 MenuParams.KEY_POSITION = 'position';
 MenuParams.KEY_MENU_NAME = 'menuName';
+MenuParams.KEY_SECONDARY_TEXT = 'secondaryText';
+MenuParams.KEY_TERTIARY_TEXT = 'tertiaryText';
 
 export { MenuParams };