AlhPdfViewPlatform class abstract
The interface that platform-specific implementations of alh_pdf_view must extend.
Avoid implements of this interface. Using implements makes adding any new
methods here a breaking change for end users of your platform!
Do extends AlhPdfViewPlatform instead, so new methods added here are
inherited in your code with the default implementation (that throws at runtime),
rather than breaking your users at compile time.
- Inheritance
-
- Object
- PlatformInterface
- AlhPdfViewPlatform
Constructors
- AlhPdfViewPlatform.new()
- Constructs a AlhPdfViewPlatform.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
buildView(
{required AlhPdfViewCreationParams creationParams, required WidgetConfiguration widgetConfiguration}) → Widget - Returns a widget displaying pdf view.
-
dispose(
{required int viewId}) → Future< void> - Should be called when the widget disposes.
-
getCurrentPage(
{required int viewId}) → Future< int> - Returns the current page that is shown.
-
getPageCount(
{required int viewId}) → Future< int> - Returns the number of pages for the PDF.
-
getPageSize(
{required int page, required int viewId}) → Future< Size> -
Returns the size of the given
pageindex. -
getZoom(
{required int viewId}) → Future< double> - Returns the current zoom value.
-
goToNextPage(
{required int viewId, required bool withAnimation}) → Future< bool> - Goes to the next page.
-
goToPreviousPage(
{required int viewId, required bool withAnimation}) → Future< bool> - Goes to the previous page.
-
init(
int viewId) → Future< void> -
/// Initializes the platform interface with
viewId. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onError(
{required int viewId}) → Stream< OnErrorEvent> -
onLinkHandle(
{required int viewId}) → Stream< OnLinkHandleEvent> -
onPageChanged(
{required int viewId}) → Stream< OnPageChangedEvent> -
onRender(
{required int viewId}) → Stream< OnRenderEvent> - handlePlatformViewCreated methods
-
onTap(
{required int viewId}) → Stream< OnTapEvent> -
onZoomChanged(
{required int viewId}) → Stream< OnZoomChangedEvent> -
refreshPdf(
{required Map< String, dynamic> creationParams, required int viewId}) → Future<void> - Updating bytes or path for the native PDF View.
-
resetZoom(
{required int viewId}) → Future< void> - Setting the scale factor to the default zoom factor.
-
setOrientation(
{required Orientation orientation, required Map< String, dynamic> creationParams, required int viewId}) → Future<void> -
Notifies the current
orientation. -
setPage(
{required int page, required int viewId, required bool withAnimation}) → Future< bool> -
Jumping to the given
page. -
setZoom(
{required int viewId, required double zoom}) → Future< void> -
Zooming to the given
zoom. -
toString(
) → String -
A string representation of this object.
inherited
-
updateFitPolicy(
{required Map< String, dynamic> creationParams, required int viewId}) → Future<void> - Updating fitPolicy for the native PDF View.
-
updateScrollbar(
{required Map< String, dynamic> creationParams, required int viewId}) → Future<void> - Updating scrollbar for the native PDF View.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance ↔ AlhPdfViewPlatform?
-
The default instance of AlhPdfViewPlatform to use.
getter/setter pair