• Home
• com.smartdevicelink
• sdl_java_se
• 5.5.0
• source code
• Slider.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.smartdevicelink.proxy.rpc.Slider 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.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;

import java.util.Hashtable;
import java.util.List;

/**
 * Creates a full screen or pop-up overlay (depending on platform) with a single user controlled slider.
 * 

 * If connecting to SDL Core v.6.0+, the slider can be canceled programmatically using the `cancelID`. On older versions of SDL Core, the slider will persist until the user has interacted with the slider or the specified timeout has elapsed.
 *
 * 
Function Group: Base
 *
 * 
HMILevel needs to be FULL
 *
 * 
Parameter List
 * 
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 *
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 *
 * 		
 * 			
 * 			
 * 			
 *                 
 * 			
 * 			
 * 		
 * 		
 * 			
 * 			
 * 			
 *          
 * 			
 * 			
 * 		
 *  
Param Name
Type
Description
 Req.
Notes
Version Available
numTicks
Integer
Number of selectable items on a horizontal axis.
Y
Minvalue=2; Maxvalue=26
SmartDeviceLink 2.0
position
Integer
Initial position of slider control (cannot exceed numTicks),
Y
Minvalue=1; Maxvalue=26
SmartDeviceLink 2.0
sliderHeader
String
Text header to display
N
Maxlength=500
SmartDeviceLink 2.0
sliderFooter
Integer
Text footer to display (meant to display min/max threshold descriptors).
For a static text footer, only one footer string shall be provided in the array. For a dynamic text footer, the number of footer text string in the array must match the numTicks value.For a dynamic text footer, text array string should correlate with potential slider position index.If omitted on supported displays, no footer text shall be displayed.
N
Maxlength=500; Minvalue=1; Maxvalue=26
SmartDeviceLink 2.0
timeout
String
App defined timeout.  Indicates how long of a timeout in milliseconds from the last action (i.e. sliding control resets timeout). If omitted, the value is set to 10000.
N
Minvalue=0; Maxvalue=65535; Defvalue= 10000
SmartDeviceLink 2.0
cancelID
Integer
An ID for this specific slider to allow cancellation through the `CancelInteraction` RPC.
N
SmartDeviceLink 6.0
 * 
Response 
 *
 * 
Non-default Result Codes:
 * 	
 SAVED 
 * 	
 INVALID_DATA
 * 	
OUT_OF_MEMORY
 * 	
TOO_MANY_PENDING_REQUESTS
 * 	
APPLICATION_NOT_REGISTERED
 * 	
GENERIC_ERROR
 * 
	DISALLOWED
 * 
	UNSUPPORTED_RESOURCE 
 * 
	 REJECTED   
 * 	
ABORTED 
 *
 * @since SmartDeviceLink 2.0
 */
public class Slider extends RPCRequest {

    public static final String KEY_NUM_TICKS = "numTicks";
    public static final String KEY_SLIDER_HEADER = "sliderHeader";
    public static final String KEY_SLIDER_FOOTER = "sliderFooter";
    public static final String KEY_POSITION = "position";
    public static final String KEY_TIMEOUT = "timeout";
    public static final String KEY_CANCEL_ID = "cancelID";

    /**
     * Constructs a new Slider object
     */
    public Slider() {
        super(FunctionID.SLIDER.toString());
    }

    /**
     * Constructs a new Slider object indicated by the Hashtable parameter
     * 

     *
     * @param hash The Hashtable to use
     */
    public Slider(Hashtable hash) {
        super(hash);
    }

    /**
     * Constructs a new Slider object \
     *
     * @param numTicks     Number of selectable items on a horizontal axis.
     * @param position     Initial position of slider control (cannot exceed numTicks)
     * @param sliderHeader Text header to display
     */
    public Slider(@NonNull Integer numTicks, @NonNull Integer position, @NonNull String sliderHeader) {
        this();
        setNumTicks(numTicks);
        setPosition(position);
        setSliderHeader(sliderHeader);
    }

    /**
     * Sets a number of selectable items on a horizontal axis
     *
     * @param numTicks an Integer value representing a number of selectable items on
     *                 a horizontal axis
     *                 

     *                 Notes: Minvalue=2; Maxvalue=26
     */
    public Slider setNumTicks(@NonNull Integer numTicks) {
        setParameters(KEY_NUM_TICKS, numTicks);
        return this;
    }

    /**
     * Gets a number of selectable items on a horizontal axis
     *
     * @return Integer -an Integer value representing a number of selectable
     * items on a horizontal axis
     */
    public Integer getNumTicks() {
        return getInteger(KEY_NUM_TICKS);
    }

    /**
     * Sets an Initial position of slider control
     *
     * @param position an Integer value representing an Initial position of slider
     *                 control
     *                 

     *                 Notes: Minvalue=1; Maxvalue=26
     */
    public Slider setPosition(@NonNull Integer position) {
        setParameters(KEY_POSITION, position);
        return this;
    }

    /**
     * Gets an Initial position of slider control
     *
     * @return Integer -an Integer value representing an Initial position of
     * slider control
     */
    public Integer getPosition() {
        return getInteger(KEY_POSITION);
    }

    /**
     * Sets a text header to display
     *
     * @param sliderHeader a String value
     *                     

     *                     Notes: Maxlength=500
     */
    public Slider setSliderHeader(@NonNull String sliderHeader) {
        setParameters(KEY_SLIDER_HEADER, sliderHeader);
        return this;
    }

    /**
     * Gets a text header to display
     *
     * @return String -a String value representing a text header to display
     */
    public String getSliderHeader() {
        return getString(KEY_SLIDER_HEADER);
    }

    /**
     * Sets a text footer to display
     *
     * @param sliderFooter a List value representing a text footer to display
     *                     

     *                     Notes: Maxlength=500; Minvalue=1; Maxvalue=26
     */
    public Slider setSliderFooter(List sliderFooter) {
        setParameters(KEY_SLIDER_FOOTER, sliderFooter);
        return this;
    }

    /**
     * Gets a text footer to display
     *
     * @return String -a String value representing a text footer to display
     */
    @SuppressWarnings("unchecked")
    public List getSliderFooter() {
        return (List) getObject(String.class, KEY_SLIDER_FOOTER);
    }

    /**
     * Sets an App defined timeout in milliseconds
     *
     * @param timeout an Integer value representing an App defined timeout in milliseconds
     *                

     *                Notes: Minvalue=0; Maxvalue=65535; Defvalue=10000
     */
    public Slider setTimeout(Integer timeout) {
        setParameters(KEY_TIMEOUT, timeout);
        return this;
    }

    /**
     * Gets an App defined timeout in milliseconds
     *
     * @return Integer -an Integer value representing an App defined timeout in milliseconds
     */
    public Integer getTimeout() {
        return getInteger(KEY_TIMEOUT);
    }

    /**
     * Gets an Integer value representing the cancel ID
     *
     * @return Integer - An Integer value representing the ID for this specific slider to allow cancellation through the `CancelInteraction` RPC.
     * @since SmartDeviceLink 6.0
     */
    public Integer getCancelID() {
        return getInteger(KEY_CANCEL_ID);
    }

    /**
     * Sets the cancel ID
     *
     * @param cancelID An Integer ID for this specific slider to allow cancellation through the `CancelInteraction` RPC.
     * @since SmartDeviceLink 6.0
     */
    public Slider setCancelID(Integer cancelID) {
        setParameters(KEY_CANCEL_ID, cancelID);
        return this;
    }
}