DetailsFragmentBackgroundController

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

class DetailsFragmentBackgroundController

Controller for DetailsFragment parallax background and embedded video play.

The parallax background drawable is made of two parts: cover drawable (by default FitWidthBitmapDrawable) above the details overview row and bottom drawable (by default ColorDrawable) below the details overview row. While vertically scrolling rows, the size of cover drawable and bottom drawable will be updated and the cover drawable will by default perform a parallax shift using PROPERTY_VERTICAL_OFFSET.

       ***************************
       *      Cover Drawable     *
       * (FitWidthBitmapDrawable)*
       *                         *
       ***************************
       *    DetailsOverviewRow   *
       *                         *
       ***************************
       *     Bottom Drawable     *
       *      (ColorDrawable)    *
       *         Related         *
       *         Content         *
       ***************************

Both parallax background drawable and embedded video play are optional. App must call enableParallax and/or setupVideoPlayback explicitly. The PlaybackGlue is automatically play when fragment starts and pause when fragment stops. When video is ready to play, cover drawable will be faded out. Example:

DetailsFragmentBackgroundController mController = new DetailsFragmentBackgroundController(this);

public void onCreate(Bundle savedInstance) {
    super.onCreate(savedInstance);
    MediaPlayerGlue player = new MediaPlayerGlue(..);
    player.setUrl(...);
    mController.enableParallax();
    mController.setupVideoPlayback(player);
}

static class MyLoadBitmapTask extends ... {
    WeakReferencemFragmentRef;
    MyLoadBitmapTask(MyFragment fragment) {
        mFragmentRef = new WeakReference(fragment);
    }
    protected void onPostExecute(Bitmap bitmap) {
        MyFragment fragment = mFragmentRef.get();
        if (fragment != null) {
            fragment.mController.setCoverBitmap(bitmap);
        }
    }
}

public void onStart() {
    new MyLoadBitmapTask(this).execute(url);
}

public void onStop() {
    mController.setCoverBitmap(null);
}

To customize cover drawable and/or bottom drawable, app should call enableParallax. If app supplies a custom cover Drawable, it should not call setCoverBitmap. If app supplies a custom bottom Drawable, it should not call setSolidColor.

To customize playback fragment, app should override onCreateVideoFragment and onCreateGlueHost.

Summary

Public constructors
`DetailsFragmentBackgroundController(fragment: DetailsFragment!)` Creates a DetailsFragmentBackgroundController for a DetailsFragment.

Public functions
`Boolean`	`canNavigateToVideoFragment()` Precondition allows user navigate to video fragment using DPAD.
`Unit`	`enableParallax()` Enables default parallax background using a `FitWidthBitmapDrawable` as cover drawable and `ColorDrawable` as bottom drawable.
`Unit`	`enableParallax( coverDrawable: Drawable, bottomDrawable: Drawable, coverDrawableParallaxTarget: ParallaxTarget.PropertyValuesHolderTarget? )` Enables parallax background using a custom cover drawable at top and a custom bottom drawable.
`Fragment!`	`findOrCreateVideoFragment()` Adds or gets fragment for rendering video in DetailsFragment.
`Drawable!`	`getBottomDrawable()` Returns the drawable at bottom.
`Bitmap!`	`getCoverBitmap()` Returns Bitmap set by `setCoverBitmap`.
`Drawable!`	`getCoverDrawable()` Returns the cover drawable at top.
`Int`	`getParallaxDrawableMaxOffset()` Returns Default parallax offset in pixels for bitmap moving vertically.
`PlaybackGlue!`	`getPlaybackGlue()` Returns current PlaybackGlue or null if not set or cleared.
`@ColorInt Int`	`getSolidColor()` Returns color set by `setSolidColor`.
`PlaybackGlueHost!`	`onCreateGlueHost()` Creates a PlaybackGlueHost to host PlaybackGlue.
`Fragment!`	`onCreateVideoFragment()` Creates a Fragment to host `PlaybackGlue`.
`Unit`	`setCoverBitmap(bitmap: Bitmap!)` Convenient method to set Bitmap in cover drawable.
`Unit`	`setParallaxDrawableMaxOffset(offset: Int)` Sets default parallax offset in pixels for bitmap moving vertically.
`Unit`	`setSolidColor(color: @ColorInt Int)` Convenient method to set color in bottom drawable.
`Unit`	`setupVideoPlayback(playbackGlue: PlaybackGlue)` Enable video playback and set proper `PlaybackGlueHost`.
`Unit`	`switchToRows()` Switch to rows fragment.
`Unit`	`switchToVideo()` Switch to video fragment, note that this method is not affected by result of `canNavigateToVideoFragment`.

Public constructors

DetailsFragmentBackgroundController

Added in 1.1.0

Deprecated in 1.1.0

DetailsFragmentBackgroundController(fragment: DetailsFragment!)

Creates a DetailsFragmentBackgroundController for a DetailsFragment. Note that each DetailsFragment can only associate with one DetailsFragmentBackgroundController.

Parameters
`fragment: DetailsFragment!`	The DetailsFragment to control background and embedded video playing.

Throws
`java.lang.IllegalStateException`	If fragment was already associated with another controller.

Public functions

canNavigateToVideoFragment

Added in 1.1.0

Deprecated in 1.1.0

fun canNavigateToVideoFragment(): Boolean

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.

Returns
`Boolean`	True allow to navigate to video fragment.

enableParallax

Added in 1.1.0

Deprecated in 1.1.0

fun enableParallax(): Unit

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 and setCoverBitmap to change the content of bottom drawable and cover drawable. This method must be called before setupVideoPlayback.

Throws
`java.lang.IllegalStateException`	If `setupVideoPlayback` was called.

See also
`setCoverBitmap`
`setSolidColor`

Added in 1.1.0

Deprecated in 1.1.0

fun enableParallax(
    coverDrawable: Drawable,
    bottomDrawable: Drawable,
    coverDrawableParallaxTarget: ParallaxTarget.PropertyValuesHolderTarget?
): Unit

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

Parameters
`coverDrawable: Drawable`	Custom cover drawable shown at top. `setCoverBitmap` will not work if coverDrawable is not `FitWidthBitmapDrawable`; in that case it's app's responsibility to set content into coverDrawable.
`bottomDrawable: Drawable`	Drawable shown at bottom. `setSolidColor` will not work if bottomDrawable is not `ColorDrawable`; in that case it's app's responsibility to set content of bottomDrawable.
`coverDrawableParallaxTarget: ParallaxTarget.PropertyValuesHolderTarget?`	Target to perform parallax effect within coverDrawable. Use null for no parallax movement effect. Example to move bitmap within FitWidthBitmapDrawable: new ParallaxTarget.PropertyValuesHolderTarget( coverDrawable, PropertyValuesHolder.ofInt( FitWidthBitmapDrawable.PROPERTY_VERTICAL_OFFSET, 0, -120))

Throws
`java.lang.IllegalStateException`	If `setupVideoPlayback` was called.

findOrCreateVideoFragment

Added in 1.1.0

Deprecated in 1.1.0

fun findOrCreateVideoFragment(): Fragment!

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

Returns
`Fragment!`	Fragment the added or restored fragment responsible for rendering video.

See also
`onCreateGlueHost`

getBottomDrawable

Added in 1.1.0

Deprecated in 1.1.0

fun getBottomDrawable(): Drawable!

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

Returns
`Drawable!`	The bottom drawable.

getCoverBitmap

Added in 1.1.0

Deprecated in 1.1.0

fun getCoverBitmap(): Bitmap!

Returns Bitmap set by setCoverBitmap.

Returns
`Bitmap!`	Bitmap for cover drawable.

getCoverDrawable

Added in 1.1.0

Deprecated in 1.1.0

fun getCoverDrawable(): Drawable!

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

Returns
`Drawable!`	The cover drawable at top.

getParallaxDrawableMaxOffset

Added in 1.1.0

Deprecated in 1.1.0

fun getParallaxDrawableMaxOffset(): Int

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

Returns
`Int`	Default parallax offset in pixels for bitmap moving vertically.

See also
`enableParallax`

getPlaybackGlue

Added in 1.1.0

Deprecated in 1.1.0

fun getPlaybackGlue(): PlaybackGlue!

Returns current PlaybackGlue or null if not set or cleared.

Returns
`PlaybackGlue!`	Current PlaybackGlue or null

getSolidColor

Added in 1.1.0

Deprecated in 1.1.0

fun getSolidColor(): @ColorInt Int

Returns color set by setSolidColor.

Returns
`@ColorInt Int`	Solid color used for bottom drawable.

onCreateGlueHost

Added in 1.1.0

Deprecated in 1.1.0

fun onCreateGlueHost(): PlaybackGlueHost!

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

Returns
`PlaybackGlueHost!`	A new PlaybackGlueHost to host PlaybackGlue.

See also
`onCreateVideoFragment`
`findOrCreateVideoFragment`
`setupVideoPlayback`

onCreateVideoFragment

Added in 1.1.0

Deprecated in 1.1.0

fun onCreateVideoFragment(): Fragment!

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

Returns
`Fragment!`	A new fragment used in `onCreateGlueHost`.

See also
`onCreateGlueHost`
`setupVideoPlayback`

setCoverBitmap

Added in 1.1.0

Deprecated in 1.1.0

fun setCoverBitmap(bitmap: Bitmap!): Unit

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.

Parameters
`bitmap: Bitmap!`	bitmap to set as cover.

setParallaxDrawableMaxOffset

Added in 1.1.0

Deprecated in 1.1.0

fun setParallaxDrawableMaxOffset(offset: Int): Unit

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

Parameters
`offset: Int`	Offset in pixels (e.g. 120).

See also
`enableParallax`

setSolidColor

Added in 1.1.0

Deprecated in 1.1.0

fun setSolidColor(color: @ColorInt Int): Unit

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.

Parameters
`color: @ColorInt Int`	color for bottom drawable.

setupVideoPlayback

Added in 1.1.0

Deprecated in 1.1.0

fun setupVideoPlayback(playbackGlue: PlaybackGlue): Unit

Enable video playback and set proper PlaybackGlueHost. This method by default creates a VideoFragment and VideoFragmentGlueHost 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.

Parameters
`playbackGlue: PlaybackGlue`	The new PlaybackGlue to set as background or null to clear existing one.

See also
`onCreateVideoFragment`
`onCreateGlueHost`

switchToRows

Added in 1.1.0

Deprecated in 1.1.0

fun switchToRows(): Unit

Switch to rows fragment.

switchToVideo

Added in 1.1.0

Deprecated in 1.1.0

fun switchToVideo(): Unit

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

Calling switchToVideo() in DetailsFragment.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.