PlaybackOverlayFragment - Android SDK

public class

PlaybackOverlayFragment

extends DetailsFragment

java.lang.Object
↳	android.app.Fragment
	↳	android.support.v17.leanback.app.DetailsFragment
		↳	android.support.v17.leanback.app.PlaybackOverlayFragment

Class Overview

A fragment for displaying playback controls and related content.

A PlaybackOverlayFragment renders the elements of its ObjectAdapter as a set of rows in a vertical list. The elements in this adapter must be subclasses of Row.

An instance of PlaybackControlsRow is expected to be at position 0 in the adapter.

Summary

Nested Classes
interface	PlaybackOverlayFragment.InputEventHandler	Interface allowing the application to handle input events.
class	PlaybackOverlayFragment.OnFadeCompleteListener	Listener allowing the application to receive notification of fade in and/or fade out completion events.

[Expand]

Inherited XML Attributes

From class android.app.Fragment

Constants
int	BG_DARK	A dark translucent background.
int	BG_LIGHT	A light translucent background.
int	BG_NONE	No background.

[Expand]

Inherited Constants

From interface android.content.ComponentCallbacks2

Public Constructors
	PlaybackOverlayFragment()

Public Methods
int	getBackgroundType() Returns the background type.
PlaybackOverlayFragment.OnFadeCompleteListener	getFadeCompleteListener() Returns the listener to be called when fade in or out has completed.
final PlaybackOverlayFragment.InputEventHandler	getInputEventHandler() Returns the input event handler.
boolean	isFadingEnabled() Returns true if view fading is enabled.
void	onCreate(Bundle savedInstanceState) Called to do initial creation of a fragment.
View	onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) Called to have the fragment instantiate its user interface view.
void	onDestroyView() Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
void	onResume() Called when the fragment is visible to the user and actively running.
void	setAdapter(ObjectAdapter adapter) Sets the list of rows for the fragment.
void	setBackgroundType(int type) Sets the background type.
void	setFadeCompleteListener(PlaybackOverlayFragment.OnFadeCompleteListener listener) Sets the listener to be called when fade in or out has completed.
void	setFadingEnabled(boolean enabled) Enables or disables view fading.
final void	setInputEventHandler(PlaybackOverlayFragment.InputEventHandler handler) Sets the input event handler.
void	tickle() Tickles the playback controls.

[Expand]

Inherited Methods

From class android.support.v17.leanback.app.DetailsFragment

From class android.app.Fragment

void	dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) Print the Fragments's state into the given stream.
final boolean	equals(Object o) Subclasses can not override equals().
final Activity	getActivity() Return the Activity this fragment is currently associated with.
boolean	getAllowEnterTransitionOverlap() Returns whether the the exit transition and enter transition overlap or not.
boolean	getAllowReturnTransitionOverlap() Returns whether the the return transition and reenter transition overlap or not.
final Bundle	getArguments() Return the arguments supplied to `setArguments(Bundle)`, if any.
final FragmentManager	getChildFragmentManager() Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
Context	getContext() Return the `Context` this fragment is currently associated with.
Transition	getEnterTransition() Returns the Transition that will be used to move Views into the initial scene.
Transition	getExitTransition() Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
final FragmentManager	getFragmentManager() Return the FragmentManager for interacting with fragments associated with this fragment's activity.
final Object	getHost() Return the host object of this fragment.
final int	getId() Return the identifier this fragment is known by.
LoaderManager	getLoaderManager() Return the LoaderManager for this fragment, creating it if needed.
final Fragment	getParentFragment() Returns the parent Fragment containing this Fragment.
Transition	getReenterTransition() Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
final Resources	getResources() Return `getActivity().getResources()`.
final boolean	getRetainInstance()
Transition	getReturnTransition() Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
Transition	getSharedElementEnterTransition() Returns the Transition that will be used for shared elements transferred into the content Scene.
Transition	getSharedElementReturnTransition() Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
final String	getString(int resId) Return a localized string from the application's package's default string table.
final String	getString(int resId, Object... formatArgs) Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)`.
final String	getTag() Get the tag name of the fragment, if specified.
final Fragment	getTargetFragment() Return the target fragment set by `setTargetFragment(Fragment, int)`.
final int	getTargetRequestCode() Return the target request code set by `setTargetFragment(Fragment, int)`.
final CharSequence	getText(int resId) Return a localized, styled CharSequence from the application's package's default string table.
boolean	getUserVisibleHint()
View	getView() Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`), if provided.
final int	hashCode() Subclasses can not override hashCode().
static Fragment	instantiate(Context context, String fname) Like `instantiate(Context, String, Bundle)` but with a null argument Bundle.
static Fragment	instantiate(Context context, String fname, Bundle args) Create a new instance of a Fragment with the given class name.
final boolean	isAdded() Return true if the fragment is currently added to its activity.
final boolean	isDetached() Return true if the fragment has been explicitly detached from the UI.
final boolean	isHidden() Return true if the fragment has been hidden.
final boolean	isInLayout() Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
final boolean	isRemoving() Return true if this fragment is currently being removed from its activity.
final boolean	isResumed() Return true if the fragment is in the resumed state.
final boolean	isVisible() Return true if the fragment is currently visible to the user.
void	onActivityCreated(Bundle savedInstanceState) Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
void	onActivityResult(int requestCode, int resultCode, Intent data) Receive the result from a previous call to `startActivityForResult(Intent, int)`.
void	onAttach(Context context) Called when a fragment is first attached to its context.
void	onAttach(Activity activity) This method was deprecated in API level 23. Use `onAttach(Context)` instead.
void	onConfigurationChanged(Configuration newConfig) Called by the system when the device configuration changes while your component is running.
boolean	onContextItemSelected(MenuItem item) This hook is called whenever an item in a context menu is selected.
void	onCreate(Bundle savedInstanceState) Called to do initial creation of a fragment.
Animator	onCreateAnimator(int transit, boolean enter, int nextAnim) Called when a fragment loads an animation.
void	onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo) Called when a context menu for the `view` is about to be shown.
void	onCreateOptionsMenu(Menu menu, MenuInflater inflater) Initialize the contents of the Activity's standard options menu.
View	onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) Called to have the fragment instantiate its user interface view.
void	onDestroy() Called when the fragment is no longer in use.
void	onDestroyOptionsMenu() Called when this fragment's option menu items are no longer being included in the overall options menu.
void	onDestroyView() Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
void	onDetach() Called when the fragment is no longer attached to its activity.
void	onHiddenChanged(boolean hidden) Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
void	onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState) Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
void	onInflate(AttributeSet attrs, Bundle savedInstanceState) This method was deprecated in API level 12. Use `onInflate(Context, AttributeSet, Bundle)` instead.
void	onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) This method was deprecated in API level 23. Use `onInflate(Context, AttributeSet, Bundle)` instead.
void	onLowMemory() This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
boolean	onOptionsItemSelected(MenuItem item) This hook is called whenever an item in your options menu is selected.
void	onOptionsMenuClosed(Menu menu) This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
void	onPause() Called when the Fragment is no longer resumed.
void	onPrepareOptionsMenu(Menu menu) Prepare the Screen's standard options menu to be displayed.
void	onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) Callback for the result from requesting permissions.
void	onResume() Called when the fragment is visible to the user and actively running.
void	onSaveInstanceState(Bundle outState) Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance of its process is restarted.
void	onStart() Called when the Fragment is visible to the user.
void	onStop() Called when the Fragment is no longer started.
void	onTrimMemory(int level) Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
void	onViewCreated(View view, Bundle savedInstanceState) Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
void	onViewStateRestored(Bundle savedInstanceState) Called when all saved state has been restored into the view hierarchy of the fragment.
void	registerForContextMenu(View view) Registers a context menu to be shown for the given view (multiple views can show the context menu).
final void	requestPermissions(String[] permissions, int requestCode) Requests permissions to be granted to this application.
void	setAllowEnterTransitionOverlap(boolean allow) Sets whether the the exit transition and enter transition overlap or not.
void	setAllowReturnTransitionOverlap(boolean allow) Sets whether the the return transition and reenter transition overlap or not.
void	setArguments(Bundle args) Supply the construction arguments for this fragment.
void	setEnterSharedElementCallback(SharedElementCallback callback) When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
void	setEnterTransition(Transition transition) Sets the Transition that will be used to move Views into the initial scene.
void	setExitSharedElementCallback(SharedElementCallback callback) When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
void	setExitTransition(Transition transition) Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
void	setHasOptionsMenu(boolean hasMenu) Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
void	setInitialSavedState(Fragment.SavedState state) Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
void	setMenuVisibility(boolean menuVisible) Set a hint for whether this fragment's menu should be visible.
void	setReenterTransition(Transition transition) Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
void	setRetainInstance(boolean retain) Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
void	setReturnTransition(Transition transition) Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
void	setSharedElementEnterTransition(Transition transition) Sets the Transition that will be used for shared elements transferred into the content Scene.
void	setSharedElementReturnTransition(Transition transition) Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
void	setTargetFragment(Fragment fragment, int requestCode) Optional target for this fragment.
void	setUserVisibleHint(boolean isVisibleToUser) Set a hint to the system about whether this fragment's UI is currently visible to the user.
boolean	shouldShowRequestPermissionRationale(String permission) Gets whether you should show UI with rationale for requesting a permission.
void	startActivity(Intent intent) Call `startActivity(Intent)` from the fragment's containing Activity.
void	startActivity(Intent intent, Bundle options) Call `startActivity(Intent, Bundle)` from the fragment's containing Activity.
void	startActivityForResult(Intent intent, int requestCode) Call `startActivityForResult(Intent, int)` from the fragment's containing Activity.
void	startActivityForResult(Intent intent, int requestCode, Bundle options) Call `startActivityForResult(Intent, int, Bundle)` from the fragment's containing Activity.
String	toString() Returns a string containing a concise, human-readable description of this object.
void	unregisterForContextMenu(View view) Prevents a context menu to be shown for the given view.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.content.ComponentCallbacks2

From interface android.view.View.OnCreateContextMenuListener

From interface android.content.ComponentCallbacks

Constants

public static final int BG_DARK

A dark translucent background.

Constant Value: 1 (0x00000001)

public static final int BG_LIGHT

A light translucent background.

Constant Value: 2 (0x00000002)

public static final int BG_NONE

No background.

Constant Value: 0 (0x00000000)

Public Constructors

public PlaybackOverlayFragment ()

Public Methods

public int getBackgroundType ()

Returns the background type.

public PlaybackOverlayFragment.OnFadeCompleteListener getFadeCompleteListener ()

Returns the listener to be called when fade in or out has completed.

public final PlaybackOverlayFragment.InputEventHandler getInputEventHandler ()

Returns the input event handler.

public boolean isFadingEnabled ()

Returns true if view fading is enabled.

public void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach(Activity) and before onCreateView(LayoutInflater, ViewGroup, Bundle).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, see onActivityCreated(Bundle).

Parameters

savedInstanceState	If the fragment is being re-created from a previous saved state, this is the state.

public View onCreateView (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null (which is the default implementation). This will be called between onCreate(Bundle) and onActivityCreated(Bundle).

If you return a View from here, you will later be called in onDestroyView() when the view is being released.

Parameters

inflater	The LayoutInflater object that can be used to inflate any views in the fragment,
container	If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
savedInstanceState	If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns

Return the View for the fragment's UI, or null.

public void onDestroyView ()

Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after onStop() and before onDestroy(). It is called regardless of whether onCreateView(LayoutInflater, ViewGroup, Bundle) returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent.

public void onResume ()

Called when the fragment is visible to the user and actively running. This is generally tied to Activity.onResume of the containing Activity's lifecycle.

public void setAdapter (ObjectAdapter adapter)

Sets the list of rows for the fragment.

public void setBackgroundType (int type)

Sets the background type.

Parameters

type	One of BG_LIGHT, BG_DARK, or BG_NONE.

public void setFadeCompleteListener (PlaybackOverlayFragment.OnFadeCompleteListener listener)

Sets the listener to be called when fade in or out has completed.

public void setFadingEnabled (boolean enabled)

Enables or disables view fading. If enabled, the view will be faded in when the fragment starts, and will fade out after a time period. The timeout period is reset each time tickle() is called.

public final void setInputEventHandler (PlaybackOverlayFragment.InputEventHandler handler)

Sets the input event handler.

public void tickle ()

Tickles the playback controls. Fades in the view if it was faded out, otherwise resets the fade out timer. Tickling on input events is handled by the fragment.

Results

Interfaces

Classes

PlaybackOverlayFragment

Class Overview

Summary

Constants

public static final int BG_DARK

public static final int BG_LIGHT

public static final int BG_NONE

Public Constructors

public PlaybackOverlayFragment ()

Public Methods

public int getBackgroundType ()

public PlaybackOverlayFragment.OnFadeCompleteListener getFadeCompleteListener ()

public final PlaybackOverlayFragment.InputEventHandler getInputEventHandler ()

public boolean isFadingEnabled ()

public void onCreate (Bundle savedInstanceState)

Parameters

public View onCreateView (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Parameters

Returns

public void onDestroyView ()

public void onResume ()

public void setAdapter (ObjectAdapter adapter)

public void setBackgroundType (int type)

Parameters

public void setFadeCompleteListener (PlaybackOverlayFragment.OnFadeCompleteListener listener)

public void setFadingEnabled (boolean enabled)

public final void setInputEventHandler (PlaybackOverlayFragment.InputEventHandler handler)

public void tickle ()