HeaderUserSelectionModel class

A UserSelectionModel that covers entire columns or rows.

Unlike CellUserSelectionModel, the edges of this kind of selection are defined only by coordinates in one axis, the selection is assumed to cover the totality of the opposite (cross) axis.

Its anchor and focus are indices of columns/rows.

It is always constructed via AxisBoundedSelection.crossAxisUnbounded.

Inheritance
Implemented types
Available extensions

Constructors

HeaderUserSelectionModel.fromAnchorFocus({String? id, required int anchor, required int focus, required Axis axis, SelectionStyle? style})
Create a HeaderUserSelectionModel given its edges (anchor and focus).
factory
HeaderUserSelectionModel.fromSelectionModel(UserSelectionModel original, {required int anchor, required int focus, required Axis axis})
Create a HeaderUserSelectionModel from any UserSelectionModel given an anchor, focus and axis.
factory

Properties

anchor → int
The edge that should include anchorCoordinate. anchor is the origin of a selection, it is the edge that should remain unchanged in an expansion operation.
no setterinherited
anchorCoordinate → IntVector2
The anchorCoordinate is the first coordinate of the given anchor column/row.
no setterinherited
anchorEdge → RangeEdge
Defines with RangeEdge of the bounded axis represents the anchor.
finalinherited
axis → Axis
The axis completely bounded by start ad end.
finalinherited
bottom → int?
no setterinherited
crossAxisBound → int?
A dimensional index in the cross axis that defines one of its edges (as on crossAxisBoundedEdge.
finalinherited
crossAxisBoundedEdge → RangeEdge?
Specified by AxisBoundedSelection.crossAxisPartiallyBounded defines which edge of the crossAxis crossAxisBound represents.
finalinherited
end → int
finalinherited
focus → int
The edge that should include focusCoordinate. Focus should correspond the edge that should be changed in a expansion operation.
no setterinherited
focusCoordinate → IntVector2
The focusCoordinate is the first coordinate of the given focus column/row.
no setterinherited
hashCode → int
The hash code for this object.
no setteroverride
id → String
See UserSelectionModel.id
final
isNil → bool
If this is a range with no elements
no setterinherited
isNotNil → bool
If this is a range with any element
no setterinherited
iterable → Iterable<int>
no setterinherited
left → int?
no setterinherited
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
start → int
finalinherited
style → SelectionStyle?
See UserSelectionModel.style
final
top → int?
no setterinherited

Methods

bound({required Range2D to}) → Range2D

Available on Selection, provided by the SelectionMethods extension

Bound a Selection to a Range2D.
clone() → Range
Create a identical range
inherited
contains(Object? position) → bool
Verifies if a given position is contained within the range
inherited
containsRange(Range otherRange) → bool
Defines if this range contains otherRange entirely
inherited
copyWith({int? anchor, int? focus, Axis? axis, SelectionStyle? style}) → HeaderUserSelectionModel
Creates a copy of HeaderUserSelectionModel with the specified properties replaced.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
overlaps(Range otherRange) → bool
Defines if this range overlaps otherRange
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator &(Range otherRange) → Range
Gets the intersection between two ranges, range nil if they don't intersect
inherited
operator +(Range otherRange) → RangeCompactList
Performs a union with another range merge if overlaps
inherited
operator -(Range otherRange) → RangeCompactList
Return all the elements on the this range that is not present on the otherRange.
inherited
operator ==(Object other) → bool
The equality operator.
override
operator |(Range otherRange) → Range
Stretches and merges two ranges including all possible non covered spaces between them
inherited