Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class ScreenManager

Hierarchy

java.lang.Object
     com.smartdevicelink.managers.BaseSubManager

Package
com.smartdevicelink.managers.screen

Overview

ScreenManager
Note: This class must be accessed through the SdlManager. Do not instantiate it by itself.

Fields

Inherited Fields

From Class Fields
com.smartdevicelink.managers.BaseSubManager SETTING_UP, READY, LIMITED, SHUTDOWN, ERROR, internalInterface

Constructors

ScreenManager( ISdl internalInterface, FileManager fileManager )

public ScreenManager(ISdl internalInterface,FileManager fileManager)

Parameters

internalInterface
fileManager

Methods

start( CompletionListener listener )

public void start(CompletionListener listener)

Parameters

listener

dispose()

Called when manager is being torn down

public void dispose()

setTextField1( String textField1 )

Set the textField1 on the head unit screen Sending an empty String "" will clear the field

public void setTextField1(String textField1)

Parameters

textField1
String value represents the textField1

getTextField1()

Get the current textField1 value

public java.lang.String getTextField1()

setTextField2( String textField2 )

Set the textField2 on the head unit screen Sending an empty String "" will clear the field

public void setTextField2(String textField2)

Parameters

textField2
String value represents the textField1

getTextField2()

Get the current textField2 value

public java.lang.String getTextField2()

setTextField3( String textField3 )

Set the textField3 on the head unit screen Sending an empty String "" will clear the field

public void setTextField3(String textField3)

Parameters

textField3
String value represents the textField1

getTextField3()

Get the current textField3 value

public java.lang.String getTextField3()

setTextField4( String textField4 )

Set the textField4 on the head unit screen Sending an empty String "" will clear the field

public void setTextField4(String textField4)

Parameters

textField4
String value represents the textField1

getTextField4()

Get the current textField4 value

public java.lang.String getTextField4()

setMediaTrackTextField( String mediaTrackTextField )

Set the mediaTrackTextField on the head unit screen

public void setMediaTrackTextField(String mediaTrackTextField)

Parameters

mediaTrackTextField
String value represents the mediaTrackTextField

getMediaTrackTextField()

Get the current mediaTrackTextField value

public java.lang.String getMediaTrackTextField()

setPrimaryGraphic( SdlArtwork primaryGraphic )

Set the primaryGraphic on the head unit screen

public void setPrimaryGraphic(SdlArtwork primaryGraphic)

Parameters

primaryGraphic
an SdlArtwork object represents the primaryGraphic

getPrimaryGraphic()

Get the current primaryGraphic value

public com.smartdevicelink.managers.file.filetypes.SdlArtwork getPrimaryGraphic()

setSecondaryGraphic( SdlArtwork secondaryGraphic )

Set the secondaryGraphic on the head unit screen

public void setSecondaryGraphic(SdlArtwork secondaryGraphic)

Parameters

secondaryGraphic
an SdlArtwork object represents the secondaryGraphic

getSecondaryGraphic()

Get the current secondaryGraphic value

public com.smartdevicelink.managers.file.filetypes.SdlArtwork getSecondaryGraphic()

setTextAlignment( TextAlignment textAlignment )

Set the alignment for the text fields

public void setTextAlignment(TextAlignment textAlignment)

Parameters

textAlignment
TextAlignment value represents the alignment for the text fields

getTextAlignment()

Get the alignment for the text fields

public com.smartdevicelink.proxy.rpc.enums.TextAlignment getTextAlignment()

setTextField1Type( MetadataType textField1Type )

Set the metadata type for the textField1

public void setTextField1Type(MetadataType textField1Type)

Parameters

textField1Type
a MetadataType value represents the metadata for textField1

getTextField1Type()

Get the metadata type for textField1

public com.smartdevicelink.proxy.rpc.enums.MetadataType getTextField1Type()

setTextField2Type( MetadataType textField2Type )

Set the metadata type for the textField2

public void setTextField2Type(MetadataType textField2Type)

Parameters

textField2Type
a MetadataType value represents the metadata for textField2

getTextField2Type()

Get the metadata type for textField2

public com.smartdevicelink.proxy.rpc.enums.MetadataType getTextField2Type()

setTextField3Type( MetadataType textField3Type )

Set the metadata type for the textField3

public void setTextField3Type(MetadataType textField3Type)

Parameters

textField3Type
a MetadataType value represents the metadata for textField3

getTextField3Type()

Get the metadata type for textField3

public com.smartdevicelink.proxy.rpc.enums.MetadataType getTextField3Type()

setTextField4Type( MetadataType textField4Type )

Set the metadata type for the textField4

public void setTextField4Type(MetadataType textField4Type)

Parameters

textField4Type
a MetadataType value represents the metadata for textField4

getTextField4Type()

Get the metadata type for textField4

public com.smartdevicelink.proxy.rpc.enums.MetadataType getTextField4Type()

setSoftButtonObjects( java.util.List<com.smartdevicelink.managers.screen.SoftButtonObject> softButtonObjects )

Set softButtonObjects list and upload the images to the head unit

public void setSoftButtonObjects(java.util.List<com.smartdevicelink.managers.screen.SoftButtonObject> softButtonObjects)

Parameters

softButtonObjects
the list of the SoftButtonObject values that should be displayed on the head unit

getSoftButtonObjects()

Get the soft button objects list

public java.util.List getSoftButtonObjects()

getSoftButtonObjectByName( String name )

Get the SoftButtonObject that has the provided name

public com.smartdevicelink.managers.screen.SoftButtonObject getSoftButtonObjectByName(String name)

Parameters

name
a String value that represents the name

getSoftButtonObjectById( int buttonId )

Get the SoftButtonObject that has the provided buttonId

public com.smartdevicelink.managers.screen.SoftButtonObject getSoftButtonObjectById(int buttonId)

Parameters

buttonId
a int value that represents the id of the button

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.

public void beginTransaction()

commit( CompletionListener listener )

Send the updates that were started after beginning the transaction

public void commit(CompletionListener listener)

Parameters

listener
a CompletionListener that has a callback that will be called when the updates are finished

Inherited Methods

From Class Methods
com.smartdevicelink.managers.BaseSubManager start, dispose, transitionToState, getState, handleTransportUpdated, onTransportUpdate
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section