TurnPageView class
The TurnPageView class is a widget likes PageView with a custom page transition animation.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- TurnPageView
Constructors
- TurnPageView.builder({Key? key, TurnPageController? controller, required int itemCount, required IndexedWidgetBuilder itemBuilder, Color overleafColorBuilder(int index)?, Color overleafBorderColorBuilder(int index)?, double overleafBorderWidthBuilder(int index)?, double animationTransitionPoint = defaultAnimationTransitionPoint, bool useOnTap = true, bool useOnSwipe = true, dynamic onSwipe(bool isTurnForward)?, dynamic onTap(bool isTurnForward)?})
-
Creates a new pageable view with a turning page effect using the provided itemBuilder.
The
itemCountanditemBuilderparameters must not be null.
Properties
- animationTransitionPoint → double
-
The point that behavior of the turn-page-animation changes.
This value must be 0 <= animationTransitionPoint < 1.
final
- controller → TurnPageController
-
The controller used to interact with the TurnPageView.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- itemBuilder → IndexedWidgetBuilder
-
A builder function that returns the widget for each page.
final
- itemCount → int
-
The total number of pages in the TurnPageView.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onSwipe → dynamic Function(bool isTurnForward)?
-
A callback functions than runs when swipe event ends.
final
- onTap → dynamic Function(bool isTurnForward)?
-
A callback functions than runs when tap event ends.
final
- overleafBorderColorBuilder → Color Function(int index)?
-
A builder function that returns the overleaf border color for each page.
If null, uses the default overleaf border color.
final
- overleafBorderWidthBuilder → double Function(int index)?
-
A builder function that returns the overleaf border width for each page.
If null, uses the default overleaf border width.
final
- overleafColorBuilder → Color Function(int index)?
-
A builder function that returns the overleaf color for each page.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useOnSwipe → bool
-
Determines whether the TurnPageView should respond to swipe events to change pages.
final
- useOnTap → bool
-
Determines whether the TurnPageView should respond to tap events to change pages.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< TurnPageView> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited