Summary: Methods | Inherited Methods

ScreenController

Kotlin |Java

public class ScreenController
extends Object

java.lang.Object
↳	androidx.car.app.testing.ScreenController

A controller that allows testing of a Screen.

This controller will allows:

Moving a Screen through its different Lifecycle.States.
Retrieving all Templates returned from Screen.onGetTemplate(). The values can be reset with reset().

Summary

Public methods
`ScreenController`	`create()` Creates the `Screen` being controlled.
`ScreenController`	`destroy()` Destroys to the `Screen` being controlled.
`Screen`	`get()` Returns the `Screen` being controlled.
`Object`	`getScreenResult()` Returns the result that was set via `Screen.setResult(Object)`, or `null` if one was not set.
`List<Template>`	`getTemplatesReturned()` Returns all the `Template`s returned from `Screen.onGetTemplate()` for the `Screen` being controlled.
`static ScreenController`	`of(TestCarContext testCarContext, Screen screen)` Creates a ScreenController to control a `Screen` for testing.
`ScreenController`	`pause()` Pauses the `Screen` being controlled.
`void`	`reset()` Resets values tracked by this `ScreenController`.
`ScreenController`	`resume()` Resumes the `Screen` being controlled.
`ScreenController`	`start()` Starts the `Screen` being controlled.
`ScreenController`	`stop()` Stops to the `Screen` being controlled.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public methods

create

public ScreenController create ()

Creates the Screen being controlled.

This method will also push the Screen onto the ScreenManager's screen stack if it isn't the current top.

Returns
`ScreenController`

destroy

public ScreenController destroy ()

Destroys to the Screen being controlled.

Returns
`ScreenController`

See also:

Screen.getLifecycle()

get

public Screen get ()

Returns the Screen being controlled.

Returns
`Screen`

getScreenResult

public Object getScreenResult ()

Returns the result that was set via Screen.setResult(Object), or null if one was not set.

Returns
`Object`

getTemplatesReturned

public List<Template> getTemplatesReturned ()

Returns all the Templates returned from Screen.onGetTemplate() for the Screen being controlled.

The templates are stored in the order in which they were returned from Screen.onGetTemplate(), where the first template in the list, is the first template returned.

The templates will be stored until reset() is called.

Returns
`List<Template>`

of

public static ScreenController of (TestCarContext testCarContext, 
                Screen screen)

Creates a ScreenController to control a Screen for testing.

Parameters
`testCarContext`	`TestCarContext`
`screen`	`Screen`

Returns
`ScreenController`

Throws
`NullPointerException`	if either `testCarContext` or `screen` are null

pause

public ScreenController pause ()

Pauses the Screen being controlled.

Returns
`ScreenController`

See also:

Screen.getLifecycle()

reset

public void reset ()

Resets values tracked by this ScreenController.

resume

public ScreenController resume ()

Resumes the Screen being controlled.

This method will also push the Screen onto the ScreenManager's screen stack if it isn't the current top.

Returns
`ScreenController`

See also:

Screen.getLifecycle()

start

public ScreenController start ()

Starts the Screen being controlled.

This method will also push the Screen onto the ScreenManager's screen stack if it isn't the current top.

Returns
`ScreenController`

See also:

Screen.getLifecycle()

stop

public ScreenController stop ()

Stops to the Screen being controlled.

Returns
`ScreenController`

See also:

Screen.getLifecycle()