WxLinearBorderSide class

Defines the relative size and alignment of one

A WxLinearBorder defines a box outline as zero to four edges, each of which is rendered as a single line. The width and color of the lines is defined by WxLinearBorder.side.

Each line's length is defined by size, a value between 0.0 and 1.0 (the default) which defines the length as a percentage of the length of a box edge.

When size is less than 1.0, the line is aligned within the available space according to alignment, a value between -1.0 and 1.0. The default is 0.0, which means centered, -1.0 means align on the "start" side, and 1.0 means align on the "end" side. The meaning of start and end depend on the current TextDirection, see Directionality.

Inheritance
Annotations

Constructors

WxLinearBorderSide({WxBorderStyle? style, Color? color, Gradient? gradient, double? width, double? offset, double? size, double? alignment})
Defines one side of a WxLinearBorder.
const
WxLinearBorderSide.fromAncestor({WxBorderSide? side, double? size, double? alignment})
Defines one side of a WxLinearBorder.
WxLinearBorderSide.fromLegacy(BorderSide side, {double? size, double? alignment})

Properties

alignment → double?
A value between -1.0 and 1.0 that defines how edges for which size is less than 1.0 are aligned relative to the corresponding box edge.
final
color → Color?
The color of this side of the border.
finalinherited
effectiveAlignment → double
no setter
effectiveColor → Color
Returns the effective color of the border, using black by default.
no setterinherited
effectiveOffset → double
Returns the effective offset of the border, using WxBorderStyle.alignInside value by default.
no setterinherited
effectiveSize → double
no setter
effectiveStyle → WxBorderStyle
Returns the effective style of the border, using WxBorderStyle.solid by default.
no setterinherited
effectiveWidth → double
Returns the effective width of the border, using 1 by default.
no setterinherited
gradient → Gradient?
A gradient to use for painting the border.
finalinherited
hashCode → int
The hash code for this object.
no setteroverride
offset → double?
The relative position of the stroke on a WxBorderSide in an OutlinedBorder or Border.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → double?
A value between 0.0 and 1.0 that defines the length of the edge as a percentage of the length of the corresponding box edge. Default is 1.0.
final
strokeInset → double
Get the amount of the stroke width that lies inside of the WxBorderSide.
no setterinherited
strokeOffset → double
The offset of the stroke, taking into account the stroke alignment.
no setterinherited
strokeOutset → double
Get the amount of the stroke width that lies outside of the WxBorderSide.
no setterinherited
style → WxBorderStyle?
The style of the border (e.g., solid, dashed).
finalinherited
width → double?
The width of this side of the border, in logical pixels.
finalinherited

Methods

copyWith({WxBorderStyle? style, Color? color, Gradient? gradient, double? width, double? offset, double? size, double? alignment}) → WxLinearBorderSide
Creates a copy of this border but with the given fields replaced with the new values.
override
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
merge(covariant WxLinearBorderSide? other) → WxLinearBorderSide
Creates a WxBorderSide that represents the addition of the two given WxBorderSides.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
scale(double t) → WxLinearBorderSide
Creates a copy of this border side description but with the width scaled by the factor t.
override
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toLegacy() → BorderSide
Converts a WxBorderSide object to a legacy BorderSide object, which is used by the standard Flutter.
inherited
toPaint(Rect rect) → Paint
Create a Paint object that, if used to stroke a line, will draw the line in this border's style.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
override

Operators

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

Static Methods

lerp(WxLinearBorderSide? a, WxLinearBorderSide? b, double t) → WxLinearBorderSide?
Linearly interpolates between two WxLinearBorders.
override

Constants

none → const WxLinearBorderSide
A hairline black border that is not rendered.