Summary: Ctors | 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 constructors
`ScreenController(TestCarContext testCarContext, Screen screen)` Creates a ScreenController to control a `Screen` for testing.

Public methods
`Screen`	`getScreen()` 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.
`ScreenController`	`moveToState(Lifecycle.State state)` Moves the `Screen` being controlled to the input `state`.
`void`	`reset()` Resets values tracked by this `ScreenController`.

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 constructors

ScreenController

public ScreenController (TestCarContext testCarContext, 
                Screen screen)

Creates a ScreenController to control a Screen for testing.

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

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

Public methods

getScreen

public Screen getScreen ()

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>`

moveToState

public ScreenController moveToState (Lifecycle.State state)

Moves the Screen being controlled to the input state.

Note that moving the Screen up a state will also push the Screen onto the ScreenManager's screen stack if it isn't the current top.

Lifecycle.State.DESTROYED is a terminal state, and you cannot move to any other state after the Screen reaches that state.

Parameters
`state`	`Lifecycle.State`

Returns
`ScreenController`

See also:

Screen.getLifecycle()

reset

public void reset ()

Resets values tracked by this ScreenController.