Sign in Join
Wiki copytemporary

Anchor Docking: what changed

Revision 4 to 5. Removed lines have a minus sign; added lines have a plus sign.

OldNewLine
11About docking in general see [[Docking]].
22
33## Overview
44
55Docking allows you to combine forms, or to treat controls as forms. You use the mouse to drag and dock forms together or undock (split) them. The basic dragging, docking and undocking functionality is provided by the LCL. But you need a docking manager to add splitters and grab zones, and to save and restore layouts.
66
77Anchor docking has been implemented since version 0.9.29 in the package *anchordocking.lpk* for use in your own Lazarus applications, and *AnchorDockingDsgn.lpk* if you wish to make the Lazarus IDE windows dockable. It is easy to use, and provides many features and options not available in earlier docking packages.
88
99You will find a code example at: components/anchordocking/miniide/miniide1.lpi
1010
1111This means that the earlier TLazDockingManager and unit LDockCtrl are obsolete and now deprecated.
1212
1313### Features
1414
1515- **Drag and dock**: Headers are added that can be dragged to dock controls with the mouse. Preview rectangles will show where and how a control is docked.
1616- **Any layout**: By using the LCL's anchors almost any layout is possible. You can dock to left, right, top, bottom, inside or outside or as page like in a TPageControl. You can enlarge docked controls via the popup menu. No need to undock your whole layout.
1717- **What you see is how it is structured**: There are no hidden panels to align controls in rows and columns. Anchor docking makes sure forms do not overlap.
1818- **Splitters** are automatically inserted between docked forms to allow resizing.
1919- **Page docking**. Forms can be docked not only left/right/above/below, but in pages too. A TPageControl is automatically created for native look and feel. A page can contain arbitrary docked forms too, including paged docked forms, allowing nested pages and layouts. When a page is undocked the pagecontrol is automatically removed. You can drag and drop the tabs or use the popup menu to move pages.
2020- **Easy use**: With one line of code you can make a form or control dockable. Just give them unique names.
2121- Not only forms, but any **TWinControl** can be made dockable.
2222- Can **save/load layouts**. The layout information is stored for each dockable control and old layout files will still work even when the application gets more dockable controls or some are removed. The information is stored in the abstract class LCL TConfigStorage. So you can use for example TXMLConfigStorage to store layouts in xml files or you can write your own storage to store it wherever you want.
2323- Each docked form is put into a docksite providing an optional **header**. The header shows the caption of the docked form and contains a close button. You can *drag the header* to drag the form and undock it or to dock it at another position. The header can be at any of the four sides and moves by default automatically to the smaller side to save space. You can customize this. The header shows a customizable hint allowing to read long captions.
2424- When a docksite is resized the *child sites are automatically scaled*. You can turn this off.
2525- **Preserve size of forms**. For instance when docking a form to a left side of a site the width of the docked form is kept. The same for the other sides and the same for undocking.
2626- **Flickerless**: The restore tries to reuse existing sites and splitters to reduce creation and flickering of forms and to preserve the Z order of forms. This allows to quickly switch between layouts.
2727- **Header popup menu**:
2828 - lock/unlock (disable dragging)
2929 - header position (auto, left, top, right, bottom), this is saved/restored with the layout
3030 - merge (for example after moving a dock page into a layout)
3131 - undock (needed if no place to undock on screen)
3232 - enlarge side to left, top, right, bottom
3333 - close
3434 - options
3535- **Page popup menu**:
3636 - lock/unlock (disable dragging)
3737 - undock (needed if no place to undock on screen)
3838 - tab position for pagecontrol (top,bottom, left, right), this is saved/restored with the layout
3939 - move page to the left, right, leftmost, rightmost
4040 - close
4141 - options
4242- Forms can be made dock sites. Then they can dock at one side. But they can not be docked itself.
4343- close button automatically saves a layout
4444- Powerful functions to alter the layout. You can use D&D to move a form and you can undock and dock in one move. There are functions to enlarge forms and shrinking others. These functions are available via the header popup menu as well. See below.
4545- There is an IDE package which makes the Lazarus IDE dockable. It is called anchordockingdsgn.lpk. Make sure you only install one docking package. Do not install the easydockmgr at the same time!
4646
4747### ToDos
4848
4949- Design time package: Add all layout files to menu
5050- simple way to make forms dockable at designtime (that means without writing any code)
5151- minimize button and Hide
5252- on show again: restore a default layout
5353- close button for pages
5454- Implement automatic menu merging in the LCL (when two forms with main menus are docked).
5555
5656## Usage I. (Add docking support to the Lazarus IDE)
5757
5858If you don't like the default "separate windows" look of the Lazarus IDE and prefer a single window (e.g., like RAD Studio™), you can install a package called **[[AnchorDockingDsgn]]** (lazarus/components/anchordocking/design/anchordockingdsgn.lpk). This package makes the IDE windows dockable.
5959
6060### Important to macOS users
6161
6262Before Lazarus 3.0, there are many bugs related to docking.
6363
6464If "anchordockingdsgn" has been installed before Lazarus 3.0, the wrong configuration may be saved and needs to be reset first.
6565
6666The configuration is saved in environmentoptions.xml, which usually located in ~/.lazarus
6767
6868Close the IDE, locate environmentoptions.xml, delete the content between \<AnchorDocking\> and \</AnchorDocking\>, and the initial setting of anchordockingdsgn will be automatically set when the IDE is started again.
6969
7070### Installation
7171
7272Uninstall any other docking managers (e.g., easydockmgrdsgn). From the Lazarus menu bar pick "Package" - "Install/Uninstall Packages" and install the "anchordockingdsgn" package.
7373
7474After you have successfully installed the package and restarted the IDE, the IDE starts with a default docked layout like shown below. Note that AnchorDocking headers and splitters have been added to all dockable windows of the IDE. In case the headers don't get visible, see the section "Options" below on how to enable/disable them.
7575
7676![](/wiki-images/a/ac/2021-12-02_10_21_07-Debian_10.8_Buster_-_VMware_Workstation.png)
7777
7878You can change the layout by grabbing a dockable window by the Anchordocking header and drag and dock it anywhere else, or resize docked windows via splitters added to the window borders. You can right-click on the headers too for other options, for example, to change the look of the headers, as shown farther down below.
7979
8080You can save the layout via the menu item **Tools / Save window layout as default**. This saves to ~/.lazarus/anchordocklayout.xml and restores it when the IDE starts up.
8181
8282You can also save the layout to a file and load them later.
8383
8484Since Lazarus 1.1 you can pass a command line parameter
8585
86-```
86+```text
8787./lazarus --anchordocklayout=<filename>
8888```
8989
9090The look (like the headers) can be further tweaked by right-clicking on them.
9191
9292![](/wiki-images/8/8a/Docking_headers.gif)
9393
9494### Options
9595
9696After the successful installation of the AnchorDockingDsgn package, an additional configuration menu is added to the Lazarus options dialog ("Tools" - "Options" - "Environment")
9797
9898![](/wiki-images/3/3a/Anchordocking_options.png)
9999
100100#### Scale on resize
101101
102102When resizing a window, all docked forms inside are scaled by the same percentage.
103103
104104#### Show headers
105105
106106To dock/undock a window, you need to enable this option.
107107
108108#### Flatten headers
109109
110110No 3d frame in headers.
111111
112112#### Header align top/left
113113
114114Headers are automatically put at top or left depending on these two values:
115115
116116- Move header to top, when (width/height)*100\<=HeaderAlignTop, default 80
117117- Move header to left, when (width/height)*100\>=HeaderAlignLeft, default 120
118118- Otherwise keep the header at the current position.
119119
120120Which means the header is by default put at the smaller side of a docked control. When the control is resized, the header switches to the smaller side.
121121
122122#### Allow dock sites to be minimized
123123
124124A extra minimize button is added, so a site can be minimized. Then sites next to it get more space. If needed, the minimized site then can easy be opened.
125125
126126#### Multine Tabs
127127
128128Feature added in Lazarus 2.2. If a OS support multiline tabs (like Windows), if there are no many tabs, they are shown in multiple lines.
129129
130130#### Floating windows on top
131131
132132Feature added in Lazarus 2.2. If there are undocked windows shown, show these on top of main window. In a own application, there can be set DockMaster.MainDockForm, then all floating windows are shown on top of it. If MainDockForm is not set, Application.MainForm is used.
133133
134134## Usage II. (Add docking support to your own applications)
135135
136136### Quick start
137137
138138Add the package **AnchorDocking** to the required packages in the project inspector.
139139
140140Then add the unit **AnchorDocking** to the uses section of your main unit (the unit with your main form).
141141
142142Add to the FormCreate of your main form:
143143
144144``` pascal
145145 DockMaster.MakeDockSite(Self,[akBottom],admrpChild);
146146```
147147
148148For the other dockable forms replace all calls of *Show* and *ShowOnTop* with
149149
150150``` pascal
151151 DockMaster.MakeDockable(Form1,true,true);
152152```
153153
154154For the other dockable forms replace all calls of *Visible:=true* with
155155
156156``` pascal
157157 DockMaster.MakeDockable(Form1,true);
158158```
159159
160160Remove or comment all *Hide*, *Visible:=false*, *WindowState:=* calls.
161161
162162### Prerequisites
163163
164164- Your project must use the package *AnchorDocking*.
165165- All dockable forms must be shown with MakeDockable or MakeDockSite. Do not use *Show*, *BringToFront*, *ShowOnTop*, *Visible:=true*. Of course you can have some non dockable forms, like hints or splashscreens.
166166- All dockable forms must be free resizable, that means no constraints, no BorderStyle bsDialog.
167167- No other docking system. AnchorDocking is incompatible with EasyDockMgr.
168168
169169### Making forms dockable
170170
171171There are two ways to make a form dockable. You can use **DockMaster.MakeDockable** to wrap a form into a dock site. Then your form can dock and be docked completely free. You will use that for the biggest part of your forms, except for the MainForm, because this is only supported for the MainForm on gtk2 and qt. The second way is to use **DockMaster.MakeDockSite**. The form can dock other sites, but can not be docked itself. You might want to use *MakeDockSite* for the *MainForm*. For most other forms you probably want to use this:
172172
173173``` pascal
174174// shows YourForm
175175// if not already done, wrap the form into a dock site
176176DockMaster.MakeDockable(YourForm);
177177```
178178
179179Here are some examples how a form looks like that was made dockable with **DockMaster.MakeDockable**:
180180
181181![](/wiki-images/b/bc/Docksite1.png) ![](/wiki-images/c/c6/Docksite2.png)
182182
183183The header position is normally done automatically and the user can with a right click put it to any of the four sides.
184184
185185### Example: miniide1
186186
187187The example can be found in *lazarus/components/anchordocking/miniide/miniide1.lpi*. It has a *mainform* in unit *unit1.pas* with a main menu which works as a docksite and several forms that are dockable.
188188
189189![](/wiki-images/a/a5/Anchordocking_miniide1.png)
190190
191191### Making the main form a dock site
192192
193193In the TMainIDE.FormCreate the main form **MainIDE** is turned into a docksite:
194194
195195``` pascal
196196DockMaster.MakeDockSite(Self,[akBottom],admrpChild);
197197```
198198
199199The parameter *\[akBottom\]* allows to dock other sites at the bottom of MainIDE. The parameter *admrpChild* tells the DockMaster that when the MainIDE is enlarged the extra space is distributed to the docked sites.
200200
201201When the user docks a site to the bottom of MainIDE the site is put onto MainIDE (Site.Parent:=MainIDE) with Site.Align=alBottom. The other controls on MainIDE must be compatible to this. MainIDE for example has a BtnPanel with Align=alLeft and a TNoteBook with Align=alClient. See [[Autosize / Layout|here]] how Align works.
202202
203203The DockMaster adds automatically a splitter:
204204
205205![](/wiki-images/c/ca/Anchordocking_miniide_dockedse1.png)
206206
207207As soon as a dockable form is docked its caption is shown in the dock header.
208208
209209#### Requirements for a custom dock site
210210
211211As long as nothing is docked into a custom dock site, your form can do everything as a normal form. But when a site is docked to it, some properties and methods need special care:
212212
213213- AutoSize=true may result in an endless loop. Disable it or override DoAutoSize/CalculatePreferredSize and take special care.
214214- Constraints: The DockMaster clears the maximum Constraints and will restore them on undock.
215215- Child controls anchored to the aligned site may overlap. See [[Autosize / Layout|here]] how Align works.
216216- ChildSizing: The spacing properties like LeftRightSpacing, TopBottomSpacing may interfere with the docking layout.
217217
218218### Procedure to create all other forms by name
219219
220220The MainIDE sets the **DockMaster.OnCreateControl** event, to enable the DockMaster to create forms by name. This is needed to restore layouts.
221221
222222``` pascal
223223DockMaster.OnCreateControl:=@DockMasterCreateControl;
224224```
225225
226226``` pascal
227227procedure TMainIDE.DockMasterCreateControl(Sender: TObject; aName: string; var
228228 AControl: TControl; DoDisableAutoSizing: boolean);
229229
230230 procedure CreateForm(Caption: string; NewBounds: TRect);
231231 begin
232232 AControl:=CreateSimpleForm(aName,Caption,NewBounds,DoDisableAutoSizing);
233233 end;
234234
235235begin
236236 // first check if the form already exists
237237 // the LCL Screen has a list of all existing forms.
238238 // Note: Remember that the LCL allows as form names only standard
239239 // pascal identifiers and compares them case insensitive
240240 AControl:=Screen.FindForm(aName);
241241 if AControl<>nil then begin
242242 // if it already exists, just disable autosizing if requested
243243 if DoDisableAutoSizing then
244244 AControl.DisableAutoSizing;
245245 exit;
246246 end;
247247 // if the form does not yet exist, create it
248248 if aName='CodeExplorer' then
249249 CreateForm('Code Explorer',Bounds(700,230,100,250))
250250 ...
251251 else if aName='DebugOutput' then
252252 CreateForm('Debug Output',Bounds(400,400,350,150));
253253end;
254254```
255255
256256Creating a form can be as simple as this:
257257
258258``` pascal
259259MyForm:=TMyForm.Create(Self);
260260if DoDisableAutoSizing then
261261 MyForm.DisableAutoSizing;
262262```
263263
264264But of course you can put there all kind of initialization code.
265265
266266The *DisableAutoSizing* reduces flickering. Make sure your forms **Visible** property is set to **false**.
267267
268268Remember to call **DisableAutoSizing** for the form if the parameter **DoDisableAutoSizing** is set to *true*, because *Disable-* and *EnableAutosizing* calls must be balanced. If you miss the *DisableAutosizing*, the LCL will raise an exception later:
269269
270-```
270+```text
271271TControl.EnableAutoSizing SourceEditor1:TSimpleForm: missing DisableAutoSizing
272272```
273273
274274![](/wiki-images/8/8e/MissingDisableAutoSizing.png)
275275
276276If you call **DisableAutoSizing** too much, your forms will not appear and/or not resize properly as the LCL is waiting for the *EnableAutoSizing* call that never comes.
277277
278278### Showing forms
279279
280280When a form should be shown, you have probably used something like *'MyForm.Show*. Instead you should now use
281281
282282``` pascal
283283DockMaster.MakeDockable(MyForm);
284284```
285285
286286This will wrap MyForm in a dock site and show it. It is clever enough to figure out if the form is already wrapped in a dock site.
287287
288288If you set the **DockMaster.OnCreateControl** event you can use this:
289289
290290``` pascal
291291DockMaster.ShowControl('MyForm',true);
292292```
293293
294294### Docking manually, via code
295295
296296Use the procedure **DockMaster.ManualDock** to dock a site to or into another.
297297
298298``` pascal
299299procedure ManualDock(SrcSite, TargetSite: TAnchorDockHostSite; Align: TAlign; TargetControl: TControl = nil);
300300```
301301
302302- **SrcSite** is the site to be docked. If SrcSite was docked it will be undocked first.
303303- **TargetSite** is the site where SrcSite will be docked into or docked as neighbor.
304304- **TargetControl** specifies if docking as neighbor (=nil), as inside neighbor (=TargetSide) or in front of a page (=a TAnchorDockPage).
305305
306306### Undocking manually, via code
307307
308308Use the procedure **DockMaster.ManualFloat** to undock a site from its neighbors and create a flotaing top level form. The embedded control stays embedded into a TAnchorDockHostSite.
309309
310310``` pascal
311311procedure ManualFloat(AControl: TControl);
312312```
313313
314314You can give as parameter a TAnchorDockHostSite or a control embedded into a TAnchorDockHostSite (for example a form made dockable with MakeDockable). The site will be put at the same screen location.
315315
316316### Save layout
317317
318318The DockMaster allows to save the current layout to a TConfigStorage. The miniide example uses the xml version:
319319
320320``` pascal
321321procedure TMainIDE.SaveLayout(Filename: string);
322322var
323323 XMLConfig: TXMLConfigStorage;
324324begin
325325 try
326326 // create a new xml config file
327327 XMLConfig:=TXMLConfigStorage.Create(Filename,false);
328328 try
329329 // save the current layout of all forms
330330 DockMaster.SaveLayoutToConfig(XMLConfig);
331331 XMLConfig.WriteToDisk;
332332 finally
333333 XMLConfig.Free;
334334 end;
335335 except
336336 on E: Exception do begin
337337 MessageDlg('Error',
338338 'Error saving layout to file '+Filename+':'#13+E.Message,mtError,
339339 [mbCancel],0);
340340 end;
341341 end;
342342end;
343343```
344344
345345### Load layout
346346
347347``` pascal
348348procedure TMainIDE.LoadLayout(Filename: string);
349349var
350350 XMLConfig: TXMLConfigStorage;
351351begin
352352 try
353353 // load the xml config file
354354 XMLConfig:=TXMLConfigStorage.Create(Filename,True);
355355 try
356356 // restore the layout
357357 // this will close unneeded forms and call OnCreateControl for all needed
358358 DockMaster.LoadLayoutFromConfig(XMLConfig);
359359 finally
360360 XMLConfig.Free;
361361 end;
362362 except
363363 on E: Exception do begin
364364 MessageDlg('Error',
365365 'Error loading layout from file '+Filename+':'#13+E.Message,mtError,
366366 [mbCancel],0);
367367 end;
368368 end;
369369end;
370370```
371371
372372### Enlarge/Shrink
373373
374374The anchor docking manager can enlarge/shrink docked neighbors. This is done via the popup menu of the dock header or in code with the function **DockMaster.ManualEnlarge**:
375375
376376``` pascal
377377function ManualEnlarge(Site: TAnchorDockHostSite; Side: TAnchorKind; OnlyCheckIfPossible: boolean): boolean;
378378```
379379
380380Site is a child site, Side the side of Site to expand. If you only want to test if enlarge is possible set OnlyCheckIfPossible to true.
381381
382382### Enlarge one, shrink another
383383
384384Shrink neighbor *Object Inspector*, enlarge *Messages*: Right click on the header of *Messages* and click on **Enlarge right side**. Two splitters are resized.
385385
386386![](/wiki-images/1/15/Anchordocking_before_enlarge1.png) enlarging *Messages* to the right side: ![](/wiki-images/f/f8/Anchordocking_after_enlarge1.png)
387387
388388### Enlarge one, shrink many
389389
390390Shrink splitter at one side, enlarge both neighbor splitters, rotate the splitter behind, enlarge Control, shrink controls at rotate splitter. Right click on header of *Source Editor 1* then click on **Enlarge bottom side**.
391391
392392![](/wiki-images/c/cb/Anchordocking_before_enlarge2.png) becomes ![](/wiki-images/4/42/Anchordocking_after_enlarge2.png)
393393
394394### General docking options
395395
396396The AnchorDocking package provides a dialog to setup some of the properties of the DockMaster. The dialog is in the unit AnchorDockOptionsDlg and you can use it simply:
397397
398398``` pascal
399399uses ... AnchorDockOptionsDlg;
400400...
401401procedure TMainIDE.FormCreate(Sender: TObject);
402402...
403403begin
404404 ...
405405 DockMaster.OnShowOptions:=@ShowAnchorDockOptions;
406406 ...
407407end;
408408```
409409
410410This will add a new menu item to the popup menus of the dock headers and pages called *Docking options*.
411411
412412## Why use Anchors instead of Align?
413413
414414Anchors allow to create any possible rectangular layout. Align is limited. Align with Panels can theoretically create a lot of layouts, but still not all. And some operations like enlarge/shrink are more complicated using Align/Panels than using Anchors. Align works good for a few forms, but the more forms are docked, the more the disadvantages of Align become visible.
415415
416416### Layouts that can be created with Align
417417
418418Align can only create the following layouts:
419419
420420![](/wiki-images/1/13/Anchordocking_align_layout1.png)
421421
422422The alTop controls are always at the top, filling the whole horizontal width. That's because the LCL first aligns all controls with alTop, then all alBottom, then alLeft, then alRight and finally alClient.
423423
424424### Layouts that can be created with Align and Panels
425425
426426It is possible to nest Align layouts by using hidden panels. Then any layout that can be recursively splitted in halves can be created. Then you can create for example:
427427
428428![](/wiki-images/0/0e/Anchordocking_align_panels_layout1.png)
429429
430430This requires only one hidden panel.
431431
432432### Changing Layouts
433433
434434Now the user wants to enlarge the *FPDocEditor* horizontally (and shrink *CodeExplorer*). With the *AnchorDocking* you can simply right click on the *FPDocEditor* header and click **Enlarge right side**.
435435
436436![](/wiki-images/8/88/Anchordocking_align_panels_layout2.png)
437437
438438Other docking engines need at least 2 panels. One for *SrcEditor*,*Messages*,*FPDocEdit*,*CodeExpl* and one for *SrcEdit* and *Messages*. Most docking layouters do not even provide a simple way to change the layout in this way. An algorithm to allow this layout change, must analyze the whole structure as if there were no panels and must reparent a lot of things. Basically the algorithm must do the same as the anchor docking algorithm, but with the extra work of translating the layout into Align plus hidden panels.
439439
440440### Layouts that are impossible with Align and Panels
441441
442442Now the user wants to enlarge *SourceEditor1* horizontally (and shrink *ObjectInspector*):
443443
444444![](/wiki-images/e/e9/Anchordocking_impossible_with_align_panels1.png)
445445
446446This layout is impossible with Align and panels, because you can not cut it in two halves. The same with
447447
448448![](/wiki-images/1/1e/Anchordocking_impossible_with_align_panels2.png)
449449
450450### Conclusion
451451
452452Align with hidden panels allows you to easily create a simple docking manager that works well for a few forms, but it will always limit the user. Align is useful for row and column layouts, not for tables. Anchor docking works even for complex forms.
453453
454454## Old/deprecated anchor docking
455455
456456### Create a TLazDockingManager
457457
458458``` pascal
459459 DockingManager:=TLazDockingManager.Create(Self);
460460```
461461
462462The Self as parameter is only used as Owner. That means, when the mainform is freed, the DockingManager is freed too. You can use *nil* and free the DockingManager yourself.
463463
464464### Optional: Loading a configuration
465465
466466You can load the user configuration from disk.
467467
468468``` pascal
469469 Config:=TXMLConfigStorage.Create('config.xml',true);
470470 DockingManager.LoadFromConfig(Config);
471471 Config.Free;
472472```
473473
474474This loads the file *config.xml*. The config can be created by the SaveToConfig function. See below.
475475
476476### Make a form/control dockable
477477
478478Create a TLazControlDocker for each form/control that should be dockable
479479
480480``` pascal
481481 ControlDocker1:=TLazControlDocker.Create(Self);
482482 ControlDocker1.Name:='DockerForm1';
483483 ControlDocker1.Manager:=DockingManager;
484484```
485485
486486### Optional: Saving the user configuration to disk
487487
488488When the program is closed you can save the user configuration to disk
489489
490490``` pascal
491491 Config:=TXMLConfigStorage.Create('config.xml',true);
492492 DockingManager.SaveToConfig(Config);
493493 Config.WriteToDisk;
494494 Config.Free;
495495```
496496
497497## See also
498498
499499- [[AnchorDockingDsgn]] AnchorDocking in the Lazarus IDE
500500- [[Anchor Docking Step by step example|Anchor Docking: A Step by step example]]
501501- [[Docking]] in general
502502- [[EasyDockingManager]] - an alternative docking implementation with a simpler layout engine and fewer options.
503503
504504---
505505*From the Free Pascal wiki, page "Anchor Docking", as it stood on 2024-01-27 after a change by Rich2014, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).*
506506Category: Docking
507507Category: Lazarus IDE plugins

Back to history