BuilderPageController class
Passing a Widget builder to the Webpage Controller.
- Inheritance
-
- Object
- StateSetter
- ControllerMVC
- ControllerMVC
- BasicScrollController
- ScaffoldScreenController
- WebPageBaseController
- WebPageController
- BuilderPageController
Constructors
-
BuilderPageController({required WidgetBuilder inBuilder, void initStateFunc()?, void disposeFunc()?, PreferredSizeWidget? appBar, Color? backgroundColor, bool? resizeToAvoidBottomInset, bool? primary, DragStartBehavior? drawerDragStartBehavior, bool? extendBody, bool? extendBodyBehindAppBar, Color? drawerScrimColor, double? drawerEdgeDragWidth, bool? drawerEnableOpenDragGesture, bool? endDrawerEnableOpenDragGesture, String? restorationId, ScrollPhysics? physics, State<
StatefulWidget> ? state, bool? popup}) - Supply a WidgetBuilder instead of a child widget init and dispose function.
Properties
- appBar → PreferredSizeWidget?
-
finalinherited
- appBottomBar → BottomBar?
-
This is the 'default' bottom bar if any.
no setterinherited
- backgroundColor → Color?
-
finalinherited
- clipBehavior → Clip?
-
Defaults to Clip.hardEdge.
finalinherited
- dataObject ↔ Object?
-
This is of type Object allowing you
to propagate any class object you wish down the widget tree.
getter/setter pairinherited
- disposeFunc → (void Function()?)
-
final
- dragStartBehavior → DragStartBehavior?
-
Decribe the 'drag' behaviour.
finalinherited
- drawerDragStartBehavior → DragStartBehavior?
-
finalinherited
- drawerEdgeDragWidth → double?
-
finalinherited
- drawerEnableOpenDragGesture → bool?
-
finalinherited
- drawerScrimColor → Color?
-
finalinherited
- endDrawerEnableOpenDragGesture → bool?
-
finalinherited
- errorMsg → String
-
Simply display the error.
no setterinherited
- extendBody → bool?
-
finalinherited
- extendBodyBehindAppBar → bool?
-
finalinherited
- hasError → bool
-
Indicate if the app is 'in error.'
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- inBuilder → WidgetBuilder
-
final
- inDebugger → bool
-
Determines if running in an IDE or in production.
Returns true if the App is under in the Debugger and not production.
no setterinherited
- inError → bool
-
Indicate if app is 'in error.'
no setterinherited
- initStateFunc → (void Function()?)
-
final
- inLandscape → bool
-
Is the phone orientated in Landscape
no setterinherited
- inPortrait → bool
-
Is the phone orientated in Portrait
no setterinherited
- inSmallScreen → bool
-
Determine if running on a small screen.
no setterinherited
- keyboardDismissBehavior → ScrollViewKeyboardDismissBehavior?
-
How the keyboard is removed from the screen.
finalinherited
- keyId → String
-
A unique key is assigned to all State Controllers, State objects,
and listeners. Used in large projects to separate objects into teams.
no setterinherited
- lastContext → BuildContext?
-
Returns the 'latest' context in the App.
no setterinherited
- notifyDependencies ↔ bool
-
Notify the dependencies for the InheritedWidget
getter/setter pairinherited
- opacity ↔ double
-
getter/setter pairinherited
- padding → EdgeInsetsGeometry?
-
The amount of space by which to inset the child.
finalinherited
- physics → ScrollPhysics?
-
How the scroll view should respond to user input.
finalinherited
- popup → bool?
-
final
- primary → bool?
-
finalinherited
- resizeToAvoidBottomInset → bool?
-
finalinherited
- restorationId → String?
-
finalinherited
- reverse → bool?
-
Whether the scroll view scrolls in the reading direction.
finalinherited
- rootScrollController → ScrollController?
-
The first ScrollController that takes in a Scrollable
no setterinherited
-
rootState
→ AppStateMVC<
AppStatefulWidgetMVC> ? -
Returns the 'first' StateMVC object in the App
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- screenSize → Size
-
no setterinherited
- scrollController → ScrollController
-
The Scroll Controller
no setterinherited
- scrollDirection → Axis?
-
The axis along which the scroll view scrolls.
finalinherited
- scrollDown → bool
-
Scrolling down
no setterinherited
- scrollPosition → double
-
Return the offset 'scroll position'
no setterinherited
- scrollUp → bool
-
Scrolling up
no setterinherited
-
state
→ StateMVC<
StatefulWidget> ? -
The current StateMVC object.
no setterinherited
-
stateMVC
→ StateMVC<
StatefulWidget> ? -
The current StateMVC object from mvc_application/view.dart
no setterinherited
-
states
→ Set<
StateMVC< StatefulWidget> > -
Return a 'copy' of the Set of State objects.
no setterinherited
- widget ↔ WebPageWidget?
-
Supply the widget through the controller.
getter/setter pairinherited
Methods
-
accessBar(
BuildContext context, [WebPageWidget? widget]) → List< Widget> ? -
Possible 'access bar' near the top of the screen
inherited
-
activate(
) → void -
Called when this object is reinserted into the tree after having been
removed via deactivate.
inherited
-
addState(
StateMVC< StatefulWidget> ? state) → String -
Associate this Controller to the specified State object
to use that State object's functions and features.
Returns that State object's unique identifier.
inherited
-
afterListener(
String key) → StateListener? -
Retrieve the 'after' listener by its unique key.
inherited
-
beforeListener(
String key) → StateListener? -
Retrieve the 'before' listener by its unique key.
inherited
-
body(
BuildContext context) → Widget -
Provide the body of the webpage
inherited
-
inherited
-
bottomSheet(
BuildContext context) → Widget? -
inherited
-
build(
BuildContext context) → Widget -
You must implement the build() function.
inherited
-
builder(
BuildContext context) → Widget? -
Create your webpage or web screen
or return null and implement the buildList() function instead.
override
-
buildInherited(
) → void -
Rebuild the InheritedWidget of the 'closes' InheritedStateMVC object if any.
inherited
-
buildList(
BuildContext context) → List< Widget> ? -
Create your webpage or web screen
inherited
-
buildScaffold(
BuildContext context) → Widget? -
The Scaffold used by this webpage.
inherited
-
deactivate(
) → void -
The framework calls this method whenever it removes this
StateMVC
object from the tree.inherited -
dependOnInheritedWidget(
BuildContext? context) → bool -
Link a widget to a InheritedWidget
inherited
-
detachedLifecycleState(
) → void -
Either be in the progress of attaching when the engine is first initializing
or after the view being destroyed due to a Navigator pop.
inherited
-
didChangeAccessibilityFeatures(
) → void -
Called when the system changes the set of active accessibility features.
inherited
-
didChangeAppLifecycleState(
AppLifecycleState state) → void -
Called when the system puts the app in the background or returns the app to the foreground.
inherited
-
didChangeDependencies(
) → void -
Called when this
StateMVC
object is first created immediately after initState. Otherwise called only if this State object's Widget is a dependency of InheritedWidget.inherited -
didChangeLocale(
Locale locale) → void -
Called when the system tells the app that the user's locale has changed.
inherited
-
didChangeMetrics(
) → void -
Called when the application's dimensions change. For example,
when a phone is rotated.
inherited
-
didChangePlatformBrightness(
) → void -
inherited
-
didChangeTextScaleFactor(
) → void -
Called when the platform's text scale factor changes.
inherited
-
didHaveMemoryPressure(
) → void -
Called when the system is running low on memory.
inherited
-
didPopRoute(
) → Future< bool> -
Called when the system tells the app to pop the current route.
For example, on Android, this is called when the user presses
the back button.
inherited
-
didPushRoute(
String route) → Future< bool> -
Called when the host tells the app to push a new route onto the
navigator.
inherited
-
didPushRouteInformation(
RouteInformation routeInformation) → Future< bool> -
Called when the host tells the application to push a new
RouteInformation and a restoration state onto the router.
inherited
-
didUpdateWidget(
StatefulWidget oldWidget) → void -
Override this method to respond when the StatefulWidget is recreated.
inherited
-
dispose(
) → void -
The framework calls this method when this
StateMVC
object will never build again. Note: THERE IS NO GUARANTEE THIS METHOD WILL RUN in the Framework.override -
drawer(
BuildContext context) → Widget? -
inherited
-
endDrawer(
BuildContext context) → Widget? -
inherited
-
getError(
[dynamic error]) → Exception? -
Return the 'last' error if any.
inherited
-
inactiveLifecycleState(
) → void -
The application is in an inactive state and is not receiving user input.
inherited
-
initAsync(
) → Future< bool> -
Used to complete asynchronous operations
inherited
-
initState(
) → void -
The framework will call this method exactly once.
Only when the
StateMVC
object is first created.override -
listControllers(
List< String> keys) → List<ControllerMVC?> -
Return a List of Controllers specified by key id.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
For those accustom to the 'Provider' approach.
inherited
-
ofState<
T extends State< (StatefulWidget> >) → T? -
Retrieve the State object by type
Returns null if not found
inherited
-
onAppBar(
) → PreferredSizeWidget? -
Provide a appBar here as well.
Otherwise a default AppBar is implemented.
inherited
-
onAsyncError(
FlutterErrorDetails details) → bool -
Supply an 'error handler' routine if something goes wrong
in the corresponding initAsync() routine.
inherited
-
onBottomBar(
BuildContext context, [WebPageWidget? widget]) → Column? -
A bottom bar for every web page.
inherited
-
onDrawerChanged(
BuildContext context) → DrawerCallback? -
inherited
-
onEndDrawerChanged(
BuildContext context) → DrawerCallback? -
inherited
-
orientation(
BuildContext context) → Orientation -
Determine the phone's orientation
inherited
-
pausedLifecycleState(
) → void -
The application is not currently visible to the user, not responding to
user input, and running in the background.
inherited
-
inherited
-
popupScreen(
BuildContext context, {required String title, required String text, required String name, Widget? image, bool interactive = true, EdgeInsetsGeometry? margin, Decoration? decoration, EdgeInsetsGeometry? padding, CrossAxisAlignment? crossAxisAlignment, TextStyle? titleStyle, TextStyle? textStyle, bool? hasBottomBar}) → Widget -
Provide a 'popup' screen.
inherited
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
rebuild(
) → void -
Allow for a more accurate description
inherited
-
refresh(
) → void -
Allows external classes to 'refresh' or 'rebuild' the widget tree.
inherited
-
resumedLifecycleState(
) → void -
The application is visible and responding to user input.
inherited
-
screenOverlay(
BuildContext context) → StackWidgetProperties? -
Possible Screen overlay
inherited
-
scrollChild(
BuildContext context) → Widget? -
The widget passed to the SingleChildScrollView in the parent class.
inherited
-
setState(
VoidCallback fn) → void -
Provide the setState() function to external actors
inherited
-
stateOf<
T extends StatefulWidget> () → StateMVC< StatefulWidget> ? -
Retrieve the State object by its StatefulWidget.Returns null if not found
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
webPageOf<
T extends WebPageWidget> (BuildContext context) → T? -
Supply the widget through the widget tree.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited