FlPageView class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FlPageView
- Available extensions
Constructors
- FlPageView.new({Key? key, required int itemCount, required FlPageViewBuilder builder, FlPageViewController? controller, double? height, double aspectRatio = 16 / 9, bool animateToClosest = true, bool disposeController = true, bool autoPlay = false, Duration autoPlayInterval = const Duration(seconds: 3), Duration autoPlayAnimationDuration = const Duration(milliseconds: 800), Curve autoPlayCurve = Curves.fastOutSlowIn, bool pauseAutoPlayOnScrolling = true, bool pauseAutoPlayInFiniteScroll = false})
-
const
Properties
- animateToClosest → bool
-
Determines if carousel should loop to the closest occurence of requested page.
Defaults to true.
final
- aspectRatio → double
-
Aspect ratio is used if no height have been declared.
Defaults to 16:9 aspect ratio.
final
- autoPlay → bool
-
Enables auto play, sliding one page at a time.
Use autoPlayInterval to determent the frequency of slides.
Defaults to false.
final
- autoPlayAnimationDuration → Duration
-
Animation duration when auto play slides to the next page. Defaults to 800 ms.
final
- autoPlayCurve → Curve
-
Animation curve when auto play slides to the next page. defaults to Curves.fastOutSlowIn.
final
- autoPlayInterval → Duration
-
Sets Duration to determent the frequency of slides when
autoPlay is set to true.
Defaults to 3 seconds.
final
- builder → FlPageViewBuilder
-
Widget builder for the entire carousel.
final
- controller → FlPageViewController?
-
The page controller to use.
final
- disposeController → bool
-
Dispose the controller when the widget is disposed
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double?
-
Set carousel height and overrides any existing aspectRatio.
final
- itemCount → int
-
Number of items in the carousel.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- pauseAutoPlayInFiniteScroll → bool
-
If
true
, the auto play function will be paused when user is scrolling to the edge of the page view.final -
If
true
, the auto play function will be paused when user is calling controller'snext
orprevious
oranimate
method. And after the animation complete, the auto play will be resumed. Default totrue
.final - pauseAutoPlayOnScrolling → bool
-
If
true
, the auto play function will be paused when user is interacting with the page view, and will be resumed when user finish interacting. Default totrue
.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- toExpansionTilesRotationIconBuilder → ExpansionTilesRotationIconBuilder
-
Available on Widget, provided by the ExtensionExpansionTiles extension
no setter - toToggleRotateIconBuilder → ToggleRotateIconBuilder
-
Available on Widget, provided by the ExtensionWidgetToggleRotate extension
no setter
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< FlPageView> -
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
-
toDecoratorPendant<
T> ({DecoratorPendantPosition positioned = DecoratorPendantPosition.outer, bool maintainSize = false, bool? needFocus, bool? needEditing, DecoratorPendantValueCallback< T?> ? needValue}) → DecoratorPendant<T> -
Available on Widget, provided by the ExtensionWidgetDecoratorBox extension
-
toDecoratorPendantBuilder<
T> ({DecoratorPendantPosition positioned = DecoratorPendantPosition.outer, bool maintainSize = false, bool? needFocus, bool? needEditing, DecoratorPendantValueCallback< T?> ? needValue}) → DecoratorPendant<T> -
Available on Widget, provided by the ExtensionWidgetDecoratorBox extension
-
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