Skip to content

//readium-navigator/org.readium.r2.navigator.epub/EpubNavigatorFragment

EpubNavigatorFragment

[androidJvm]\ class EpubNavigatorFragment : Fragment, VisualNavigator, SelectableNavigator, DecorableNavigator, Configurable<EpubSettings, EpubPreferences>

Navigator for EPUB publications.

To use this Fragment, create a factory with EpubNavigatorFragment.createFactory().

Types

Name Summary
Companion [androidJvm]
object Companion
Configuration [androidJvm]
data class Configuration
Listener [androidJvm]
interface Listener : VisualNavigator.Listener
PaginationListener [androidJvm]
interface PaginationListener

Functions

Name Summary
addDecorationListener [androidJvm]
open override fun addDecorationListener(group: String, listener: DecorableNavigator.Listener)
Registers a new listener for decoration interactions in the given group.
applyDecorations [androidJvm]
open suspend override fun applyDecorations(decorations: List<Decoration>, group: String)
Declares the current state of the decorations in the given decoration group.
clearSelection [androidJvm]
open override fun clearSelection()
Clears the current selection.
currentSelection [androidJvm]
open suspend override fun currentSelection(): Selection?
Currently selected content.
dump [androidJvm]
open fun dump(@NonNullp0: String, @Nullablep1: FileDescriptor?, @NonNullp2: PrintWriter, @Nullablep3: Array<String>?)
equals [androidJvm]
operator override fun equals(@Nullableother: Any?): Boolean
evaluateJavascript [androidJvm]
suspend fun evaluateJavascript(script: String): String?
Evaluates the given JavaScript on the currently visible HTML resource.
firstVisibleElementLocator [androidJvm]
open suspend override fun firstVisibleElementLocator(): Locator?
Returns the Locator to the first HTML block element that is visible on the screen, even if it begins on previous screen pages.
getActivity [androidJvm]
@Nullable
fun getActivity(): FragmentActivity?
getAllowEnterTransitionOverlap [androidJvm]
open fun getAllowEnterTransitionOverlap(): Boolean
getAllowReturnTransitionOverlap [androidJvm]
open fun getAllowReturnTransitionOverlap(): Boolean
getArguments [androidJvm]
@Nullable
fun getArguments(): Bundle?
getChildFragmentManager [androidJvm]
@NonNull
fun getChildFragmentManager(): FragmentManager
getContext [androidJvm]
@Nullable
open fun getContext(): Context?
getDefaultViewModelCreationExtras [androidJvm]
@NonNull
@CallSuper
open override fun getDefaultViewModelCreationExtras(): CreationExtras
getDefaultViewModelProviderFactory [androidJvm]
@NonNull
open override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory
getEnterTransition [androidJvm]
@Nullable
open fun getEnterTransition(): Any?
getExitTransition [androidJvm]
@Nullable
open fun getExitTransition(): Any?
getFragmentManager [androidJvm]
@Nullable
fun ~~getFragmentManager~~(): FragmentManager?
getHost [androidJvm]
@Nullable
fun getHost(): Any?
getId [androidJvm]
fun getId(): Int
getLayoutInflater [androidJvm]
@NonNull
fun getLayoutInflater(): LayoutInflater
@NonNull
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
open fun ~~getLayoutInflater~~(@Nullablep0: Bundle?): LayoutInflater
getLifecycle [androidJvm]
@NonNull
open override fun getLifecycle(): Lifecycle
getLoaderManager [androidJvm]
@NonNull
open fun ~~getLoaderManager~~(): LoaderManager
getParentFragment [androidJvm]
@Nullable
fun getParentFragment(): Fragment?
getParentFragmentManager [androidJvm]
@NonNull
fun getParentFragmentManager(): FragmentManager
getReenterTransition [androidJvm]
@Nullable
open fun getReenterTransition(): Any?
getResources [androidJvm]
@NonNull
fun getResources(): Resources
getRetainInstance [androidJvm]
fun ~~getRetainInstance~~(): Boolean
getReturnTransition [androidJvm]
@Nullable
open fun getReturnTransition(): Any?
getSharedElementEnterTransition [androidJvm]
@Nullable
open fun getSharedElementEnterTransition(): Any?
getSharedElementReturnTransition [androidJvm]
@Nullable
open fun getSharedElementReturnTransition(): Any?
getString [androidJvm]
@NonNull
fun getString(@StringResp0: Int): String
@NonNull
fun getString(@StringResp0: Int, @Nullablevararg p1: Any): String
getTag [androidJvm]
@Nullable
fun getTag(): String?
getTargetFragment [androidJvm]
@Nullable
fun ~~getTargetFragment~~(): Fragment?
getTargetRequestCode [androidJvm]
fun ~~getTargetRequestCode~~(): Int
getText [androidJvm]
@NonNull
fun getText(@StringResp0: Int): CharSequence
getUserVisibleHint [androidJvm]
open fun ~~getUserVisibleHint~~(): Boolean
getView [androidJvm]
@Nullable
open fun getView(): View?
getViewLifecycleOwner [androidJvm]
@MainThread
@NonNull
open fun getViewLifecycleOwner(): LifecycleOwner
getViewLifecycleOwnerLiveData [androidJvm]
@NonNull
open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>
getViewModelStore [androidJvm]
@NonNull
open override fun getViewModelStore(): ViewModelStore
go [androidJvm]
open override fun go(link: Link, animated: Boolean, completion: () -> Unit): Boolean
Moves to the position in the publication targeted by the given link.
[androidJvm]
open override fun go(locator: Locator, animated: Boolean, completion: () -> Unit): Boolean
Moves to the position in the publication corresponding to the given Locator.
goBackward [androidJvm]
open override fun goBackward(animated: Boolean, completion: () -> Unit): Boolean
Moves to the previous content portion (eg. page) in the reading progression direction.
goForward [androidJvm]
open override fun goForward(animated: Boolean, completion: () -> Unit): Boolean
Moves to the next content portion (eg. page) in the reading progression direction.
hashCode [androidJvm]
override fun hashCode(): Int
hasOptionsMenu [androidJvm]
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun hasOptionsMenu(): Boolean
isAdded [androidJvm]
fun isAdded(): Boolean
isDetached [androidJvm]
fun isDetached(): Boolean
isHidden [androidJvm]
fun isHidden(): Boolean
isInLayout [androidJvm]
fun isInLayout(): Boolean
isMenuVisible [androidJvm]
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun isMenuVisible(): Boolean
isRemoving [androidJvm]
fun isRemoving(): Boolean
isResumed [androidJvm]
fun isResumed(): Boolean
isStateSaved [androidJvm]
fun isStateSaved(): Boolean
isVisible [androidJvm]
fun isVisible(): Boolean
onActivityCreated [androidJvm]
@MainThread
@CallSuper
open fun ~~onActivityCreated~~(@Nullablep0: Bundle?)
onActivityResult [androidJvm]
open fun ~~onActivityResult~~(p0: Int, p1: Int, @Nullablep2: Intent?)
onAttach [androidJvm]
@MainThread
@CallSuper
open fun ~~onAttach~~(@NonNullp0: Activity)
@MainThread
@CallSuper
open fun onAttach(@NonNullp0: Context)
onAttachFragment [androidJvm]
@MainThread
open fun ~~onAttachFragment~~(@NonNullp0: Fragment)
onConfigurationChanged [androidJvm]
@CallSuper
open override fun onConfigurationChanged(@NonNullp0: Configuration)
onContextItemSelected [androidJvm]
@MainThread
open fun onContextItemSelected(@NonNullp0: MenuItem): Boolean
onCreate [androidJvm]
@MainThread
@CallSuper
open fun onCreate(@Nullablep0: Bundle?)
onCreateAnimation [androidJvm]
@MainThread
@Nullable
open fun onCreateAnimation(p0: Int, p1: Boolean, p2: Int): Animation?
onCreateAnimator [androidJvm]
@MainThread
@Nullable
open fun onCreateAnimator(p0: Int, p1: Boolean, p2: Int): Animator?
onCreateContextMenu [androidJvm]
@MainThread
open override fun onCreateContextMenu(@NonNullp0: ContextMenu, @NonNullp1: View, @Nullablep2: ContextMenu.ContextMenuInfo?)
onCreateOptionsMenu [androidJvm]
@MainThread
open fun ~~onCreateOptionsMenu~~(@NonNullp0: Menu, @NonNullp1: MenuInflater)
onCreateView [androidJvm]
open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View
onDestroy [androidJvm]
@MainThread
@CallSuper
open fun onDestroy()
onDestroyOptionsMenu [androidJvm]
@MainThread
open fun ~~onDestroyOptionsMenu~~()
onDestroyView [androidJvm]
@MainThread
@CallSuper
open fun onDestroyView()
onDetach [androidJvm]
@MainThread
@CallSuper
open fun onDetach()
onGetLayoutInflater [androidJvm]
@NonNull
open fun onGetLayoutInflater(@Nullablep0: Bundle?): LayoutInflater
onHiddenChanged [androidJvm]
@MainThread
open fun onHiddenChanged(p0: Boolean)
onInflate [androidJvm]
@UiThread
@CallSuper
open fun ~~onInflate~~(@NonNullp0: Activity, @NonNullp1: AttributeSet, @Nullablep2: Bundle?)
@UiThread
@CallSuper
open fun onInflate(@NonNullp0: Context, @NonNullp1: AttributeSet, @Nullablep2: Bundle?)
onLowMemory [androidJvm]
@MainThread
@CallSuper
open override fun onLowMemory()
onMultiWindowModeChanged [androidJvm]
open fun onMultiWindowModeChanged(p0: Boolean)
onOptionsItemSelected [androidJvm]
@MainThread
open fun ~~onOptionsItemSelected~~(@NonNullp0: MenuItem): Boolean
onOptionsMenuClosed [androidJvm]
@MainThread
open fun ~~onOptionsMenuClosed~~(@NonNullp0: Menu)
onPause [androidJvm]
@MainThread
@CallSuper
open fun onPause()
onPictureInPictureModeChanged [androidJvm]
open fun onPictureInPictureModeChanged(p0: Boolean)
onPrepareOptionsMenu [androidJvm]
@MainThread
open fun ~~onPrepareOptionsMenu~~(@NonNullp0: Menu)
onPrimaryNavigationFragmentChanged [androidJvm]
@MainThread
open fun onPrimaryNavigationFragmentChanged(p0: Boolean)
onRequestPermissionsResult [androidJvm]
open fun ~~onRequestPermissionsResult~~(p0: Int, @NonNullp1: Array<String>, @NonNullp2: IntArray)
onResume [androidJvm]
open override fun onResume()
onSaveInstanceState [androidJvm]
open override fun onSaveInstanceState(outState: Bundle)
onStart [androidJvm]
@MainThread
@CallSuper
open fun onStart()
onStop [androidJvm]
@MainThread
@CallSuper
open fun onStop()
onViewCreated [androidJvm]
open override fun onViewCreated(view: View, savedInstanceState: Bundle?)
onViewStateRestored [androidJvm]
@MainThread
@CallSuper
open fun onViewStateRestored(@Nullablep0: Bundle?)
postponeEnterTransition [androidJvm]
open fun postponeEnterTransition()
fun postponeEnterTransition(p0: Long, @NonNullp1: TimeUnit)
registerForActivityResult [androidJvm]
@MainThread
@NonNull
override fun <I : Any, O : Any> registerForActivityResult(@NonNullp0: ActivityResultContract<I, O>, @NonNullp1: ActivityResultCallback<O>): ActivityResultLauncher<I>
@MainThread
@NonNull
override fun <I : Any, O : Any> registerForActivityResult(@NonNullp0: ActivityResultContract<I, O>, @NonNullp1: ActivityResultRegistry, @NonNullp2: ActivityResultCallback<O>): ActivityResultLauncher<I>
registerForContextMenu [androidJvm]
open fun registerForContextMenu(@NonNullp0: View)
removeDecorationListener [androidJvm]
open override fun removeDecorationListener(listener: DecorableNavigator.Listener)
Removes the given listener for all decoration interactions.
requestPermissions [androidJvm]
fun ~~requestPermissions~~(@NonNullp0: Array<String>, p1: Int)
requireActivity [androidJvm]
@NonNull
fun requireActivity(): FragmentActivity
requireArguments [androidJvm]
@NonNull
fun requireArguments(): Bundle
requireContext [androidJvm]
@NonNull
fun requireContext(): Context
requireFragmentManager [androidJvm]
@NonNull
fun ~~requireFragmentManager~~(): FragmentManager
requireHost [androidJvm]
@NonNull
fun requireHost(): Any
requireParentFragment [androidJvm]
@NonNull
fun requireParentFragment(): Fragment
requireView [androidJvm]
@NonNull
fun requireView(): View
setAllowEnterTransitionOverlap [androidJvm]
open fun setAllowEnterTransitionOverlap(p0: Boolean)
setAllowReturnTransitionOverlap [androidJvm]
open fun setAllowReturnTransitionOverlap(p0: Boolean)
setArguments [androidJvm]
open fun setArguments(@Nullablep0: Bundle?)
setEnterSharedElementCallback [androidJvm]
open fun setEnterSharedElementCallback(@Nullablep0: SharedElementCallback?)
setEnterTransition [androidJvm]
open fun setEnterTransition(@Nullablep0: Any?)
setExitSharedElementCallback [androidJvm]
open fun setExitSharedElementCallback(@Nullablep0: SharedElementCallback?)
setExitTransition [androidJvm]
open fun setExitTransition(@Nullablep0: Any?)
setHasOptionsMenu [androidJvm]
open fun ~~setHasOptionsMenu~~(p0: Boolean)
setInitialSavedState [androidJvm]
open fun setInitialSavedState(@Nullablep0: Fragment.SavedState?)
setMenuVisibility [androidJvm]
open fun setMenuVisibility(p0: Boolean)
setReenterTransition [androidJvm]
open fun setReenterTransition(@Nullablep0: Any?)
setRetainInstance [androidJvm]
open fun ~~setRetainInstance~~(p0: Boolean)
setReturnTransition [androidJvm]
open fun setReturnTransition(@Nullablep0: Any?)
setSharedElementEnterTransition [androidJvm]
open fun setSharedElementEnterTransition(@Nullablep0: Any?)
setSharedElementReturnTransition [androidJvm]
open fun setSharedElementReturnTransition(@Nullablep0: Any?)
setTargetFragment [androidJvm]
open fun ~~setTargetFragment~~(@Nullablep0: Fragment?, p1: Int)
setUserVisibleHint [androidJvm]
open fun ~~setUserVisibleHint~~(p0: Boolean)
shouldShowRequestPermissionRationale [androidJvm]
open fun shouldShowRequestPermissionRationale(@NonNullp0: String): Boolean
startActivity [androidJvm]
open fun startActivity(p0: Intent)
open fun startActivity(p0: Intent, @Nullablep1: Bundle?)
startActivityForResult [androidJvm]
open fun ~~startActivityForResult~~(p0: Intent, p1: Int)
open fun ~~startActivityForResult~~(p0: Intent, p1: Int, @Nullablep2: Bundle?)
startIntentSenderForResult [androidJvm]
open fun ~~startIntentSenderForResult~~(p0: IntentSender, p1: Int, @Nullablep2: Intent?, p3: Int, p4: Int, p5: Int, @Nullablep6: Bundle?)
startPostponedEnterTransition [androidJvm]
open fun startPostponedEnterTransition()
submitPreferences [androidJvm]
open override fun submitPreferences(preferences: EpubPreferences)
Submits a new set of Preferences to update the current Settings.
supportsDecorationStyle [androidJvm]
open override fun <T : Decoration.Style> supportsDecorationStyle(style: KClass<T>): Boolean
Indicates whether the Navigator supports the given decoration style class.
toString [androidJvm]
@NonNull
open override fun toString(): String
unregisterForContextMenu [androidJvm]
open fun unregisterForContextMenu(@NonNullp0: View)

Properties

Name Summary
currentLocation [androidJvm]
open val ~~currentLocation~~: Locator?
currentLocator [androidJvm]
open override val currentLocator: StateFlow<Locator>
Current position in the publication. Can be used to save a bookmark to the current position.
mPreviousWho [androidJvm]
@RestrictTo(value = [RestrictTo.Scope.LIBRARY])
@Nullable
var mPreviousWho: String?
preferences [androidJvm]
val ~~preferences~~: SharedPreferences
presentation [androidJvm]
open override val presentation: StateFlow<VisualNavigator.Presentation>
Current presentation rendered by the navigator.
publication [androidJvm]
open override val publication: Publication
Publication rendered by this navigator.
readingProgression [androidJvm]
open override val readingProgression: ReadingProgression
Current reading progression direction.
resourcePager [androidJvm]
lateinit var resourcePager: R2ViewPager
savedStateRegistry [androidJvm]
@get:NonNull
override val savedStateRegistry: SavedStateRegistry
settings [androidJvm]
open override val settings: StateFlow<EpubSettings>
Current Settings values.

Extensions

Name Summary
goLeft [androidJvm]
fun VisualNavigator.goLeft(animated: Boolean = false, completion: () -> Unit = {}): Boolean
Moves to the left content portion (eg. page) relative to the reading progression direction.
goRight [androidJvm]
fun VisualNavigator.goRight(animated: Boolean = false, completion: () -> Unit = {}): Boolean
Moves to the right content portion (eg. page) relative to the reading progression direction.