Summary: Methods | Inherited Methods

TestScreenManager

Kotlin |Java

public class TestScreenManager
extends ScreenManager

java.lang.Object
↳	androidx.car.app.ScreenManager
	↳	androidx.car.app.testing.TestScreenManager

The ScreenManager that is used for testing.

This class will track the following usages of the ScreenManager throughout your test:

All the Screens pushed via ScreenManager.push(Screen), or ScreenManager.pushForResult(Screen, OnScreenResultListener).
All the Screens removed via, ScreenManager.pop(), ScreenManager.popTo(String), or ScreenManager.remove(Screen).

Summary

Public methods
`List<Screen>`	`getScreensPushed()` Returns all the `Screen`s pushed via `ScreenManager.push(Screen)`, and `ScreenManager.pushForResult(Screen, OnScreenResultListener)`.
`List<Screen>`	`getScreensRemoved()` Returns all the `Screen`s removed via `ScreenManager.pop()`, `ScreenManager.popTo(String)`, and `ScreenManager.remove(Screen)`.
`boolean`	`hasScreens()` Returns `true` if the `Screen` stack has any screens in it.
`void`	`pop()` Pops the top `Screen` from the stack.
`void`	`popTo(String marker)` Removes screens from the top of the stack until a `Screen` which has the given `marker` is found, or the root has been reached.
`void`	`popToRoot()` Removes all screens from the stack until the root has been reached.
`void`	`push(Screen screen)` Pushes the `screen` to the stack.
`void`	`pushForResult(Screen screen, OnScreenResultListener onScreenResultListener)` Pushes a `Screen`, for which you would like a result from, onto the stack.
`void`	`remove(Screen screen)` Removes the `screen` from the stack.
`void`	`reset()` Resets the values tracked by this `TestScreenManager` and the `Screen` stack.

Inherited methods

From class


        
          androidx.car.app.ScreenManager

`Screen`	`getTop()` Returns the `Screen` that is at the top of the stack.
`void`	`pop()` Pops the top `Screen` from the stack.
`void`	`popTo(String marker)` Removes screens from the top of the stack until a `Screen` which has the given `marker` is found, or the root has been reached.
`void`	`popToRoot()` Removes all screens from the stack until the root has been reached.
`void`	`push(Screen screen)` Pushes the `screen` to the stack.
`void`	`pushForResult(Screen screen, OnScreenResultListener onScreenResultListener)` Pushes a `Screen`, for which you would like a result from, onto the stack.
`void`	`remove(Screen screen)` Removes the `screen` from the stack.

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

getScreensPushed

public List<Screen> getScreensPushed ()

Returns all the Screens pushed via ScreenManager.push(Screen), and ScreenManager.pushForResult(Screen, OnScreenResultListener).

The screens are stored in the order in which they were pushed, where the first screen in the list is the first screen that was pushed.

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

Returns
`List<Screen>`

getScreensRemoved

public List<Screen> getScreensRemoved ()

Returns all the Screens removed via ScreenManager.pop(), ScreenManager.popTo(String), and ScreenManager.remove(Screen).

The screens are stored in the order in which they were removed, where the first screen in the list, is the first screen that was removed.

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

Returns
`List<Screen>`

hasScreens

public boolean hasScreens ()

Returns true if the Screen stack has any screens in it.

Returns
`boolean`

pop

public void pop ()

Pops the top Screen from the stack.

If the top Screen is the only Screen in the stack, it will not be removed.

popTo

public void popTo (String marker)

Removes screens from the top of the stack until a Screen which has the given marker is found, or the root has been reached.

The root Screen will not be popped.

Parameters
`marker`	`String`

popToRoot

public void popToRoot ()

Removes all screens from the stack until the root has been reached.

push

public void push (Screen screen)

Pushes the screen to the stack.

If the screen pushed is already in the stack it will be moved to the top of the stack.

Parameters
`screen`	`Screen`

pushForResult

public void pushForResult (Screen screen, 
                OnScreenResultListener onScreenResultListener)

Pushes a Screen, for which you would like a result from, onto the stack.

When the given screen finishes, the onScreenResultCallback will receive a callback to OnScreenResultListener.onScreenResult(Object) with the result that the pushed screen set via Screen.setResult(Object).

Parameters
`screen`	`Screen`: the `Screen` to push on top of the stack
`onScreenResultListener`	`OnScreenResultListener`: the listener that will be executed with the result pushed by the `screen` through `Screen.setResult(Object)`. This callback will be executed on the main thread

remove

public void remove (Screen screen)

Removes the screen from the stack.

If the screen is the only Screen in the stack, it will not be removed.

Parameters
`screen`	`Screen`

reset

public void reset ()

Resets the values tracked by this TestScreenManager and the Screen stack.