NumberPaginator class
The main widget used for creating a NumberPaginator.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- NumberPaginator
Constructors
- NumberPaginator({Key? key, required int numberPages, int initialPage = 0, dynamic onPageChange(int)?, NumberPaginatorUIConfig config = const NumberPaginatorUIConfig(), NumberPaginatorContentBuilder? contentBuilder, NumberPaginatorController? controller, bool showPrevButton = true, bool showNextButton = true, Widget prevButtonContent = const Icon(Icons.chevron_left), Widget nextButtonContent = const Icon(Icons.chevron_right), WidgetBuilder? prevButtonBuilder, WidgetBuilder? nextButtonBuilder})
-
Creates an instance of NumberPaginator.
const
- NumberPaginator.noPrevNextButtons({Key? key, required int numberPages, int initialPage = 0, dynamic onPageChange(int)?, NumberPaginatorUIConfig config = const NumberPaginatorUIConfig(), NumberPaginatorContentBuilder? contentBuilder, NumberPaginatorController? controller})
-
const
Properties
- config → NumberPaginatorUIConfig
-
The UI config for the NumberPaginator.
final
- contentBuilder → NumberPaginatorContentBuilder?
-
A builder for the central content of the paginator. If provided, the
config is ignored.
final
- controller → NumberPaginatorController?
-
The controller for the paginator. Can be used to control the paginator from the outside.
If not provided, a new controller is created.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialPage → int
-
Index of initially selected page.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- nextButtonBuilder → WidgetBuilder?
-
Builder option for providing a custom "next" button.
final
- nextButtonContent → Widget
-
Content of the "next" button which when pressed goes one page forward.
final
- numberPages → int
-
Total number of pages that should be shown.
final
- onPageChange → (dynamic Function(int)?)
-
This function is called when the user switches between pages. The received
parameter indicates the selected index, starting from 0.
final
- prevButtonBuilder → WidgetBuilder?
-
Builder option for providing a custom "previous" button.
final
- prevButtonContent → Widget
-
Content of the "previous" button which when pressed goes one page back.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showNextButton → bool
-
Whether the "next" button should be shown.
final
- showPrevButton → bool
-
Whether the "prev" button should be shown.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → NumberPaginatorState -
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}) → 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