com.flipboard.bottomsheet.commons

Class BottomSheetFragment

java.lang.Object

android.support.v4.app.Fragment

com.flipboard.bottomsheet.commons.BottomSheetFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, BottomSheetFragmentInterface

public class BottomSheetFragment
extends android.support.v4.app.Fragment
implements BottomSheetFragmentInterface

A fragment that shows itself in a BottomSheetLayout. Like a DialogFragment, you can show this either in a bottom sheet by using show(FragmentManager, int) or attach it to a view with the normal fragment transaction methods.

If you don't want to extend from this for your fragment instance, you can use BottomSheetFragmentDelegate in your fragment implementation instead. You must, however, still implement BottomSheetFragmentInterface.

Nested Class Summary

Nested classes/interfaces inherited from class android.support.v4.app.Fragment

android.support.v4.app.Fragment.InstantiationException, android.support.v4.app.Fragment.SavedState

Constructor Summary

Constructors

Constructor and Description
BottomSheetFragment()

Method Summary

Modifier and Type	Method and Description
void	dismiss() Dismiss the fragment and it's bottom sheet.
void	dismissAllowingStateLoss() Version of BottomSheetFragmentInterface.dismiss() that uses FragmentTransaction.commitAllowingStateLoss().
android.view.LayoutInflater	getLayoutInflater(android.os.Bundle savedInstanceState)
com.flipboard.bottomsheet.ViewTransformer	getViewTransformer() Override this to proved a custom ViewTransformer.
void	onActivityCreated(android.os.Bundle savedInstanceState)
void	onAttach(android.content.Context context)
void	onCreate(android.os.Bundle savedInstanceState)
void	onDestroyView()
void	onDetach()
void	onSaveInstanceState(android.os.Bundle outState)
void	onStart()
void	show(android.support.v4.app.FragmentManager manager, int bottomSheetLayoutId) Display the bottom sheet, adding the fragment to the given FragmentManager.
int	show(android.support.v4.app.FragmentTransaction transaction, int bottomSheetLayoutId) Display the bottom sheet, adding the fragment using an excising transaction and then committing the transaction.

Methods inherited from class android.support.v4.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isVisible, onActivityResult, onAttach, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateContextMenu, onCreateOptionsMenu, onCreateView, onDestroy, onDestroyOptionsMenu, onHiddenChanged, onInflate, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPrepareOptionsMenu, onRequestPermissionsResult, onResume, onStop, onViewCreated, onViewStateRestored, registerForContextMenu, requestPermissions, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BottomSheetFragment

public BottomSheetFragment()

Method Detail

show

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

Display the bottom sheet, adding the fragment to the given FragmentManager. This does not add the transaction to the back stack. When teh fragment is dismissed, a new transaction will be executed to remove it from the activity.

Specified by:

show in interface BottomSheetFragmentInterface

Parameters:

manager - The FragmentManager this fragment will be added to.

bottomSheetLayoutId - The bottom sheet layoutId in the parent view to attach the fragment to.

show

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

Display the bottom sheet, adding the fragment using an excising transaction and then committing the transaction.

Specified by:

show in interface BottomSheetFragmentInterface

Parameters:

transaction - An existing transaction in which to add the fragment.

bottomSheetLayoutId - The bottom sheet layoutId in the parent view to attach the fragment to.

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.

Specified by:

dismiss in interface BottomSheetFragmentInterface

dismissAllowingStateLoss

public void dismissAllowingStateLoss()

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

Specified by:

dismissAllowingStateLoss in interface BottomSheetFragmentInterface

getViewTransformer

public com.flipboard.bottomsheet.ViewTransformer getViewTransformer()

Override this to proved a custom ViewTransformer.

Specified by:

getViewTransformer in interface BottomSheetFragmentInterface

onAttach

public void onAttach(android.content.Context context)

Overrides:

onAttach in class android.support.v4.app.Fragment

onDetach

public void onDetach()

Overrides:

onDetach in class android.support.v4.app.Fragment

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

Overrides:

onCreate in class android.support.v4.app.Fragment

getLayoutInflater

public android.view.LayoutInflater getLayoutInflater(android.os.Bundle savedInstanceState)

Overrides:

getLayoutInflater in class android.support.v4.app.Fragment

onActivityCreated

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

Overrides:

onActivityCreated in class android.support.v4.app.Fragment

onStart

public void onStart()

Overrides:

onStart in class android.support.v4.app.Fragment

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)

Overrides:

onSaveInstanceState in class android.support.v4.app.Fragment

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class android.support.v4.app.Fragment