BorderPanel class
Panel with a rendered border, which can be of several types (see PanelBorder).
Constructors
- BorderPanel(Rect bounds, {PanelBorder border = PanelBorder.single, Color? borderColor, Color? background, int padding = 0})
- BorderPanel.forContent(int width, int height, {PanelBorder border = PanelBorder.single, Color? borderColor, Color? background, int padding = 0})
-
Create a BorderPanel that is sized for the given content
width
andheight
, taking the givenpadding
into consideration. The resulting panel will be positioned at (0, 0), so use a child Terminal to render it at the desired location.factory
Properties
- background ↔ Color?
-
Optional background color; uses the Terminal's background color
by default
getter/setter pairinherited
- borderColor ↔ Color?
-
Optional border color; defaults to Terminal.foreground
getter/setter pair
- bounds ↔ Rect
-
Panel bounds
getter/setter pairinherited
- contentBounds → Rect
-
Bounds Rect for the area available for content inside this panel
no setterinherited
- contentRenderer ↔ (void Function(Terminal)?)
-
Set a
void Function(Terminal)
implementation to render content within the panel. The provided Terminal is already set up such that it represents the full extent of the available content area of this Panel. You can use this to draw panels without subclassing and overriding renderContent.getter/setter pairinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- height → int
-
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- width → int
-
The width of the panel
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
render(
Terminal terminal) → void -
Render the panel and its contents. This should be called from within
Layer.render.
override
-
renderContent(
Terminal terminal) → void -
Render content within the panel. The provided
terminal
is already set up such that it represents the full extent of the available content area of this Panel. By default, this method calls contentRenderer if it is defined.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited