All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.smartdevicelink.proxy.rpc.SoftButton Maven / Gradle / Ivy

/*
 * Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.smartdevicelink.proxy.rpc;

import androidx.annotation.NonNull;

import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.SoftButtonType;
import com.smartdevicelink.proxy.rpc.enums.SystemAction;

import java.util.Hashtable;

/**
 * 

A simulated button or keyboard key that is displayed on a touch screen.

* *

Parameter List

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
NameTypeDescriptionReg.NotesVersion
typeSoftButtonTypeDescribes, whether it is text, highlighted text, icon, or dynamic image. SmartDeviceLink 2.0
textStringOptional text to display (if defined as TEXT or BOTH)NMin: 0; Maxlength: 500SmartDeviceLink 2.0
imageImageOptional image struct for SoftButton (if defined as IMAGE or BOTH).SmartDeviceLink 2.0
isHighlightedBooleanTrue, if highlighted False, if not highlightedNSmartDeviceLink 2.0
softButtonIDIntegerValue which is returned via OnButtonPress / OnButtonEventMin: 0; Max: 65535SmartDeviceLink 2.0
systemActionSystemActionParameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.Ndefvalue: DEFAULT_ACTIONSmartDeviceLink 2.0
*/ public class SoftButton extends RPCStruct { public static final String KEY_IS_HIGHLIGHTED = "isHighlighted"; public static final String KEY_SOFT_BUTTON_ID = "softButtonID"; public static final String KEY_SYSTEM_ACTION = "systemAction"; public static final String KEY_TEXT = "text"; public static final String KEY_TYPE = "type"; public static final String KEY_IMAGE = "image"; public SoftButton() { } /** *

Constructs a new SoftButton object indicated by the Hashtable * parameter

* * @param hash The Hashtable to use */ public SoftButton(Hashtable hash) { super(hash); } /** * Constructs a new SoftButton object * * @param type Describes, whether it is text, highlighted text, icon, or dynamic image. * @param softButtonID Value which is returned via OnButtonPress / OnButtonEvent */ public SoftButton(@NonNull SoftButtonType type, @NonNull Integer softButtonID) { this(); setType(type); setSoftButtonID(softButtonID); } public SoftButton setType(@NonNull SoftButtonType type) { setValue(KEY_TYPE, type); return this; } public SoftButtonType getType() { return (SoftButtonType) getObject(SoftButtonType.class, KEY_TYPE); } public SoftButton setText(String text) { setValue(KEY_TEXT, text); return this; } public String getText() { return getString(KEY_TEXT); } public SoftButton setImage(Image image) { setValue(KEY_IMAGE, image); return this; } public Image getImage() { return (Image) getObject(Image.class, KEY_IMAGE); } public SoftButton setIsHighlighted(Boolean isHighlighted) { setValue(KEY_IS_HIGHLIGHTED, isHighlighted); return this; } public Boolean getIsHighlighted() { return getBoolean(KEY_IS_HIGHLIGHTED); } public SoftButton setSoftButtonID(@NonNull Integer softButtonID) { setValue(KEY_SOFT_BUTTON_ID, softButtonID); return this; } public Integer getSoftButtonID() { return getInteger(KEY_SOFT_BUTTON_ID); } public SoftButton setSystemAction(SystemAction systemAction) { setValue(KEY_SYSTEM_ACTION, systemAction); return this; } public SystemAction getSystemAction() { return (SystemAction) getObject(SystemAction.class, KEY_SYSTEM_ACTION); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy