Skip to content

DockLayoutSnapshotCodec

Compact string serializer and deserializer (DLS1 format) for persisting docking layouts across application restarts.

Overview

DockLayoutSnapshotCodec serializes and deserializes DockLayoutSnapshot instances using the compact DLS1 format.

Format handles recursive split nodes, split ratios, active tabs, and pane ID lists in a single string suitable for storage.

Serializing and Deserializing Layout Snapshot

String encoded = DockLayoutSnapshotCodec.encode(snapshot);
DockLayoutSnapshot restored = DockLayoutSnapshotCodec.decode(encoded);
  • DockLayoutSnapshot: Immutable snapshot representing the recursive docking layout tree and active pane selection for serialization and layout persistence.
  • DockingManager: Non-visual layout controller managing the hierarchical docking tree, pane additions, splits, tab reordering, and snapshot serialization/restoration.

API

DockLayoutSnapshotCodec::decode(String)

Deserializes a DLS1-encoded string back into a DockLayoutSnapshot, falling back cleanly to an empty snapshot on errors.

Parameter Type Description
encoded String Encoded DLS1 snapshot string.

Returns DockLayoutSnapshot: Decoded DockLayoutSnapshot instance..

DockLayoutSnapshotCodec::encode(DockLayoutSnapshot)

Serializes a DockLayoutSnapshot into a compact DLS1-encoded string.

Parameter Type Description
snapshot DockLayoutSnapshot Layout snapshot to encode.

Returns String: Compact DLS1 encoded string representation..