ScreenManager (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.managers.BaseSubManager
- - com.smartdevicelink.managers.screen.ScreenManager

```
public class ScreenManager
extends BaseSubManager
```
ScreenManager

Note: This class must be accessed through the SdlManager. 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

ScreenManager(ISdl internalInterface, FileManager fileManager)

Constructors
Constructor and Description
`ScreenManager(ISdl internalInterface, FileManager fileManager)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addButtonListener(ButtonName buttonName, OnButtonListener listener)`
`void`	`beginTransaction()` Begin a multiple updates transaction.
`void`	`changeLayout(TemplateConfiguration templateConfiguration, CompletionListener listener)` Change the current layout to a new layout and optionally update the layout's night and day color schemes.
`void`	`commit(CompletionListener listener)` Pairs with beginTransaction() to batch text, graphic, and layout changes into a single update with a callback when the update is complete.
`void`	`deleteChoices(List<ChoiceCell> choices)` Deletes choices that were sent previously
`void`	`dismissKeyboard(Integer cancelID)` Dismisses a currently presented keyboard with the associated ID.
`void`	`dispose()` Called when manager is being torn down
`DynamicMenuUpdatesMode`	`getDynamicMenuUpdatesMode()`
`String`	`getMediaTrackTextField()` Get the current mediaTrackTextField value
`List<MenuCell>`	`getMenu()` The list of currently set menu cells
`MenuConfiguration`	`getMenuConfiguration()` The main menu layout.
`HashSet<ChoiceCell>`	`getPreloadedChoices()`
`SdlArtwork`	`getPrimaryGraphic()` Get the current primaryGraphic value
`SdlArtwork`	`getSecondaryGraphic()` Get the current secondaryGraphic value
`SoftButtonObject`	`getSoftButtonObjectById(int buttonId)` Get the SoftButtonObject that has the provided buttonId
`SoftButtonObject`	`getSoftButtonObjectByName(String name)` Get the SoftButtonObject that has the provided name
`List<SoftButtonObject>`	`getSoftButtonObjects()` Get the soft button objects list
`TextAlignment`	`getTextAlignment()` Get the alignment for the text fields
`String`	`getTextField1()` Get the current textField1 value
`MetadataType`	`getTextField1Type()` Get the metadata type for textField1
`String`	`getTextField2()` Get the current textField2 value
`MetadataType`	`getTextField2Type()` Get the metadata type for textField2
`String`	`getTextField3()` Get the current textField3 value
`MetadataType`	`getTextField3Type()` Get the metadata type for textField3
`String`	`getTextField4()` Get the current textField4 value
`MetadataType`	`getTextField4Type()` Get the metadata type for textField4
`String`	`getTitle()` Gets the title of the new template that will be displayed
`List<VoiceCommand>`	`getVoiceCommands()` Get the currently set voice commands
`boolean`	`openMenu()` Requires SDL RPC Version 6.0.0 or greater Opens the Main Menu.
`boolean`	`openSubMenu(MenuCell cell)` Requires SDL RPC Version 6.0.0 or greater Opens a subMenu.
`void`	`preloadChoices(List<ChoiceCell> choices, CompletionListener listener)` Preload choices to improve performance while presenting a choice set at a later time
`void`	`presentAlert(AlertView alert, AlertCompletionListener listener)`
`void`	`presentChoiceSet(ChoiceSet choiceSet, InteractionMode mode)` Presents a choice set
`Integer`	`presentKeyboard(String initialText, KeyboardProperties customKeyboardProperties, KeyboardListener keyboardListener)` Presents a keyboard on the Head unit to capture user input
`void`	`presentSearchableChoiceSet(ChoiceSet choiceSet, InteractionMode mode, KeyboardListener keyboardListener)` Presents a searchable choice set
`void`	`removeButtonListener(ButtonName buttonName, OnButtonListener listener)`
`void`	`setDynamicMenuUpdatesMode(DynamicMenuUpdatesMode value)` Sets the behavior of how menus are updated.
`void`	`setKeyboardConfiguration(KeyboardProperties keyboardConfiguration)` Set a custom keyboard configuration for this session.
`void`	`setMediaTrackTextField(String mediaTrackTextField)` Set the mediaTrackTextField on the head unit screen
`void`	`setMenu(List<MenuCell> menuCells)` Creates and sends all associated Menu RPCs Note: the manager will store a deep copy the menuCells internally to be able to handle future updates correctly
`void`	`setMenuConfiguration(MenuConfiguration menuConfiguration)` The main menu layout.
`void`	`setPrimaryGraphic(SdlArtwork primaryGraphic)` Set the primaryGraphic on the head unit screen
`void`	`setSecondaryGraphic(SdlArtwork secondaryGraphic)` Set the secondaryGraphic on the head unit screen
`void`	`setSoftButtonObjects(List<SoftButtonObject> softButtonObjects)` Set softButtonObjects list and upload the images to the head unit
`void`	`setTextAlignment(TextAlignment textAlignment)` Set the alignment for the text fields
`void`	`setTextField1(String textField1)` The top text field within a template layout.
`void`	`setTextField1Type(MetadataType textField1Type)` Set the metadata type for the textField1
`void`	`setTextField2(String textField2)` Sets the second text field within a template layout.
`void`	`setTextField2Type(MetadataType textField2Type)` Set the metadata type for the textField2
`void`	`setTextField3(String textField3)` Sets the third text field within a template layout.
`void`	`setTextField3Type(MetadataType textField3Type)` Set the metadata type for the textField3
`void`	`setTextField4(String textField4)` Sets the fourth text field within a template layout.
`void`	`setTextField4Type(MetadataType textField4Type)` Set the metadata type for the textField4
`void`	`setTitle(String title)` Sets the title of the new template that will be displayed.
`void`	`setVoiceCommands(List<VoiceCommand> voiceCommands)` Set voice commands
`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
  - ScreenManager
```
public ScreenManager(@NonNull
                     ISdl internalInterface,
                     @NonNull
                     FileManager fileManager)
```
- 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()
```
    Called when manager is being torn down
    
    Overrides:
    
    dispose in class BaseSubManager
  - setTextField1
```
public void setTextField1(String textField1)
```
    The top text field within a template layout. Pass an empty string "" to clear the text field.
    If the system does not support a full 4 fields, this will automatically be concatenated and properly send the field available.
    If 3 lines are available: [field1, field2, field3 - field 4]
    If 2 lines are available: [field1 - field2, field3 - field4]
    If 1 line is available: [field1 - field2 - field3 - field4]
    
    Parameters:
    
    textField1 - String value represents the textField1
  - getTextField1
```
public String getTextField1()
```
    Get the current textField1 value
    
    Returns:
    
    a String value represents the current textField1 value
  - setTextField2
```
public void setTextField2(String textField2)
```
    Sets the second text field within a template layout. Pass an empty string "" to clear the text field.
    If the system does not support a full 4 fields, this will automatically be concatenated and properly send the field available.
    If 3 lines are available: [field1, field2, field3 - field 4]
    If 2 lines are available: [field1 - field2, field3 - field4]
    If 1 line is available: [field1 - field2 - field3 - field4]
    
    Parameters:
    
    textField2 - String value represents the textField1
  - getTextField2
```
public String getTextField2()
```
    Get the current textField2 value
    
    Returns:
    
    a String value represents the current textField2 value
  - setTextField3
```
public void setTextField3(String textField3)
```
    Sets the third text field within a template layout. Pass an empty string "" to clear the text field.
    If the system does not support a full 4 fields, this will automatically be concatenated and properly send the field available.
    If 3 lines are available: [field1, field2, field3 - field 4]
    If 2 lines are available: [field1 - field2, field3 - field4]
    If 1 line is available: [field1 - field2 - field3 - field4]
    
    Parameters:
    
    textField3 - String value represents the textField1
  - getTextField3
```
public String getTextField3()
```
    Get the current textField3 value
    
    Returns:
    
    a String value represents the current textField3 value
  - setTextField4
```
public void setTextField4(String textField4)
```
    Sets the fourth text field within a template layout. Pass an empty string "" to clear the text field.
    If the system does not support a full 4 fields, this will automatically be concatenated and properly send the field available.
    If 3 lines are available: [field1, field2, field3 - field 4]
    If 2 lines are available: [field1 - field2, field3 - field4]
    If 1 line is available: [field1 - field2 - field3 - field4]
    
    Parameters:
    
    textField4 - String value represents the textField1
  - getTextField4
```
public String getTextField4()
```
    Get the current textField4 value
    
    Returns:
    
    a String value represents the current textField4 value
  - setMediaTrackTextField
```
public void setMediaTrackTextField(String mediaTrackTextField)
```
    Set the mediaTrackTextField on the head unit screen
    
    Parameters:
    
    mediaTrackTextField - String value represents the mediaTrackTextField
  - getMediaTrackTextField
```
public String getMediaTrackTextField()
```
    Get the current mediaTrackTextField value
    
    Returns:
    
    a String value represents the current mediaTrackTextField
  - setPrimaryGraphic
```
public void setPrimaryGraphic(SdlArtwork primaryGraphic)
```
    Set the primaryGraphic on the head unit screen
    
    Parameters:
    
    primaryGraphic - an SdlArtwork object represents the primaryGraphic
  - getPrimaryGraphic
```
public SdlArtwork getPrimaryGraphic()
```
    Get the current primaryGraphic value
    
    Returns:
    
    an SdlArtwork object represents the current primaryGraphic
  - setSecondaryGraphic
```
public void setSecondaryGraphic(SdlArtwork secondaryGraphic)
```
    Set the secondaryGraphic on the head unit screen
    
    Parameters:
    
    secondaryGraphic - an SdlArtwork object represents the secondaryGraphic
  - getSecondaryGraphic
```
public SdlArtwork getSecondaryGraphic()
```
    Get the current secondaryGraphic value
    
    Returns:
    
    an SdlArtwork object represents the current secondaryGraphic
  - setTextAlignment
```
public void setTextAlignment(TextAlignment textAlignment)
```
    Set the alignment for the text fields
    
    Parameters:
    
    textAlignment - TextAlignment value represents the alignment for the text fields
  - getTextAlignment
```
public TextAlignment getTextAlignment()
```
    Get the alignment for the text fields
    
    Returns:
    
    a TextAlignment value represents the alignment for the text fields
  - setTextField1Type
```
public void setTextField1Type(MetadataType textField1Type)
```
    Set the metadata type for the textField1
    
    Parameters:
    
    textField1Type - a MetadataType value represents the metadata for textField1
  - getTextField1Type
```
public MetadataType getTextField1Type()
```
    Get the metadata type for textField1
    
    Returns:
    
    a MetadataType value represents the metadata for textField1
  - setTextField2Type
```
public void setTextField2Type(MetadataType textField2Type)
```
    Set the metadata type for the textField2
    
    Parameters:
    
    textField2Type - a MetadataType value represents the metadata for textField2
  - getTextField2Type
```
public MetadataType getTextField2Type()
```
    Get the metadata type for textField2
    
    Returns:
    
    a MetadataType value represents the metadata for textField2
  - setTextField3Type
```
public void setTextField3Type(MetadataType textField3Type)
```
    Set the metadata type for the textField3
    
    Parameters:
    
    textField3Type - a MetadataType value represents the metadata for textField3
  - getTextField3Type
```
public MetadataType getTextField3Type()
```
    Get the metadata type for textField3
    
    Returns:
    
    a MetadataType value represents the metadata for textField3
  - setTextField4Type
```
public void setTextField4Type(MetadataType textField4Type)
```
    Set the metadata type for the textField4
    
    Parameters:
    
    textField4Type - a MetadataType value represents the metadata for textField4
  - getTextField4Type
```
public MetadataType getTextField4Type()
```
    Get the metadata type for textField4
    
    Returns:
    
    a MetadataType value represents the metadata for textField4
  - setTitle
```
public void setTitle(String title)
```
    Sets the title of the new template that will be displayed. Sending an empty String "" will clear the field
    
    Parameters:
    
    title - the title of the new template that will be displayed. MaxLength: 100.
  - getTitle
```
public String getTitle()
```
    Gets the title of the new template that will be displayed
    
    Returns:
    
    title - String value that represents the title of the new template that will be displayed
  - changeLayout
```
public void changeLayout(@NonNull
                         TemplateConfiguration templateConfiguration,
                         CompletionListener listener)
```
    Change the current layout to a new layout and optionally update the layout's night and day color schemes. The values set for the text, graphics, buttons and template title persist between layout changes. To update the text, graphics, buttons and template title at the same time as the template, batch all the updates between beginTransaction and commit. If the layout update fails while batching, then the updated text, graphics, buttons or template title will also not be updated.
    If you are connected on a < v6.0 connection and batching the update, the layout will be updated, then the text and graphics will be updated. If you are connected on a >= v6.0 connection, the layout will be updated at the same time that the text and graphics are updated.
    If this update is batched between beginTransaction and commit, the completionListener here will not be called. Use the completionListener with commit(completionListener)
    NOTE: If this update returns an false, it may have been superseded by another update. This means that it was cancelled while in-progress because another update was requested, whether batched or not.
    
    Parameters:
    
    templateConfiguration - The new configuration of the template, including the layout and color scheme.
    
    listener - A listener that will be called when the layout change finished.
  - setSoftButtonObjects
```
public void setSoftButtonObjects(@NonNull
                                 List<SoftButtonObject> softButtonObjects)
```
    Set softButtonObjects list and upload the images to the head unit
    
    Parameters:
    
    softButtonObjects - the list of the SoftButtonObject values that should be displayed on the head unit
  - getSoftButtonObjects
```
public List<SoftButtonObject> getSoftButtonObjects()
```
    Get the soft button objects list
    
    Returns:
    
    a List
  - getSoftButtonObjectByName
```
public SoftButtonObject getSoftButtonObjectByName(@NonNull
                                                  String name)
```
    Get the SoftButtonObject that has the provided name
    
    Parameters:
    
    name - a String value that represents the name
    
    Returns:
    
    a SoftButtonObject
  - getSoftButtonObjectById
```
public SoftButtonObject getSoftButtonObjectById(int buttonId)
```
    Get the SoftButtonObject that has the provided buttonId
    
    Parameters:
    
    buttonId - a int value that represents the id of the button
    
    Returns:
    
    a SoftButtonObject
  - getVoiceCommands
```
public List<VoiceCommand> getVoiceCommands()
```
    Get the currently set voice commands
    
    Returns:
    
    a List of Voice Command objects
  - setVoiceCommands
```
public void setVoiceCommands(@NonNull
                             List<VoiceCommand> voiceCommands)
```
    Set voice commands
    
    Parameters:
    
    voiceCommands - the voice commands to be sent to the head unit
  - getMenu
```
public List<MenuCell> getMenu()
```
    The list of currently set menu cells
    
    Returns:
    
    a List of the currently set menu cells
  - setMenu
```
public void setMenu(@NonNull
                    List<MenuCell> menuCells)
```
    Creates and sends all associated Menu RPCs Note: the manager will store a deep copy the menuCells internally to be able to handle future updates correctly
    
    Parameters:
    
    menuCells - - the menu cells that are to be sent to the head unit, including their sub-cells.
  - setDynamicMenuUpdatesMode
```
public void setDynamicMenuUpdatesMode(@NonNull
                                      DynamicMenuUpdatesMode value)
```
    Sets the behavior of how menus are updated. For explanations of the differences, see DynamicMenuUpdatesMode
    
    Parameters:
    
    value - - the update mode
  - getDynamicMenuUpdatesMode
```
public DynamicMenuUpdatesMode getDynamicMenuUpdatesMode()
```
    Returns:
    
    The currently set DynamicMenuUpdatesMode. It defaults to ON_WITH_COMPAT_MODE if not set.
  - openMenu
```
public boolean openMenu()
```
    Requires SDL RPC Version 6.0.0 or greater Opens the Main Menu.
    
    Returns:
    
    boolean success / failure - whether the request was able to be sent
  - openSubMenu
```
public boolean openSubMenu(@NonNull
                           MenuCell cell)
```
    Requires SDL RPC Version 6.0.0 or greater Opens a subMenu. The cell you pass in must be constructed with MenuCell(String,SdlArtwork,List)
    
    Parameters:
    
    cell - - A SubMenu cell whose sub menu you wish to open
    
    Returns:
    
    boolean success / failure - whether the request was able to be sent
  - setMenuConfiguration
```
public void setMenuConfiguration(@NonNull
                                 MenuConfiguration menuConfiguration)
```
    The main menu layout. See available menu layouts on WindowCapability.menuLayoutsAvailable.
    
    Parameters:
    
    menuConfiguration - - The default menuConfiguration
  - getMenuConfiguration
```
public MenuConfiguration getMenuConfiguration()
```
    The main menu layout. See available menu layouts on WindowCapability.menuLayoutsAvailable.
    
    Returns:
    
    the currently set MenuConfiguration
  - deleteChoices
```
public void deleteChoices(@NonNull
                          List<ChoiceCell> choices)
```
    Deletes choices that were sent previously
    
    Parameters:
    
    choices - - A list of ChoiceCell objects
  - preloadChoices
```
public void preloadChoices(@NonNull
                           List<ChoiceCell> choices,
                           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
  - presentSearchableChoiceSet
```
public void presentSearchableChoiceSet(@NonNull
                                       ChoiceSet choiceSet,
                                       @Nullable
                                       InteractionMode mode,
                                       @NonNull
                                       KeyboardListener keyboardListener)
```
    Presents a searchable 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
  - presentChoiceSet
```
public void presentChoiceSet(@NonNull
                             ChoiceSet choiceSet,
                             @Nullable
                             InteractionMode mode)
```
    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
  - presentKeyboard
```
public Integer presentKeyboard(@NonNull
                               String initialText,
                               @Nullable
                               KeyboardProperties customKeyboardProperties,
                               @NonNull
                               KeyboardListener keyboardListener)
```
    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.
    
    customKeyboardProperties - - the custom keyboard configuration to be used when the keyboard is displayed
    
    keyboardListener - - A keyboard listener to capture user input
    
    Returns:
    
    A unique cancelID that can be used to cancel this keyboard. If `null`, no keyboard was created.
  - 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
  - dismissKeyboard
```
public void dismissKeyboard(@NonNull
                            Integer cancelID)
```
    Dismisses a currently presented keyboard with the associated ID. Canceling a keyboard only works when connected to SDL Core v.6.0+. When connected to older versions of SDL Core the keyboard will not be dismissed.
    
    Parameters:
    
    cancelID - The unique ID assigned to the keyboard
  - beginTransaction
```
public void beginTransaction()
```
    Begin a multiple updates transaction. The updates will be applied when commit() is called
    Note: if we don't use beginTransaction & commit, every update will be sent individually.
  - commit
```
public void commit(CompletionListener listener)
```
    Pairs with beginTransaction() to batch text, graphic, and layout changes into a single update with a callback when the update is complete. Update text fields with new text set into the text field properties, updates the primary and secondary images with new image(s) if new one(s) been set, and updates the template if one was changed using changeLayout(TemplateConfiguration, CompletionListener). NOTE: The CompletionListener in changeLayout(TemplateConfiguration, CompletionListener) will not be called if the update is batched into this update NOTE: If this CompletionListener returns false, it may have been superseded by another update. This means that it was cancelled while in-progress because another update was requested, whether batched or not.
    
    Parameters:
    
    listener - a CompletionListener that has a callback that will be called when the updates are finished
  - addButtonListener
```
public void addButtonListener(@NonNull
                              ButtonName buttonName,
                              @NonNull
                              OnButtonListener listener)
```
  - removeButtonListener
```
public void removeButtonListener(@NonNull
                                 ButtonName buttonName,
                                 @NonNull
                                 OnButtonListener listener)
```
  - presentAlert
```
public void presentAlert(AlertView alert,
                         AlertCompletionListener listener)
```

Class ScreenManager

Field Summary

Fields inherited from class com.smartdevicelink.managers.BaseSubManager

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.managers.BaseSubManager

Methods inherited from class java.lang.Object

Constructor Detail

ScreenManager

Method Detail

start

dispose

setTextField1

getTextField1

setTextField2

getTextField2

setTextField3

getTextField3

setTextField4

getTextField4

setMediaTrackTextField

getMediaTrackTextField

setPrimaryGraphic

getPrimaryGraphic

setSecondaryGraphic

getSecondaryGraphic

setTextAlignment

getTextAlignment

setTextField1Type

getTextField1Type

setTextField2Type

getTextField2Type

setTextField3Type

getTextField3Type

setTextField4Type

getTextField4Type

setTitle

getTitle

changeLayout

setSoftButtonObjects

getSoftButtonObjects

getSoftButtonObjectByName

getSoftButtonObjectById

getVoiceCommands

setVoiceCommands

getMenu

setMenu

setDynamicMenuUpdatesMode

getDynamicMenuUpdatesMode

openMenu

openSubMenu

setMenuConfiguration

getMenuConfiguration

deleteChoices

preloadChoices

presentSearchableChoiceSet

presentChoiceSet

presentKeyboard

setKeyboardConfiguration

getPreloadedChoices

dismissKeyboard

beginTransaction

commit

addButtonListener

removeButtonListener

presentAlert