DetailsSupportFragmentBackgroundController

DetailsSupportFragmentBackgroundController

 DetailsSupportFragmentBackgroundController (DetailsSupportFragment fragment)

Creates a DetailsSupportFragmentBackgroundController for a DetailsSupportFragment. Note that each DetailsSupportFragment can only associate with one DetailsSupportFragmentBackgroundController.

canNavigateToVideoSupportFragment

 boolean canNavigateToVideoSupportFragment ()

Precondition allows user navigate to video fragment using DPAD. Default implementation returns true if PlaybackGlue is not null. Subclass may override, e.g. only allow navigation when isPrepared() is true. Note this method does not block app calls switchToVideo().

enableParallax

 void enableParallax (Drawable coverDrawable, Drawable bottomDrawable, ParallaxTarget.PropertyValuesHolderTarget coverDrawableParallaxTarget)

Enables parallax background using a custom cover drawable at top and a custom bottom drawable. This method must be called before setupVideoPlayback(PlaybackGlue).

enableParallax

 void enableParallax ()

Enables default parallax background using a FitWidthBitmapDrawable as cover drawable and ColorDrawable as bottom drawable. A vertical parallax movement will be applied to the FitWidthBitmapDrawable. App may use setSolidColor(int) and setCoverBitmap(Bitmap) to change the content of bottom drawable and cover drawable. This method must be called before setupVideoPlayback(PlaybackGlue).

findOrCreateVideoSupportFragment

 Fragment findOrCreateVideoSupportFragment ()

Adds or gets fragment for rendering video in DetailsSupportFragment. A subclass that overrides onCreateGlueHost() should call this method to get a fragment for creating a PlaybackGlueHost.

getBottomDrawable

 Drawable getBottomDrawable ()

Returns the drawable at bottom. Returns null if enableParallax() is not called. By default it's a ColorDrawable.

getCoverBitmap

 Bitmap getCoverBitmap ()

Returns Bitmap set by setCoverBitmap(Bitmap).

getCoverDrawable

 Drawable getCoverDrawable ()

Returns the cover drawable at top. Returns null if enableParallax() is not called. By default it's a FitWidthBitmapDrawable.

getParallaxDrawableMaxOffset

 int getParallaxDrawableMaxOffset ()

Returns Default parallax offset in pixels for bitmap moving vertically. When 0, a default value would be used.

getPlaybackGlue

 PlaybackGlue getPlaybackGlue ()

Returns current PlaybackGlue or null if not set or cleared.

getSolidColor

 int getSolidColor ()

Returns color set by setSolidColor(int).

onCreateGlueHost

 PlaybackGlueHost onCreateGlueHost ()

Creates a PlaybackGlueHost to host PlaybackGlue. App may override this if it overrides onCreateVideoSupportFragment(). This method must be called after calling Fragment super.onCreate(). When override this method, app may call findOrCreateVideoSupportFragment() to get or create a fragment.

onCreateVideoSupportFragment

 Fragment onCreateVideoSupportFragment ()

Creates a Fragment to host PlaybackGlue. Returns a new VideoSupportFragment by default. App may override and return a different fragment and it also must override onCreateGlueHost().

setCoverBitmap

 void setCoverBitmap (Bitmap bitmap)

Convenient method to set Bitmap in cover drawable. If app is not using default FitWidthBitmapDrawable, app should not use this method It's safe to call setCoverBitmap() before calling enableParallax().

setParallaxDrawableMaxOffset

 void setParallaxDrawableMaxOffset (int offset)

Sets default parallax offset in pixels for bitmap moving vertically. This method must be called before enableParallax().

setSolidColor

 void setSolidColor (int color)

Convenient method to set color in bottom drawable. If app is not using default ColorDrawable, app should not use this method. It's safe to call setSolidColor() before calling enableParallax().

setupVideoPlayback

 void setupVideoPlayback (PlaybackGlue playbackGlue)

Enable video playback and set proper PlaybackGlueHost. This method by default creates a VideoSupportFragment and VideoSupportFragmentGlueHost to host the PlaybackGlue. This method must be called after calling details Fragment super.onCreate(). This method can be called multiple times to replace existing PlaybackGlue or calling setupVideoPlayback(null) to clear. Note a typical PlaybackGlue subclass releases resources in onDetachedFromHost(), when the PlaybackGlue subclass is not doing that, it's app's responsibility to release the resources.

switchToRows

 void switchToRows ()

Switch to rows fragment.

switchToVideo

 void switchToVideo ()

Switch to video fragment, note that this method is not affected by result of canNavigateToVideoSupportFragment(). If the method is called in DetailsSupportFragment.onCreate() it will make video fragment to be initially focused once it is created.

Calling switchToVideo() in DetailsSupportFragment.onCreate() will clear the activity enter transition and shared element transition.

If switchToVideo() is called after prepareEntranceTransition() and before onEntranceTransitionEnd(), it will be ignored.

If prepareEntranceTransition() is called after switchToVideo(), an IllegalStateException will be thrown.