ApptiveGridForm class
A Widget to display a ApptiveGrid Form
In order to use this there needs to be a ApptiveGrid Widget in the Widget tree
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ApptiveGridForm
Constructors
-
ApptiveGridForm({Key? key, required Uri uri, TextStyle? titleStyle, TextStyle? descriptionStyle, EdgeInsetsGeometry? contentPadding, EdgeInsetsGeometry? titlePadding, EdgeInsetsGeometry? descriptionPadding, bool hideTitle = false, bool hideDescription = false, EdgeInsetsGeometry? textBlockPadding, TextStyle? textBlockStyle, void onFormLoaded(FormData)?, Future<
bool> onActionSuccess(ApptiveLink, FormData)?, Future<bool> onSavedToPending(ApptiveLink, FormData)?, void onCreated(Uri)?, Future<bool> onError(dynamic)?, ScrollController? scrollController, Alignment buttonAlignment = Alignment.center, String? buttonLabel, bool hideButton = false, Widget? componentBuilder(BuildContext, FormComponent<DataEntity> )?}) -
Creates a ApptiveGridForm.
const
Properties
-
Alignment of the Send Button
final
-
Label of the Button to submit a form.
Defaults to a localized version of
Send
final -
componentBuilder
→ (Widget? Function(BuildContext, FormComponent<
DataEntity> )?) -
A custom Builder for Building custom Widgets for FormComponents
final
- contentPadding → EdgeInsetsGeometry?
-
Padding of the Items in the Form. If no Padding is provided a EdgeInsets.all(8.0) will be used.
final
- descriptionPadding → EdgeInsetsGeometry?
-
Padding for the description. If no Padding is provided the contentPadding is used
final
- descriptionStyle → TextStyle?
-
Style for the Form Description. If no style is provided
bodyText1
of the TextTheme will be usedfinal - hashCode → int
-
The hash code for this object.
no setterinherited
- hideButton → bool
-
Show or hide the submit button at the bottom of the form.
final
- hideDescription → bool
-
Flag to hide the form description, default is false
final
- hideTitle → bool
-
Flag to hide the form title, default is false
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onActionSuccess
→ (Future<
bool> Function(ApptiveLink, FormData)?) -
Callback after Form is Submitted completes Successfully
final
- onCreated → (void Function(Uri)?)
-
Callback after Form submission returns a link to a newly created entity, if available
final
-
onError
→ (Future<
bool> Function(dynamic)?) -
Callback if an Error occurs
final
- onFormLoaded → (void Function(FormData)?)
-
Callback after FormData loads successfully
final
-
onSavedToPending
→ (Future<
bool> Function(ApptiveLink, FormData)?) -
Callback after Form is saved to pending Items
Note: This will only be triggerd if an ApptiveGridCache is specified in the ApptiveGridOptions
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollController → ScrollController?
-
Optional ScrollController for the Form
final
- textBlockPadding → EdgeInsetsGeometry?
-
Padding for the description. If no Padding is provided the
padding
is usedfinal - textBlockStyle → TextStyle?
-
Style for the Form Description. If no style is provided
bodyText1
of the TextTheme will be usedfinal - titlePadding → EdgeInsetsGeometry?
-
Padding for the title. If no Padding is provided the contentPadding is used
final
- titleStyle → TextStyle?
-
Style for the Form Title. If no style is provided
headline5
of the TextTheme will be usedfinal - uri → Uri
-
Uri of the Form to display
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → ApptiveGridFormState -
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