Class TFireDockPanelManager
Unit
FireDockingPanelManager
Declaration
type TFireDockPanelManager = class(TFireDockPanelManagerBase)
Description
Class TFireDockPanelManager is used to add Microsoft-like dock panels to the certain TControl.
The example below demonstrates the simplest use of the Docking Manager.
var
Manager: TFireDockPanelManager;
DockPanel: TFireDockControlPanel;
begin
Control: TControl := TControl.Create;
Manager := TFireDockPanelManager.Create(nil);
Manager.DockSite := Control;
DockPanel = Manager.AddDockPanel("My Panel", TFireDockPanelArea.LeftDockControlArea);
end;
Normally, you do not need to create it manually. Use TFireDockMainForm to get the main form, which contains the TFireDockPanelManager and a set of functions for dock panels creation.
Hierarchy
Overview
Methods
Properties
Description
Methods
 |
function GetSiteControl: TControl; |
|
Returns the control that is used to manage docking mechanism.
|
|
procedure SetSiteControl(Control: TControl); |
|
Sets the control that is used to manage docking mechanism.
|
|
function GetSiteForm: TForm; |
|
Returns the form that is used to manage docking mechanism.
|
|
procedure SetSiteForm(Form: TForm); |
|
Sets the control that is used to manage docking mechanism.
|
|
function GetCentralControl: TControl; |
|
Returns the central TControl for the dock layout.
|
|
procedure SetCentralControl(Control: TControl); |
|
Sets the central TControl for the dock layout. Actualy it is query the central layout panel and sets the central control to it. If you have TFireDockPanelManager and DockBarManager on the same TControl then TFireDockPanelManager.SetCentralControl and TDockBarManager.SetCentralControl do the identical thing.
|
 |
constructor Create(AOwner: TComponent); override; |
|
Constructs the class with the given owner on which the docking engine will be deployed.
|
|
destructor Destroy; override; |
|
|
|
procedure BeginUpdate; |
|
|
|
procedure EndUpdate; |
|
|
|
function GetLayoutPanel: TFireDockSplitLayoutPanel; |
|
Returns the root layout Panel for the docking tree.
|
|
function GetCentralDocumentPanel: TFireDockDocumentLayoutPanel; |
|
Creates and returns TFireDockDocumentLayoutPanel that can holds TFireDockDocumentPanel.
|
|
function AddDockWindow(Panel: TFireDockPanelBase; const ScreenRect: TRect): TFireDockWindow; |
|
Creates floating window (TFireDockWindow) and adds Panel to it with the given ScreenRect in pixels.
|
|
function AddDockPanel(const Title: String; Area: TFireDockPanelArea = TFireDockPanelArea.LeftDockPanelArea; TargetPanel: TFireDockPanelBase = nil): TFireDockControlPanel; overload; |
|
Creates and returns the dock Panel with the given Title in the given Area. Parameter TargetPanel is used to specify after which Panel you want to add the current Panel. If the parameter TargetPanel is nil, then the Panel is added to the end.
|
|
function AddDockPanel(const Title: String; const DefaultSize: TSizeF; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil): TFireDockControlPanel; overload; |
|
Creates and returns the dock Panel with the given Title in the given Area. Parameter TargetPanel used to specify after which Panel you want to add the current Panel. If the parameter is nil, then the Panel is added to the end. Parameter DefaultSize is used to specify the size of the new Panel.
|
|
procedure InsertDockPanel(Panel: TFireDockControlPanel; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil); overload; |
|
Inserts an existing dock Panel to the dock layout to the given Area. Parameter TargetPanel used to specify after which Panel you want to add the current Panel. If the parameter is nil, then the Panel is added to the end.
|
|
procedure InsertDockPanel(Panel: TFireDockControlPanel; const DefaultSize: TSizeF; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil); overload; |
|
Inserts an existing dock Panel to the dock layout to the given Area. Parameter TargetPanel used to specify after which Panel you want to add the current Panel. If the parameter is nil, then the Panel is added to the end. Parameter DefaultSize is used to specify the size of the Panel.
|
|
procedure RemoveDockPanel(Panel: TFireDockControlPanel); |
|
Removes dock Panel from the Manager and clear all internal structures regarding this Panel. Note that the function does not destroy the instance of Panel. After calling this function, you must delete the Panel manually using the operator 'Free'.
|
|
procedure ClearDockPanels; |
|
Removes all dock panels from the Manager and destroy its instanceses. Note: All Panel's references become invalid after this call.
|
|
procedure ShowDockPanel(Panel: TFireDockControlPanel; SetFocus: Boolean = True); |
|
Raises dock Panel and set focus to the first control on it if parameter setFocus is True.
|
|
function GetMargin: Single; |
|
Returns the Margin for for the dock layout.
|
|
procedure SetMargin(Margin: Single); |
|
Sets the Margin for for the dock layout.
|
|
function GetWindowTitle: String; |
|
|
|
procedure SetWindowTitle(const Title: String); |
|
|
|
function IsDockPanelFullContentsWhileDraggingShown: Boolean; |
|
|
|
procedure SetDockPanelFullContentsWhileDraggingShown(Show: Boolean); |
|
|
|
function IsDockPanelTransparentWhileDragging: Boolean; |
|
|
|
procedure SetDockPanelTransparentWhileDragging(Transparent: Boolean); |
|
|
|
procedure BestFit; |
|
Fits the size of the dock panels to provide the user with a comfortable view.
|
|
function SaveToFile(const FileName: TFileName): Boolean; |
|
Saves the dock panels layout to the file with FileName.
|
|
procedure SaveToStream(Stream: TStream); |
|
Saves the dock panels layout to the Stream.
|
|
function LoadFromFile(const FileName: TFileName): Boolean; |
|
Restores the dock panels layout from the file name with the FileName.
|
|
function LoadFromStream(Stream: TStream): Boolean; |
|
Restores the dock panels layout from the Stream.
|
Properties
|
property DockLayout: TFireDockMainFormLayout read FLayout; |
|
|
 |
property CentralPanelVisible: Boolean read FCentralPanelVisible write SetCentralPanelVisible default True; |
|
|
Generated by PasDoc 0.15.0.
