FormCheckbox<TValue> class

This widget is used to display a check box and save the check or not.

チェックボックスを表示して、チェックの有無を保存するためのウィジェットです。

Masamune framework version of Checkbox. Common design can be applied with FormStyle. Also, the value of Checkbox can be managed using FormController. It has functions such as labeled checkboxes and custom designs.

CheckboxのMasamuneフレームワーク版。FormStyleで共通したデザインを適用可能。またFormControllerを利用することでCheckboxの値を管理可能。ラベル付きチェックボックスやカスタムデザインなどの機能を備えています。

Label Display ラベルの表示

If labelText or labelWidget is specified, the checkbox is displayed with a label. Only one of labelText and labelWidget should be specified.

labelTextもしくはlabelWidgetを指定するとラベル付きでチェックボックスが表示されます。 labelTextとlabelWidgetはどちらか一方のみを指定してください。

Placement 配置方法

Place under the Form that gave FormController.key, or pass FormController to form.

FormController.keyを与えたForm配下に配置、もしくはformにFormControllerを渡します。

Form Management フォーム管理

When FormController is passed to form, onSaved must also be passed together. The contents of onSaved will be used to save the data.

formにFormControllerを渡した場合、一緒にonSavedも渡してください。データの保存はonSavedの内容が実行されます。

Initial Value and Callbacks 初期値とコールバック

Enter the initial value given by FormController.value in initialValue.

initialValueにFormController.valueから与えられた初期値を入力します。

Each time the content is changed, onChanged is executed.

内容が変更される度onChangedが実行されます。

Validation バリデーション

When FormController.validate is executed, validation and data saving are performed.

FormController.validateが実行された場合、バリデーションとデータの保存を行ないます。

Checkbox State チェックボックスの状態

If enabled is false, the checkbox is deactivated.

enabledがfalseになるとチェックボックスが非有効化されます。

If readOnly is set to true, it will show enabled, but the value cannot be changed.

readOnlyがtrueになっている場合は、有効化の表示になりますが、値が変更できなくなります。

Basic Usage Example 基本的な使用例

FormCheckbox(
  form: formController,
  initialValue: formController.value.checked,
  onSaved: (value) => formController.value.copyWith(checked: value),
);

With Label ラベル付きの使用例

FormCheckbox(
  form: formController,
  initialValue: formController.value.checked,
  labelText: "利用規約に同意する",
  onSaved: (value) => formController.value.copyWith(checked: value),
);

With Validation バリデーション付きの使用例

FormCheckbox(
  form: formController,
  initialValue: formController.value.checked,
  labelText: "利用規約に同意する",
  validator: (value) {
    if (value != true) {
      return "利用規約への同意が必要です";
    }
    return null;
  },
  onSaved: (value) => formController.value.copyWith(checked: value),
);

Inheritance

Constructors

FormCheckbox({FormController<TValue>? form, Key? key, FormStyle? style, TValue onSaved(bool value)?, bool initialValue = false, bool enabled = true, void onChanged(bool value)?, bool keepAlive = true, FocusNode? focusNode, bool autofocus = false, bool readOnly = false, String? labelText, Widget? labelWidget, FormAffixStyle? prefix, FormAffixStyle? suffix, VisualDensity? visualDensity, MaterialTapTargetSize? materialTapTargetSize, FormFieldValidator<bool>? validator}): This widget is used to display a check box and save the check or not.

Properties

autovalidateMode → AutovalidateMode: Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder → FormFieldBuilder<bool>: Function that returns the widget representing this form field.
finalinherited
enabled → bool: Whether the form is able to receive user input.
finalinherited
errorBuilder → FormFieldErrorBuilder?: Function that returns the widget representing the error to display.
finalinherited
forceErrorText → String?: An optional property that forces the FormFieldState into an error state by directly setting the FormFieldState.errorText property without running the validator function.
finalinherited
form → FormController<TValue>?: Context for forms.
final
hashCode → int: The hash code for this object.
no setterinherited
initialValue → bool?: An optional value to initialize the form field to, or null otherwise.
finalinherited
keepAlive → bool: If placed in a list, whether or not it should not be discarded on scrolling.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
onChanged → void Function(bool value)?: Callback to be executed each time the value is changed.
final
onReset → VoidCallback?: An optional method to call when the form field is reset via FormFieldState.reset.
finalinherited
onSaved → FormFieldSetter<bool>?: An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
restorationId → String?: Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
validator → FormFieldValidator<bool>?: An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → FormFieldState<bool>: 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, 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