com.smartdevicelink.managers.screen.choiceset

Class ChoiceSetManager

java.lang.Object

com.smartdevicelink.managers.BaseSubManager

com.smartdevicelink.managers.screen.choiceset.ChoiceSetManager

public class ChoiceSetManager
extends BaseSubManager

ChoiceSetManager
ChoiceSetManager gives the developer the ability to control how soft choice sets are displayed on the head unit.
Note: This class must be accessed through the SdlManager->ScreenManager. Do not instantiate it by itself.

Field Summary

Fields inherited from class com.smartdevicelink.managers.BaseSubManager

ERROR, internalInterface, LIMITED, READY, SETTING_UP, SHUTDOWN

Constructor Summary

Constructors

Constructor and Description
ChoiceSetManager(ISdl internalInterface, FileManager fileManager) Creates a new instance of the ChoiceSetManager

Method Summary

Modifier and Type	Method and Description
void	deleteChoices(List<ChoiceCell> choices) Deletes choices that were sent previously
void	dismissKeyboard(Integer cancelID) Cancels the keyboard-only interface if it is currently showing.
void	dispose() Called when manager is being torn down
HashSet<ChoiceCell>	getPreloadedChoices()
void	preloadChoices(List<ChoiceCell> choices, CompletionListener listener) Preload choices to improve performance while presenting a choice set at a later time
void	presentChoiceSet(ChoiceSet choiceSet, InteractionMode mode, KeyboardListener keyboardListener) Presents a choice set
Integer	presentKeyboard(String initialText, KeyboardProperties customKeyboardConfig, KeyboardListener listener) Presents a keyboard on the Head unit to capture user input
void	setKeyboardConfiguration(KeyboardProperties keyboardConfiguration) Set a custom keyboard configuration for this session.
void	start(CompletionListener listener) Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.

Methods inherited from class com.smartdevicelink.managers.BaseSubManager

getState, handleTransportUpdated, onTransportUpdate, transitionToState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChoiceSetManager

public ChoiceSetManager(@NonNull
                        ISdl internalInterface,
                        @NonNull
                        FileManager fileManager)

Creates a new instance of the ChoiceSetManager

Parameters:

internalInterface -

Method Detail

start

public void start(CompletionListener listener)

Description copied from class: BaseSubManager

Starts up a BaseSubManager, and calls provided callback once BaseSubManager is done setting up or failed setup.

Overrides:

start in class BaseSubManager

Parameters:

listener - CompletionListener that is called once the BaseSubManager's state is READY, LIMITED, or ERROR

dispose

public void dispose()

Description copied from class: BaseSubManager

Called when manager is being torn down

Overrides:

dispose in class BaseSubManager

preloadChoices

public void preloadChoices(@NonNull
                           List<ChoiceCell> choices,
                           @Nullable
                           CompletionListener listener)

Preload choices to improve performance while presenting a choice set at a later time

Parameters:

choices - - a list of ChoiceCell objects that will be part of a choice set later

listener - - a completion listener to inform when the operation is complete

deleteChoices

public void deleteChoices(@NonNull
                          List<ChoiceCell> choices)

Deletes choices that were sent previously

Parameters:

choices - - A list of ChoiceCell objects

presentChoiceSet

public void presentChoiceSet(@NonNull
                             ChoiceSet choiceSet,
                             @Nullable
                             InteractionMode mode,
                             @Nullable
                             KeyboardListener keyboardListener)

Presents a choice set

Parameters:

choiceSet - - The choice set to be presented. This can include Choice Cells that were preloaded or not

mode - - The intended interaction mode

keyboardListener - - A keyboard listener to capture user input

presentKeyboard

public Integer presentKeyboard(@NonNull
                               String initialText,
                               @Nullable
                               KeyboardProperties customKeyboardConfig,
                               @NonNull
                               KeyboardListener listener)

Presents a keyboard on the Head unit to capture user input

Parameters:

initialText - - The initial text that is used as a placeholder text. It might not work on some head units.

customKeyboardConfig - - the custom keyboard configuration to be used when the keyboard is displayed

listener - - A keyboard listener to capture user input

Returns:

- A unique id that can be used to cancel this keyboard. If `null`, no keyboard was created.

dismissKeyboard

public void dismissKeyboard(@NonNull
                            Integer cancelID)

Cancels the keyboard-only interface if it is currently showing. If the keyboard has not yet been sent to Core, it will not be sent.

This will only dismiss an already presented keyboard if connected to head units running SDL 6.0+.

Parameters:

cancelID - - The unique ID assigned to the keyboard, passed as the return value from `presentKeyboard`

setKeyboardConfiguration

public void setKeyboardConfiguration(@Nullable
                                     KeyboardProperties keyboardConfiguration)

Set a custom keyboard configuration for this session. If set to null, it will reset to default keyboard configuration.

Parameters:

keyboardConfiguration - - the custom keyboard configuration to be used when the keyboard is displayed

getPreloadedChoices

public HashSet<ChoiceCell> getPreloadedChoices()

Returns:

A set of choice cells that have been preloaded to the head unit