-
- All Implemented Interfaces:
-
org.readium.r2.navigator.Navigator,org.readium.r2.navigator.VisualNavigator
public interface OverflowableNavigator implements VisualNavigator
A VisualNavigator with content that can extend beyond the viewport.
The user typically navigates through the publication by scrolling or tapping the viewport edges.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceOverflowableNavigator.Listenerpublic interfaceOverflowableNavigator.Overflow
-
Method Summary
Modifier and Type Method Description abstract BooleangoForward(Boolean animated)Moves to the next content portion (eg. abstract BooleangoBackward(Boolean animated)Moves to the previous content portion (eg. abstract StateFlow<OverflowableNavigator.Overflow>getOverflow()Current presentation rendered by the navigator. abstract ViewgetPublicationView()View displaying the publication. StateFlow<Object>getPresentation()abstract ReadingProgressiongetReadingProgression()Current reading progression direction. abstract StateFlow<Locator>getCurrentLocator()Current position in the publication. LocatorgetCurrentLocation()-
Methods inherited from class org.readium.r2.navigator.OverflowableNavigator
addInputListener, firstVisibleElementLocator, removeInputListener -
Methods inherited from class org.readium.r2.navigator.VisualNavigator
go, go -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
goForward
abstract Boolean goForward(Boolean animated)
Moves to the next content portion (eg. page) in the reading progression direction.
-
goBackward
abstract Boolean goBackward(Boolean animated)
Moves to the previous content portion (eg. page) in the reading progression direction.
-
getOverflow
abstract StateFlow<OverflowableNavigator.Overflow> getOverflow()
Current presentation rendered by the navigator.
-
getPublicationView
abstract View getPublicationView()
View displaying the publication.
-
getPresentation
StateFlow<Object> getPresentation()
-
getReadingProgression
abstract ReadingProgression getReadingProgression()
Current reading progression direction.
-
getCurrentLocator
abstract StateFlow<Locator> getCurrentLocator()
Current position in the publication. Can be used to save a bookmark to the current position.
-
getCurrentLocation
Locator getCurrentLocation()
-
-
-
-