FlagProperty class Null safety

Property where the description is either ifTrue or ifFalse depending on whether value is true or false.

Using FlagProperty instead of DiagnosticsProperty<bool> can make diagnostics display more polished. For example, given a property named visible that is typically true, the following code will return 'hidden' when visible is false and nothing when visible is true, in contrast to visible: true or visible: false.

  value: true,
  ifFalse: 'hidden',

FlagProperty should also be used instead of DiagnosticsProperty<bool> if showing the bool value would not clearly indicate the meaning of the property value.
  value: inherit,
  ifTrue: '<all styles inherited>',
  ifFalse: '<no style specified>',

See also:



FlagProperty(String name, {required bool? value, String? ifTrue, String? ifFalse, bool showName = false, Object? defaultValue, DiagnosticLevel level = DiagnosticLevel.info})
Constructs a FlagProperty with the given descriptions with the specified descriptions.


allowNameWrap bool
Whether to wrap the name onto multiple lines or not.
final, inherited
allowTruncate bool
Whether to allow truncation when displaying the node and its children.
read-only, inherited
allowWrap bool
Whether to wrap text on onto multiple lines or not.
final, inherited
defaultValue Object?
The default value of this property, when it has not been set to a specific value.
final, inherited
emptyBodyDescription String?
Description to show if the node has no displayed properties or children.
read-only, inherited
exception Object?
Exception thrown if accessing the property value threw an exception.
read-only, inherited
expandableValue bool
Whether to expose properties and children of the value as properties and children.
final, inherited
hashCode int
The hash code for this object.
read-only, inherited
ifEmpty String?
Description if the property description would otherwise be empty.
final, inherited
ifFalse String?
Description to use if the property value is false.
ifNull String?
Description if the property value is null.
final, inherited
ifTrue String?
Description to use if the property value is true.
isInteresting bool
Whether to consider the property's value interesting. When a property is uninteresting, its level is downgraded to DiagnosticLevel.fine regardless of the value provided as the constructor's level argument.
read-only, inherited
level DiagnosticLevel
Priority level of the diagnostic used to control which diagnostics should be shown and filtered.
read-only, override
linePrefix String?
Prefix to include at the start of each line.
final, inherited
missingIfNull bool
Whether a value of null causes the property to have level DiagnosticLevel.warning warning that the property is missing a value.
final, inherited
name String?
Label describing the DiagnosticsNode, typically shown before a separator (see showSeparator).
final, inherited
propertyType Type
The type of the property value.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
showName bool
Whether the name of the property should be shown when showing the default view of the tree.
read-only, override
showSeparator bool
Whether to show a separator between name and description.
final, inherited
style DiagnosticsTreeStyle?
Hint for how the node should be displayed.
final, inherited
textTreeConfiguration TextTreeConfiguration?
Returns a configuration specifying how this object should be rendered as text art.
@protected, read-only, inherited
tooltip String?
Optional tooltip typically describing the property.
final, inherited
value bool?
Returns the value of the property either from cache or by invoking a ComputePropertyValueCallback.
read-only, inherited


getChildren() List<DiagnosticsNode>
Children of this DiagnosticsNode.
getProperties() List<DiagnosticsNode>
Properties of this DiagnosticsNode.
isFiltered(DiagnosticLevel minLevel) bool
Whether the diagnostic should be filtered due to its level being lower than minLevel.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
toDescription({TextTreeConfiguration? parentConfiguration}) String
Returns a description with a short summary of the node itself not including children or properties.
toJsonMap(DiagnosticsSerializationDelegate delegate) Map<String, Object?>
Serialize the node to a JSON map according to the configuration provided in the DiagnosticsSerializationDelegate.
toString({TextTreeConfiguration? parentConfiguration, DiagnosticLevel minLevel = DiagnosticLevel.info}) String
Returns a string representation of this diagnostic that is compatible with the style of the parent if the node is not the root.
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, TextTreeConfiguration? parentConfiguration, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
toTimelineArguments() Map<String, String>?
Converts the properties (getProperties) of this node to a form useful for Timeline event arguments (as in Timeline.startSync).
valueToString({TextTreeConfiguration? parentConfiguration}) String
Returns a string representation of the property value.


operator ==(Object other) bool
The equality operator.