DockingLayout class

Represents a layout.

The layout is organized into DockingItem, DockingColumn, DockingRow and DockingTabs. The root is single and can be any DockingArea.

Inheritance

Constructors

DockingLayout({DockingArea? root})
Builds a DockingLayout.

Properties

hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
id → int
The id of this layout.
no setter
maximizedArea → DockingArea?
Gets the maximized area in this layout.
no setter
root ↔ DockingArea?
The root of this layout.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addItemOn({required DockingItem newItem, required DropArea targetArea, DropPosition? dropPosition, int? dropIndex}) → void
Adds a DockingItem to this layout.
addItemOnRoot({required DockingItem newItem, DropPosition? dropPosition, int? dropIndex}) → void
Adds a DockingItem to the root of this layout.
addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
findDockingArea(dynamic id) → DockingArea?
Finds a DockingArea given an id.
findDockingItem(dynamic id) → DockingItem?
Finds a DockingItem given an id.
findDockingTabsWithItem(dynamic itemId) → DockingTabs?
Finds a DockingTabs that has a DockingItem with the given id.
hierarchy({bool indexInfo = false, bool levelInfo = false, bool hasParentInfo = false, bool nameInfo = false}) → String
Converts layout's hierarchical structure to a debug String.
layoutAreas() → List<DockingArea>
Gets all DockingArea from this layout.
load({required String layout, required LayoutParser parser, required AreaBuilder builder}) → void
Loads a layout from String.
maximizeDockingItem(DockingItem dockingItem) → void
Maximize a DockingItem.
maximizeDockingTabs(DockingTabs dockingTabs) → void
Maximize a DockingTabs.
moveItem({required DockingItem draggedItem, required DropArea targetArea, DropPosition? dropPosition, int? dropIndex}) → void
Moves a DockingItem in this layout.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
rebuild() → void
Notifies the UI to rebuild the layout.
removeItem({required DockingItem item}) → void
Removes a DockingItem from this layout.
removeItemByIds(List ids) → void
Removes multiple DockingItem by id from this layout.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
restore() → void
Removes any maximize status.
stringify({required LayoutParser parser}) → String
Converts a layout into a String to be stored.
toString() → String
A string representation of this object.
inherited

Operators

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