-
- All Implemented Interfaces:
-
org.readium.r2.navigator.Navigator
public interface VisualNavigator implements Navigator
A navigator rendering the publication visually on-screen.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceVisualNavigator.Presentationpublic interfaceVisualNavigator.Listener
-
Method Summary
Modifier and Type Method Description LocatorfirstVisibleElementLocator()Returns the Locator to the first content element that begins on the current screen. abstract UnitaddInputListener(InputListener listener)Adds a new InputListener to receive touch, mouse or keyboard events. abstract UnitremoveInputListener(InputListener listener)Removes a previously registered InputListener. 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()-
-
Method Detail
-
firstVisibleElementLocator
Locator firstVisibleElementLocator()
Returns the Locator to the first content element that begins on the current screen.
-
addInputListener
abstract 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
abstract Unit removeInputListener(InputListener listener)
Removes a previously registered InputListener.
-
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()
-
-
-
-