Class PagerFragment

  • All Implemented Interfaces:
    android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, androidx.savedstate.SavedStateRegistryOwner
    Direct Known Subclasses:
    LeaderboardPagerFragment

    public abstract class PagerFragment
    extends androidx.fragment.app.Fragment
    Fragment for showing multiple fragments as pages in a view pager via PagerAdapter
    • Nested Class Summary

      • Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

        androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState
    • Constructor Summary

      Constructors 
      Constructor Description
      PagerFragment()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void attach​(com.google.android.material.tabs.TabLayout tabLayout)
      Attaches the viewpager to the TabLayout.
      protected int getContentLayoutId()  
      protected int getOffscreenLimit()
      Returns the number of pages that will be retained to either side of the current page
      protected abstract java.util.List<androidx.fragment.app.Fragment> getPages()
      Returns list of pages to be shown as pages
      protected java.util.List<java.lang.String> getPageTitles()
      Returns page titles
      protected BaseViewPager getViewPager()
      Returns the view pager
      protected boolean isPagingEnabled()
      Returns paging settings
      protected androidx.fragment.app.FragmentPagerAdapter onCreateAdapter()
      Returns the pager adapter
      android.view.View onCreateView​(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)  
      • Methods inherited from class androidx.fragment.app.Fragment

        dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreate, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onResume, onSaveInstanceState, onStart, onStop, onViewCreated, onViewStateRestored, postponeEnterTransition, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PagerFragment

        public PagerFragment()
    • Method Detail

      • getContentLayoutId

        @LayoutRes
        protected int getContentLayoutId()
      • onCreateView

        @Nullable
        public android.view.View onCreateView​(@NonNull
                                              android.view.LayoutInflater inflater,
                                              @Nullable
                                              android.view.ViewGroup container,
                                              @Nullable
                                              android.os.Bundle savedInstanceState)
        Overrides:
        onCreateView in class androidx.fragment.app.Fragment
      • onCreateAdapter

        protected androidx.fragment.app.FragmentPagerAdapter onCreateAdapter()
        Returns the pager adapter
        Returns:
        instance of FragmentPagerAdapter
      • getPages

        protected abstract java.util.List<androidx.fragment.app.Fragment> getPages()
        Returns list of pages to be shown as pages
        Returns:
        list of fragments
      • getPageTitles

        protected java.util.List<java.lang.String> getPageTitles()
        Returns page titles
        Returns:
        list of page title
      • isPagingEnabled

        protected boolean isPagingEnabled()
        Returns paging settings
        Returns:
        true if swiping to change page is allowed, false otherwise
      • getOffscreenLimit

        protected int getOffscreenLimit()
        Returns the number of pages that will be retained to either side of the current page
        Returns:
        offscreen limit
      • attach

        public void attach​(com.google.android.material.tabs.TabLayout tabLayout)
        Attaches the viewpager to the TabLayout.
        Parameters:
        tabLayout - layout where view pager is attached