GridButton class

Grid Button

{@tool sample}

This example shows a simple GridButton.

GridButton(
  onPressed: (dynamic value) {
    /*...*/
  },
  items: [
    [
      GridButtonItem(title: "1"),
      GridButtonItem(child: Text("2")),
      GridButtonItem(title: "3", flex: 2),
    ],
    [
      GridButtonItem(title: "a", value: "100", longPressValue: "long"),
      GridButtonItem(title: "b", color: Colors.lightBlue)
    ],
  ],
)

{@end-tool}

The items and onPressed arguments must not be null.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• GridButton

Constructors

GridButton({Key? key, required List<List<GridButtonItem>> items, required ValueChanged onPressed, Color? borderColor, TextStyle? textStyle, TextDirection? textDirection, double borderWidth = 1.0, bool hideSurroundingBorder = false, bool enabled = true})

const

Properties

borderColor → Color?

The color to use when painting the line.

final

borderWidth → double

Width of the divider border, which is usually 1.0.

final

enabled → bool

ui control disabled

final

hashCode → int

The hash code for this object.

no setter, inherited

hideSurroundingBorder → bool

Whether to show surrounding borders.

final

items → List<List<GridButtonItem>>

Defines the appearance of the button items that are 2D arrayed within the GridButton.

final

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

onPressed → ValueChanged

Called when the button is tapped or otherwise activated.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

textDirection → TextDirection?

Determine the layout order

final

textStyle → TextStyle?

The text style to use for all buttons in the GridButton. GridButtonItem.textStyle of each item takes precedence.

final

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → _GridButtonState

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