Commit b73670a3 authored by Adam Barth's avatar Adam Barth

Some more dartdoc

parent 59664e4f
...@@ -998,6 +998,7 @@ class BlockBody extends MultiChildRenderObjectWidget { ...@@ -998,6 +998,7 @@ class BlockBody extends MultiChildRenderObjectWidget {
} }
} }
/// A base class for widgets that accept [Positioned] children.
abstract class StackRenderObjectWidgetBase extends MultiChildRenderObjectWidget { abstract class StackRenderObjectWidgetBase extends MultiChildRenderObjectWidget {
StackRenderObjectWidgetBase({ StackRenderObjectWidgetBase({
List<Widget> children: _emptyWidgetList, List<Widget> children: _emptyWidgetList,
......
...@@ -18,6 +18,10 @@ enum ItemsSnapAlignment { ...@@ -18,6 +18,10 @@ enum ItemsSnapAlignment {
adjacentItem adjacentItem
} }
/// Scrollable widget that scrolls one "page" at a time.
///
/// In a pageable list, one child is visible at a time. Scrolling the list
/// reveals either the next or previous child.
class PageableList extends Scrollable { class PageableList extends Scrollable {
PageableList({ PageableList({
Key key, Key key,
...@@ -46,17 +50,34 @@ class PageableList extends Scrollable { ...@@ -46,17 +50,34 @@ class PageableList extends Scrollable {
snapOffsetCallback: snapOffsetCallback snapOffsetCallback: snapOffsetCallback
); );
/// Whether the first item should be revealed after scrolling past the last item.
final bool itemsWrap; final bool itemsWrap;
/// Controls whether a fling always reveals the adjacent item or whether flings can traverse many items.
final ItemsSnapAlignment itemsSnapAlignment; final ItemsSnapAlignment itemsSnapAlignment;
/// Called when the currently visible page changes.
final ValueChanged<int> onPageChanged; final ValueChanged<int> onPageChanged;
/// Used to paint the scrollbar for this list.
final ScrollableListPainter scrollableListPainter; final ScrollableListPainter scrollableListPainter;
/// The duration used when animating to a given page.
final Duration duration; final Duration duration;
/// The animation curve to use when animating to a given page.
final Curve curve; final Curve curve;
/// The list of pages themselves.
final Iterable<Widget> children; final Iterable<Widget> children;
PageableListState createState() => new PageableListState(); PageableListState createState() => new PageableListState();
} }
/// State for a [PageableList] widget.
///
/// Widgets that subclass [PageableList] can subclass this class to have
/// sensible default behaviors for pageable lists.
class PageableListState<T extends PageableList> extends ScrollableState<T> { class PageableListState<T extends PageableList> extends ScrollableState<T> {
int get _itemCount => config.children?.length ?? 0; int get _itemCount => config.children?.length ?? 0;
int _previousItemCount; int _previousItemCount;
......
...@@ -12,6 +12,9 @@ class Placeholder extends StatefulComponent { ...@@ -12,6 +12,9 @@ class Placeholder extends StatefulComponent {
PlaceholderState createState() => new PlaceholderState(); PlaceholderState createState() => new PlaceholderState();
} }
/// State for a [Placeholder] widget.
///
/// Useful for setting the child currently displayed by this placeholder widget.
class PlaceholderState extends State<Placeholder> { class PlaceholderState extends State<Placeholder> {
/// The child that this widget builds. /// The child that this widget builds.
/// ///
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment