Android APIs
public final class

Scene

extends Object
java.lang.Object
   ↳ android.transition.Scene

Class Overview

A scene represents the collection of values that various properties in the View hierarchy will have when the scene is applied. A Scene can be configured to automatically run a Transition when it is applied, which will animate the various property changes that take place during the scene change.

Summary

Public Constructors
Scene(ViewGroup sceneRoot)
Constructs a Scene with no information about how values will change when this scene is applied.
Scene(ViewGroup sceneRoot, View layout)
Constructs a Scene which, when entered, will remove any children from the sceneRoot container and add the layout object as a new child of that container.
Scene(ViewGroup sceneRoot, ViewGroup layout)
Public Methods
void enter()
Enters this scene, which entails changing all values that are specified by this scene.
void exit()
Exits this scene, if it is the current scene on the scene's scene root.
static Scene getSceneForLayout(ViewGroup sceneRoot, int layoutId, Context context)
Returns a Scene described by the resource file associated with the given layoutId parameter.
ViewGroup getSceneRoot()
Gets the root of the scene, which is the root of the view hierarchy affected by changes due to this scene, and which will be animated when this scene is entered.
void setEnterAction(Runnable action)
Scenes that are not defined with layout resources or hierarchies, or which need to perform additional steps after those hierarchies are changed to, should set an enter action, and possibly an exit action as well.
void setExitAction(Runnable action)
Scenes that are not defined with layout resources or hierarchies, or which need to perform additional steps after those hierarchies are changed to, should set an enter action, and possibly an exit action as well.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Scene (ViewGroup sceneRoot)

Added in API level 19

Constructs a Scene with no information about how values will change when this scene is applied. This constructor might be used when a Scene is created with the intention of being dynamically configured, through setting setEnterAction(Runnable) and possibly setExitAction(Runnable).

Parameters
sceneRoot The root of the hierarchy in which scene changes and transitions will take place.

public Scene (ViewGroup sceneRoot, View layout)

Added in API level 21

Constructs a Scene which, when entered, will remove any children from the sceneRoot container and add the layout object as a new child of that container.

Parameters
sceneRoot The root of the hierarchy in which scene changes and transitions will take place.
layout The view hierarchy of this scene, added as a child of sceneRoot when this scene is entered.

public Scene (ViewGroup sceneRoot, ViewGroup layout)

Added in API level 19

This constructor was deprecated in API level 21.
use Scene(ViewGroup, View).

Public Methods

public void enter ()

Added in API level 19

Enters this scene, which entails changing all values that are specified by this scene. These may be values associated with a layout view group or layout resource file which will now be added to the scene root, or it may be values changed by an setEnterAction(Runnable) enter action}, or a combination of the these. No transition will be run when the scene is entered. To get transition behavior in scene changes, use one of the methods in TransitionManager instead.

public void exit ()

Added in API level 19

Exits this scene, if it is the current scene on the scene's scene root. The current scene is set when entering a scene. Exiting a scene runs the exit action if there is one.

public static Scene getSceneForLayout (ViewGroup sceneRoot, int layoutId, Context context)

Added in API level 19

Returns a Scene described by the resource file associated with the given layoutId parameter. If such a Scene has already been created for the given sceneRoot, that same Scene will be returned. This caching of layoutId-based scenes enables sharing of common scenes between those created in code and those referenced by TransitionManager XML resource files.

Parameters
sceneRoot The root of the hierarchy in which scene changes and transitions will take place.
layoutId The id of a standard layout resource file.
context The context used in the process of inflating the layout resource.
Returns
  • The scene for the given root and layout id

public ViewGroup getSceneRoot ()

Added in API level 19

Gets the root of the scene, which is the root of the view hierarchy affected by changes due to this scene, and which will be animated when this scene is entered.

Returns
  • The root of the view hierarchy affected by this scene.

public void setEnterAction (Runnable action)

Added in API level 19

Scenes that are not defined with layout resources or hierarchies, or which need to perform additional steps after those hierarchies are changed to, should set an enter action, and possibly an exit action as well. An enter action will cause Scene to call back into application code to do anything else the application needs after transitions have captured pre-change values and after any other scene changes have been applied, such as the layout (if any) being added to the view hierarchy. After this method is called, Transitions will be played.

Parameters
action The runnable whose run() method will be called when this scene is entered

public void setExitAction (Runnable action)

Added in API level 19

Scenes that are not defined with layout resources or hierarchies, or which need to perform additional steps after those hierarchies are changed to, should set an enter action, and possibly an exit action as well. An exit action will cause Scene to call back into application code to do anything the application needs to do after applicable transitions have captured pre-change values, but before any other scene changes have been applied, such as the new layout (if any) being added to the view hierarchy. After this method is called, the next scene will be entered, including a call to setEnterAction(Runnable) if an enter action is set.