com.flipboard.bottomsheet.commons

Class BottomSheetFragmentDelegate

java.lang.Object

com.flipboard.bottomsheet.commons.BottomSheetFragmentDelegate

All Implemented Interfaces:

com.flipboard.bottomsheet.OnSheetDismissedListener

public final class BottomSheetFragmentDelegate
extends java.lang.Object
implements com.flipboard.bottomsheet.OnSheetDismissedListener

This class represents a delegate which you can use to extend BottomSheet's fragment support to any Fragment implementing BottomSheetFragmentInterface.

When using an BottomSheetFragmentDelegate, you should any methods exposed in it rather than the Fragment method of the same name. This applies to:

• show(FragmentManager, int)
• show(FragmentTransaction, int)
• dismiss()
• dismissAllowingStateLoss()

There also some Fragment lifecycle methods which should be proxied to the delegate:

• onCreate(android.os.Bundle)
• onAttach(Context)
• onDetach()
• getLayoutInflater(Bundle, LayoutInflater)
• onActivityCreated(Bundle)
• onStart()
• onSaveInstanceState(Bundle)
• onDestroyView()

An Activity can only be linked with one BottomSheetFragmentDelegate instance, so the instance returned from create(BottomSheetFragmentInterface) should be kept until the Activity is destroyed.

Method Summary

Modifier and Type	Method and Description
static BottomSheetFragmentDelegate	create(BottomSheetFragmentInterface sheetFragmentInterface)
void	dismiss() Dismiss the fragment and it's bottom sheet.
void	dismissAllowingStateLoss() Version of dismiss() that uses FragmentTransaction.commitAllowingStateLoss().
com.flipboard.bottomsheet.BottomSheetLayout	getBottomSheetLayout()
android.view.LayoutInflater	getLayoutInflater(android.os.Bundle savedInstanceState, android.view.LayoutInflater superInflater) Retrieves the appropriate layout inflater, either the sheet's or the view's super container.
void	onActivityCreated(android.os.Bundle savedInstanceState) Corresponding onActivityCreated() method
void	onAttach(android.content.Context context) Corresponding onAttach() method
void	onCreate(android.os.Bundle savedInstanceState) Corresponding onCreate() method
void	onDestroyView() Corresponding onDestroyView() method
void	onDetach() Corresponding onDetach() method
void	onDismissed(com.flipboard.bottomsheet.BottomSheetLayout bottomSheetLayout)
void	onSaveInstanceState(android.os.Bundle outState) Corresponding onSaveInstanceState() method
void	onStart() Corresponding onStart() method
void	show(android.support.v4.app.FragmentManager manager, int bottomSheetLayoutId) DialogFragment-like show() method for displaying this the associated sheet fragment
int	show(android.support.v4.app.FragmentTransaction transaction, int bottomSheetLayoutId) DialogFragment-like show() method for displaying this the associated sheet fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static BottomSheetFragmentDelegate create(BottomSheetFragmentInterface sheetFragmentInterface)

show

public void show(android.support.v4.app.FragmentManager manager,
                 @IdRes
                 int bottomSheetLayoutId)

DialogFragment-like show() method for displaying this the associated sheet fragment

Parameters:

manager - FragmentManager instance

bottomSheetLayoutId - Resource ID of the BottomSheetLayout

show

public int show(android.support.v4.app.FragmentTransaction transaction,
                @IdRes
                int bottomSheetLayoutId)

DialogFragment-like show() method for displaying this the associated sheet fragment

Parameters:

transaction - FragmentTransaction instance

bottomSheetLayoutId - Resource ID of the BottomSheetLayout

Returns:

the back stack ID of the fragment after the transaction is committed.

dismiss

public void dismiss()

Dismiss the fragment and it's bottom sheet. If the fragment was added to the back stack, all back stack state up to and including this entry will be popped. Otherwise, a new transaction will be committed to remove this fragment.

dismissAllowingStateLoss

public void dismissAllowingStateLoss()

Version of dismiss() that uses FragmentTransaction.commitAllowingStateLoss(). See linked documentation for further details.

onAttach

public void onAttach(android.content.Context context)

Corresponding onAttach() method

Parameters:

context - Context to match the Fragment API, unused.

onDetach

public void onDetach()

Corresponding onDetach() method

onCreate

public void onCreate(@Nullable
                     android.os.Bundle savedInstanceState)

Corresponding onCreate() method

Parameters:

savedInstanceState - Instance state, can be null.

getLayoutInflater

@CheckResult
public android.view.LayoutInflater getLayoutInflater(android.os.Bundle savedInstanceState,
                                                                  android.view.LayoutInflater superInflater)

Retrieves the appropriate layout inflater, either the sheet's or the view's super container. Note that you should handle the result of this in your getLayoutInflater method.

Parameters:

savedInstanceState - Instance state, here to match Fragment API but unused.

superInflater - The result of the view's inflater, usually the result of super.getLayoutInflater()

Returns:

the layout inflater to use

getBottomSheetLayout

public com.flipboard.bottomsheet.BottomSheetLayout getBottomSheetLayout()

Returns:

this fragment sheet's BottomSheetLayout.

onActivityCreated

public void onActivityCreated(@Nullable
                              android.os.Bundle savedInstanceState)

Corresponding onActivityCreated() method

Parameters:

savedInstanceState - Instance state, here to match the Fragment API but unused

onStart

public void onStart()

Corresponding onStart() method

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)

Corresponding onSaveInstanceState() method

Parameters:

outState - The output state, here to match the Fragment API but unused

onDestroyView

public void onDestroyView()

Corresponding onDestroyView() method

onDismissed

@CallSuper
public void onDismissed(com.flipboard.bottomsheet.BottomSheetLayout bottomSheetLayout)

Specified by:

onDismissed in interface com.flipboard.bottomsheet.OnSheetDismissedListener