[Overview][Constants][Types][Classes][Procedures and functions][Index] | Reference for unit 'LDockTree' (#lcl)

# TCustomAnchoredDockManager

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TCustomAnchoredDockManager - implements an LCL TDockManager via anchoring

## Declaration

Source position: ldocktree.pas line 219

`type TCustomAnchoredDockManager = class(TDockManager)`
`protected`
`FOwnerComponent: TLazDockOwnerComponent;` |  | FOwnerComponent - local variable to hold the TLazDockOwnerComponent for this manager
`procedure DeleteSideSplitter();` |  | DeleteSideSplitter - removes a side splitter to make way for a NewAnchorControl with its anchors
`procedure CombineSpiralSplitterPair();` |  | CombineSpiralSplitterPair - cleans up alignment of two adjacent splitters when they don't line up properly
`procedure DeletePage();` |  | DeletePage - removes the specified page from the notebook
`procedure DeletePages();` |  | DeletePages - removes the specified group of pages (notebook) from the Dock Form
`procedure DeleteDockForm();` |  | DeleteDockForm - removes the specified dock form
`function GetAnchorDepth();` |  | GetAnchorDepth - returns the number of levels of anchoring associated with the given side of the nominated control
`function GetPreferredTitlePosition();` |  | GetPreferredTitlePosition - returns the most favourable place (top or left side) to put the title of a dock component, given the width and height
`public`
`constructor Create(); override;` |  | Create - constructor for TCustomAnchoredDockManager: creates the owner component and initialises splitter size, title height and width
`destructor Destroy; override;` |  | Destroy - destructor for TCustomAnchoredDockManager: frees and annuls the owner component the calls inherited Destroy
`procedure BeginUpdate; override;` |  | BeginUpdate - starts the update process by incrementing the update count
`procedure EndUpdate; override;` |  | EndUpdate - ends update process by decreenting the update count
`procedure GetControlBounds(); override;` |  | GetControlBounds - finds the bounding rectangle of the specified control
`procedure DisableLayout(); virtual;` |  | DisableLayout - placeholder for a virtual procedure to disable the layout of the specified control
`procedure EnableLayout(); virtual;` |  | EnableLayout - placeholder for a virtual procedure to enable the layout of the specified control
`procedure DockControl();` |  | DockControl - docks the specified control with the Drop Control, using the alignment rule specified by InsertAt
`procedure UndockControl();` |  | UndockControl - removes a control from a docking form. It breaks all anchors and cleans up.
`procedure InsertControl(); override;` |  | InsertControl - calls DockControl to perform insertion
`function EnlargeControl();` |  | EnlargeControl - attempts to increase the size of the given control along the specified border, if necessary at the expense of neighbouring controls. If Simulate=true then it will only test if control can be enlarged.
`procedure RemoveControl(); override;` |  | RemoveControl - calls UndockControl to remove the specified control from the docking heirarchy
`procedure ReplaceAnchoredControl();` |  | ReplaceAnchoredControl - takes away OldControl, puts NewControl in its place, re-establishing all the docking, anchors and alignments
`function GetSplitterWidth();` |  | GetSplitterWidth - returns the value of the width of the splitter needed to control this docking process
`function GetSplitterHeight();` |  | GetSplitterHeight - returns the value of the height of the splitter needed to control this docking processGetSplitterHeight -
`property SplitterSize: Integer; [rw]` |  | SplitterSize - the size of splitter required for this docking process
`property TitleWidth: Integer; [rw]` |  | TitleWidth - the width of the title for this docking control
`property TitleHeight: Integer; [rw]` |  | TitleHeight - the height of the title for this docking cotrol
`procedure UpdateTitlePosition();` |  | UpdateTitlePosition - brings title position up to date, reflecting any pending changes
`procedure PaintSite(); override;` |  | PaintSite - (drawing of titles is is actually done by TLazDockForm)
`procedure MessageHandler(); override;` |  | MessageHandler - not implemented
`procedure PositionDockRect(); override;` |  | PositionDockRect - not implemented
`procedure ResetBounds(); override;` |  | ResetBounds - not implemented
`procedure SetReplacingControl(); override;` |  | SetReplacingControl - not implemented
`procedure LoadFromStream(); override;` |  | LoadFromStream - not implemented
`procedure SaveToStream(); override;` |  | SaveToStream - not implemented
`function AutoFreeByControl; override;` |  | AutoFreeByControl - always returns False, overriding inherited value
`function CreateForm;` |  | CreateForm - makes a form and sets up the dock manager
`end;`

## Inheritance

`TCustomAnchoredDockManager` |  | TCustomAnchoredDockManager - implements an LCL TDockManager via anchoring
`TDockManager`
`TPersistent`
`TObject`

## Description

TCustomAnchoredDockManager - implements an LCL TDockManager via anchoring

    It implements docking, undocking, enlarging, shrinking.

        The TCustomLazDockingManager component in LDockCtrl uses this
        docking manager and extends it by layouts that can be stored/restored.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.