EpubNavigatorFragment

Navigator for EPUB publications.

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

Types

Link copied to clipboard
object Companion
Link copied to clipboard
data class Configuration
Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val context: Context?
Link copied to clipboard
open override val currentLocator: StateFlow<Locator>

Current position in the publication. Can be used to save a bookmark to the current position.

Link copied to clipboard
Link copied to clipboard
open var exitTransition: Any?
Link copied to clipboard
Link copied to clipboard
val host: Any?
Link copied to clipboard
val id: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val overflow: StateFlow<OverflowableNavigator.Overflow>

Current presentation rendered by the navigator.

Link copied to clipboard
Link copied to clipboard
open override val publicationView: View

View displaying the publication.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val settings: StateFlow<EpubSettings>

Current Settings values.

Link copied to clipboard
Link copied to clipboard
val tag: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val view: View?
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open override fun addDecorationListener(group: String, listener: DecorableNavigator.Listener)

Registers a new listener for decoration interactions in the given group.

Link copied to clipboard
open override fun addInputListener(listener: InputListener)

Adds a new InputListener to receive touch, mouse or keyboard events.

Link copied to clipboard
open suspend override fun applyDecorations(decorations: List<Decoration>, group: String)

Declares the current state of the decorations in the given decoration group.

Link copied to clipboard
open override fun clearSelection()

Clears the current selection.

Link copied to clipboard
open suspend override fun currentSelection(): Selection?

Currently selected content.

Link copied to clipboard
open fun dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<out String?>??)
Link copied to clipboard
suspend fun evaluateJavascript(script: String): String?

Evaluates the given JavaScript on the currently visible HTML resource.

Link copied to clipboard
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.

Link copied to clipboard
fun getString(@StringRes resId: Int, @Nullable vararg formatArgs: Any?): String
Link copied to clipboard
Link copied to clipboard
open override fun go(link: Link, animated: Boolean): Boolean

Moves to the position in the publication targeted by the given link.

open override fun go(locator: Locator, animated: Boolean): Boolean

Moves to the position in the publication corresponding to the given Locator.

Link copied to clipboard
open override fun goBackward(animated: Boolean): Boolean

Moves to the previous content portion (eg. page) in the reading progression direction.

Link copied to clipboard
open override fun goForward(animated: Boolean): Boolean

Moves to the next content portion (eg. page) in the reading progression direction.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun onCreate(savedInstanceState: Bundle?)
Link copied to clipboard
open fun onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int): Animation?
Link copied to clipboard
open fun onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int): Animator?
Link copied to clipboard
open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun onGetLayoutInflater(@Nullable savedInstanceState: Bundle?): LayoutInflater
Link copied to clipboard
Link copied to clipboard
open fun onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)
Link copied to clipboard
Link copied to clipboard
open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)
Link copied to clipboard
Link copied to clipboard
open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)
Link copied to clipboard
open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)
Link copied to clipboard
open override fun onResume()
Link copied to clipboard
open override fun onSaveInstanceState(outState: Bundle)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun onViewCreated(view: View, savedInstanceState: Bundle?)
Link copied to clipboard
open fun onViewStateRestored(@Nullable savedInstanceState: Bundle?)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Removes the given listener for all decoration interactions.

Link copied to clipboard
open override fun removeInputListener(listener: InputListener)

Removes a previously registered InputListener.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun setMenuVisibility(menuVisible: Boolean)
Link copied to clipboard
open fun startActivity(@NonNull intent: Intent)
open fun startActivity(@NonNull intent: Intent, @Nullable options: Bundle?)
Link copied to clipboard
Link copied to clipboard
open override fun submitPreferences(preferences: EpubPreferences)

Submits a new set of Preferences to update the current Settings.

Link copied to clipboard
open override fun <T : Decoration.Style> supportsDecorationStyle(style: KClass<T>): Boolean

Indicates whether the Navigator supports the given decoration style class.

Link copied to clipboard