All Implemented Interfaces:

android.content.ComponentCallbacks , android.view.View.OnCreateContextMenuListener , androidx.activity.result.ActivityResultCaller , androidx.lifecycle.HasDefaultViewModelProviderFactory , androidx.lifecycle.LifecycleOwner , androidx.lifecycle.ViewModelStoreOwner , androidx.savedstate.SavedStateRegistryOwner , org.readium.r2.navigator.DecorableNavigator , org.readium.r2.navigator.HyperlinkNavigator , org.readium.r2.navigator.Navigator , org.readium.r2.navigator.OverflowableNavigator , org.readium.r2.navigator.SelectableNavigator , org.readium.r2.navigator.VisualNavigator , org.readium.r2.navigator.preferences.Configurable
```
public final class EpubNavigatorFragment
extends NavigatorFragment implements OverflowableNavigator, SelectableNavigator, DecorableNavigator, HyperlinkNavigator, Configurable<EpubSettings, EpubPreferences>
                    
```
Navigator for EPUB publications.
To use this Fragment, create a factory with EpubNavigatorFragment.createFactory().

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`EpubNavigatorFragment.Configuration`
`public interface`	`EpubNavigatorFragment.PaginationListener`
`public interface`	`EpubNavigatorFragment.Listener`
`public class`	`EpubNavigatorFragment.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final StateFlow<EpubSettings>`	`settings`
`private final SharedPreferences`	`preferences`
`private final View`	`publicationView`
`private final StateFlow<OverflowableNavigator.Overflow>`	`overflow`
`private final ReadingProgression`	`readingProgression`
`private final StateFlow<Locator>`	`currentLocator`
`private final Integer`	`mState`
`private final Bundle`	`mSavedFragmentState`
`private final SparseArray<Parcelable>`	`mSavedViewState`
`private final Bundle`	`mSavedViewRegistryState`
`private final Boolean`	`mSavedUserVisibleHint`
`private final String`	`mWho`
`private final Bundle`	`mArguments`
`private final Fragment`	`mTarget`
`private final String`	`mTargetWho`
`private final Integer`	`mTargetRequestCode`
`private final Boolean`	`mAdded`
`private final Boolean`	`mRemoving`
`private final Boolean`	`mBeingSaved`
`private final Boolean`	`mFromLayout`
`private final Boolean`	`mInLayout`
`private final Boolean`	`mRestored`
`private final Boolean`	`mPerformedCreateView`
`private final Integer`	`mBackStackNesting`
`private final FragmentManager`	`mFragmentManager`
`private final FragmentHostCallback<?>`	`mHost`
`private final FragmentManager`	`mChildFragmentManager`
`private final Fragment`	`mParentFragment`
`private final Integer`	`mFragmentId`
`private final Integer`	`mContainerId`
`private final String`	`mTag`
`private final Boolean`	`mHidden`
`private final Boolean`	`mDetached`
`private final Boolean`	`mRetainInstance`
`private final Boolean`	`mRetainInstanceChangedWhileDetached`
`private final Boolean`	`mHasMenu`
`private final Boolean`	`mMenuVisible`
`private final ViewGroup`	`mContainer`
`private final View`	`mView`
`private final Boolean`	`mDeferStart`
`private final Boolean`	`mUserVisibleHint`
`private final Fragment.AnimationInfo`	`mAnimationInfo`
`private final Handler`	`mPostponedHandler`
`private final Runnable`	`mPostponedDurationRunnable`
`private final Boolean`	`mHiddenChanged`
`private final LayoutInflater`	`mLayoutInflater`
`private final Boolean`	`mIsCreated`
`private final String`	`mPreviousWho`
`private final Lifecycle.State`	`mMaxState`
`private final LifecycleRegistry`	`mLifecycleRegistry`
`private final FragmentViewLifecycleOwner`	`mViewLifecycleOwner`
`private final MutableLiveData<LifecycleOwner>`	`mViewLifecycleOwnerLiveData`
`private final ViewModelProvider.Factory`	`mDefaultFactory`
`private final SavedStateRegistryController`	`mSavedStateRegistryController`
`private final Lifecycle`	`lifecycle`
`private final ViewModelStore`	`viewModelStore`
`private final CreationExtras`	`defaultViewModelCreationExtras`
`private final ViewModelProvider.Factory`	`defaultViewModelProviderFactory`
`private final SavedStateRegistry`	`savedStateRegistry`
`private final Locator`	`currentLocation`
`private final StateFlow<Object>`	`presentation`

Method Summary

Modifier and Type	Method	Description
`StateFlow<EpubSettings>`	`getSettings()`
`final SharedPreferences`	`getPreferences()`
`View`	`getPublicationView()`
`StateFlow<OverflowableNavigator.Overflow>`	`getOverflow()`
`ReadingProgression`	`getReadingProgression()`
`StateFlow<Locator>`	`getCurrentLocator()`
`Lifecycle`	`getLifecycle()`
`ViewModelStore`	`getViewModelStore()`
`CreationExtras`	`getDefaultViewModelCreationExtras()`
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()`
`final SavedStateRegistry`	`getSavedStateRegistry()`
`Locator`	`getCurrentLocation()`
`StateFlow<Object>`	`getPresentation()`
`Unit`	`submitPreferences(EpubPreferences preferences)`	Submits a new set of Preferences to update the current Settings.
`final String`	`evaluateJavascript(String script)`	Evaluates the given JavaScript on the currently visible HTML resource.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)`
`Unit`	`onViewCreated(View view, Bundle savedInstanceState)`
`Unit`	`onSaveInstanceState(Bundle outState)`
`Unit`	`onResume()`
`Boolean`	`go(Locator locator, Boolean animated)`	Moves to the position in the publication corresponding to the given Locator.
`Boolean`	`go(Link link, Boolean animated)`	Moves to the position in the publication targeted by the given link.
`Unit`	`addInputListener(InputListener listener)`	Adds a new InputListener to receive touch, mouse or keyboard events.
`Unit`	`removeInputListener(InputListener listener)`	Removes a previously registered InputListener.
`Selection`	`currentSelection()`	Currently selected content.
`Unit`	`clearSelection()`	Clears the current selection.
`<T extends Decoration.Style> Boolean`	`supportsDecorationStyle(KClass<T> style)`	Indicates whether the Navigator supports the given decoration style class.
`Unit`	`addDecorationListener(String group, DecorableNavigator.Listener listener)`	Registers a new listener for decoration interactions in the given group.
`Unit`	`removeDecorationListener(DecorableNavigator.Listener listener)`	Removes the given listener for all decoration interactions.
`Unit`	`applyDecorations(List<Decoration> decorations, String group)`	Declares the current state of the decorations in the given decoration group.
`Boolean`	`goForward(Boolean animated)`	Moves to the next content portion (eg.
`Boolean`	`goBackward(Boolean animated)`	Moves to the previous content portion (eg.
`Locator`	`firstVisibleElementLocator()`	Returns the Locator to the first HTML block element that is visible on the screen, even if it begins on previous screen pages.

Methods inherited from class org.readium.r2.navigator.epub.EpubNavigatorFragment
onCreate
Methods inherited from class org.readium.r2.navigator.NavigatorFragment
callStartTransitionListener, createFragmentContainer, dump, equals, findFragmentByWho, generateActivityResultKey, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getAnimatingAway, getArguments, getChildFragmentManager, getContext, getEnterAnim, getEnterTransition, getEnterTransitionCallback, getExitAnim, getExitTransition, getExitTransitionCallback, getFocusedView, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLoaderManager, getNextTransition, getParentFragment, getParentFragmentManager, getPopDirection, getPopEnterAnim, getPopExitAnim, getPostOnViewCreatedAlpha, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getSharedElementSourceNames, getSharedElementTargetNames, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, hasOptionsMenu, hashCode, initState, isAdded, isDetached, isHidden, isInBackStack, isInLayout, isMenuVisible, isPostponed, isRemoving, isResumed, isStateSaved, isVisible, noteStateNotSaved, onActivityCreated, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onStart, onStop, onViewStateRestored, performActivityCreated, performAttach, performConfigurationChanged, performContextItemSelected, performCreate, performCreateOptionsMenu, performCreateView, performDestroy, performDestroyView, performDetach, performGetLayoutInflater, performLowMemory, performMultiWindowModeChanged, performOptionsItemSelected, performOptionsMenuClosed, performPause, performPictureInPictureModeChanged, performPrepareOptionsMenu, performPrimaryNavigationFragmentChanged, performResume, performSaveInstanceState, performStart, performStop, performViewCreated, postponeEnterTransition, postponeEnterTransition, registerForActivityResult, registerForActivityResult, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, restoreChildFragmentState, restoreViewState, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setAnimations, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setFocusedView, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setNextTransition, setPopDirection, setPostOnViewCreatedAlpha, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementNames, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getSettings
```
 StateFlow<EpubSettings> getSettings()
```
  - getPreferences
```
 final SharedPreferences getPreferences()
```
  - getPublicationView
```
 View getPublicationView()
```
  - getOverflow
```
 StateFlow<OverflowableNavigator.Overflow> getOverflow()
```
  - getReadingProgression
```
 ReadingProgression getReadingProgression()
```
  - getCurrentLocator
```
 StateFlow<Locator> getCurrentLocator()
```
  - getLifecycle
```
@NonNull() Lifecycle getLifecycle()
```
  - getViewModelStore
```
@NonNull() ViewModelStore getViewModelStore()
```
  - getDefaultViewModelCreationExtras
```
@NonNull()@CallSuper() CreationExtras getDefaultViewModelCreationExtras()
```
  - getDefaultViewModelProviderFactory
```
@NonNull() ViewModelProvider.Factory getDefaultViewModelProviderFactory()
```
  - getSavedStateRegistry
```
@NonNull() final SavedStateRegistry getSavedStateRegistry()
```
  - getCurrentLocation
```
 Locator getCurrentLocation()
```
  - getPresentation
```
 StateFlow<Object> getPresentation()
```
  - submitPreferences
```
 Unit submitPreferences(EpubPreferences preferences)
```
    Submits a new set of Preferences to update the current Settings.
    Note that the Configurable might not update its settings right away, or might even ignore some of the provided preferences. They are only used as hints to compute the new settings.
  - evaluateJavascript
```
 final String evaluateJavascript(String script)
```
    Evaluates the given JavaScript on the currently visible HTML resource.
    Note that this only work with reflowable resources.
  - onCreateView
```
 View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
```
  - onViewCreated
```
 Unit onViewCreated(View view, Bundle savedInstanceState)
```
  - onSaveInstanceState
```
 Unit onSaveInstanceState(Bundle outState)
```
  - onResume
```
 Unit onResume()
```
  - go
```
 Boolean go(Locator locator, Boolean animated)
```
    Moves to the position in the publication corresponding to the given Locator.
  - go
```
 Boolean go(Link link, Boolean animated)
```
    Moves to the position in the publication targeted by the given link.
  - addInputListener
```
 Unit addInputListener(InputListener listener)
```
    Adds a new InputListener to receive touch, mouse or keyboard events.
    Registration order is critical, as listeners may consume the events and prevent others from receiving them.
  - removeInputListener
```
 Unit removeInputListener(InputListener listener)
```
    Removes a previously registered InputListener.
  - currentSelection
```
 Selection currentSelection()
```
    Currently selected content.
  - clearSelection
```
 Unit clearSelection()
```
    Clears the current selection.
  - supportsDecorationStyle
```
 <T extends Decoration.Style> Boolean supportsDecorationStyle(KClass<T> style)
```
    Indicates whether the Navigator supports the given decoration style class.
    You should check whether the Navigator supports drawing the decoration styles required by a particular feature before enabling it. For example, underlining an audiobook does not make sense, so an Audiobook Navigator would not support the underline decoration style.
  - addDecorationListener
```
 Unit addDecorationListener(String group, DecorableNavigator.Listener listener)
```
    Registers a new listener for decoration interactions in the given group.
  - removeDecorationListener
```
 Unit removeDecorationListener(DecorableNavigator.Listener listener)
```
    Removes the given listener for all decoration interactions.
  - applyDecorations
```
 Unit applyDecorations(List<Decoration> decorations, String group)
```
    Declares the current state of the decorations in the given decoration group.
    The Navigator will decide when to actually render each decoration efficiently. Your only responsibility is to submit the updated list of decorations when there are changes. Name each decoration group as you see fit. A good practice is to use the name of the feature requiring decorations, e.g. annotation, search, tts, etc.
  - goForward
```
 Boolean goForward(Boolean animated)
```
    Moves to the next content portion (eg. page) in the reading progression direction.
  - goBackward
```
 Boolean goBackward(Boolean animated)
```
    Moves to the previous content portion (eg. page) in the reading progression direction.
  - firstVisibleElementLocator
```
 Locator firstVisibleElementLocator()
```
    Returns the Locator to the first HTML block element that is visible on the screen, even if it begins on previous screen pages.

Class EpubNavigatorFragment

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class org.readium.r2.navigator.epub.EpubNavigatorFragment

Methods inherited from class org.readium.r2.navigator.NavigatorFragment

Methods inherited from class java.lang.Object

Method Detail

getSettings

getPreferences

getPublicationView

getOverflow

getReadingProgression

getCurrentLocator

getLifecycle

getViewModelStore

getDefaultViewModelCreationExtras

getDefaultViewModelProviderFactory

getSavedStateRegistry

getCurrentLocation

getPresentation

submitPreferences

evaluateJavascript

onCreateView

onViewCreated

onSaveInstanceState

onResume

go

go

addInputListener

removeInputListener

currentSelection

clearSelection

supportsDecorationStyle

addDecorationListener

removeDecorationListener

applyDecorations

goForward

goBackward

firstVisibleElementLocator