public
final
class
Scene
extends Object
| java.lang.Object | |
| ↳ | android.transition.Scene |
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.
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)
This constructor was deprecated
in API level 21.
use |
|
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 |
static
Scene
|
getSceneForLayout(ViewGroup sceneRoot, int layoutId, Context context)
Returns a Scene described by the resource file associated with the given
|
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. |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
Scene (ViewGroup sceneRoot)
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 |
ViewGroup:
The root of the hierarchy in which scene changes
and transitions will take place.
|
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.
| Parameters | |
|---|---|
sceneRoot |
ViewGroup:
The root of the hierarchy in which scene changes
and transitions will take place. |
layout |
View:
The view hierarchy of this scene, added as a child
of sceneRoot when this scene is entered.
|
Scene (ViewGroup sceneRoot, ViewGroup layout)
This constructor was deprecated
in API level 21.
use Scene(ViewGroup, View).
| Parameters | |
|---|---|
sceneRoot |
ViewGroup
|
layout |
ViewGroup
|
void enter ()
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.
void exit ()
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.
Scene getSceneForLayout (ViewGroup sceneRoot, int layoutId, Context context)
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 |
ViewGroup:
The root of the hierarchy in which scene changes
and transitions will take place. |
layoutId |
int:
The id of a standard layout resource file. |
context |
Context:
The context used in the process of inflating
the layout resource. |
| Returns | |
|---|---|
Scene |
The scene for the given root and layout id |
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.
| Returns | |
|---|---|
ViewGroup |
The root of the view hierarchy affected by this scene. |
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. 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 |
Runnable:
The runnable whose run() method will
be called when this scene is entered |
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. 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.
| Parameters | |
|---|---|
action |
Runnable
|
Developers