Gorilla.UI.FlowChart

Fields

• protected FAnchorPosFrom : TPointF
  
• protected FAnchorPosTo : TPointF
  
• protected FAnchorKindFrom : TFlowChartPatternAnchorKind
  
• protected FAnchorKindTo : TFlowChartPatternAnchorKind
  
• protected FPattern : TFlowChartPattern
  
• protected FLinePair : PLinePair
  
• protected FUnlinker : TCircle
  
• protected FToArrow : Boolean
  
• protected FFromArrow : Boolean
  
• protected FArrowSize : TPointF
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• protected procedure DoOnLineEnter  ( ASender :  TObject ) ;  virtual;
• protected procedure DoOnLineLeave  ( ASender :  TObject ) ;  virtual;
• protected procedure DoOnUnlinkQuery  ( ASender :  TObject ) ;  virtual;
• protected procedure DoOnEditQuery  ( ASender :  TObject ) ;  virtual;
• protected procedure DoOnUnlinkMouseUp  ( ASender :  TObject; AButton :  TMouseButton; AShift :  TShiftState; X :  Single; Y :  Single ) ;  virtual;
• protected procedure DoOnUnlinkerEnter  ( ASender :  TObject ) ;  virtual;
• protected procedure DoOnUnlinkerLeave  ( ASender :  TObject ) ;  virtual;
• public procedure UpdateLine  ( ) ;  overload virtual;

  Updates the path data of the cubic bezier line.

• public procedure UpdateLine  ( const  AFrom :  TFlowChartPattern; const  ATo :  TFlowChartPattern; const  AColor :  TAlphaColor ) ;  overload virtual;

  Updates the path data of a specific line between AFrom and ATo pattern. The submitted color will be set for the line. This method will call the UpdateLine() method.

Properties

• public Pattern : TFlowChartPattern
  read FPattern
  write FPattern
  
• public LinePair : PLinePair
  read FLinePair
  
• public ToArrow : Boolean
  read FToArrow
  write FToArrow
  
• public FromArrow : Boolean
  read FFromArrow
  write FFromArrow
  
• public ArrowSize : TPointF
  read FArrowSize
  write FArrowSize
  

Fields

• protected FEnabled : Boolean
  
• protected FPoint : TPointF
  
• protected FKind : TFlowChartPatternAnchorKind
  

Properties

• published Enabled : Boolean

  Defines if this anchor is enabled for access.

  read FEnabled
  write FEnabled
  
• published Point : TPointF

  Defines the relative point position of the anchor.

  read FPoint
  write FPoint
  
• published Kind : TFlowChartPatternAnchorKind

  Only 4 sides are supported, so every anchor needs to matched with a specific side.

  read FKind
  write FKind
  

Fields

• protected INDEX_COUNT : Integer
  
• private FLineOwners : TFlowChartPatternList
  
• protected FIndex : Integer
  
• protected FTemplate : TFlowChartTemplate
  
• protected FInstance : TObject
  
• protected FAttached : TFlowChartPatternList
  
• protected FContained : TFlowChartPatternList
  
• protected FIsMoveable : Boolean
  
• protected FIsDraggable : Boolean
  
• protected FCanPostLink : Boolean
  
• protected FIsRoot : Boolean
  
• protected FLineOwner : TFlowChartPatternList
  
• protected FLines : TLinePairList
  
• protected FBidirectional : Boolean
  
• protected FMultipleOwners : Boolean
  
• protected FOwnerSwapping : Boolean
  
• protected FMultipleAttachments : Boolean
  
• protected FAttachmentsAllowed : Boolean
  
• protected FMultipleContainments : Boolean
  
• protected FContainmentsAllowed : Boolean
  
• protected FMinContainerHeight : Single
  
• protected FUseDefaultAnchors : Boolean
  
• protected FAnchors : TFlowChartPatternAnchors
  
• protected FShadow : TShadowEffect
  
• protected FOnMoved : TOnFlowChartPatternNotifyEvent
  
• protected FOnCanCreate : TOnFlowChartPatternCanCreate
  
• protected FOnCanLink : TOnFlowChartPatternAllowed
  
• protected FOnAttached : TOnFlowChartPatternLinkEvent
  
• protected FOnContained : TOnFlowChartPatternLinkEvent
  
• protected FOnUnattached : TOnFlowChartPatternLinkEvent
  
• protected FOnUncontained : TOnFlowChartPatternLinkEvent
  
• protected FOnBuilt : TOnFlowChartPatternLinkEvent
  
• protected FOnCanUnlink : TOnFlowChartPatternAllowed
  
• protected FOnEditLink : TOnFlowChartPatternLinkEvent
  
• protected FOnAdjustHeight : TOnFlowChartPatternNotifyEvent
  
• protected FOnGetDisplayName : TOnFlowChartPatternGetDisplayName
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;

  Default pattern constructor. In design time it will execute the Setup() method. On instanciating a component of this type at runtime you have to call Setup() on your own to initialize sub-components.

• public destructor Destroy  ( ) ;
• protected function GetTagIndex  ( )  : Integer ;  virtual;
• protected function GetFlowChart  ( )  : TFlowChartFrame ;  virtual;
• protected function GetLines  ( )  : TLinePairList ;  virtual;
• protected function GetAttached  ( )  : TFlowChartPatternList ;  virtual;
• protected function GetContained  ( )  : TFlowChartPatternList ;  virtual;
• protected function GetIsMoveable  ( )  : Boolean ;  virtual;
• protected procedure SetIsMoveable  ( AValue :  Boolean ) ;  virtual;
• protected function GetIsDraggable  ( )  : Boolean ;  virtual;
• protected procedure SetIsDraggable  ( AValue :  Boolean ) ;  virtual;
• protected function GetCanPostLink  ( )  : Boolean ;  virtual;
• protected procedure SetCanPostLink  ( AValue :  Boolean ) ;  virtual;
• protected function GetIsRoot  ( )  : Boolean ;  virtual;
• protected procedure SetIsRoot  ( AValue :  Boolean ) ;  virtual;
• protected function GetBidirectional  ( )  : Boolean ;  virtual;
• protected procedure SetBidirectional  ( AValue :  Boolean ) ;  virtual;
• protected function GetMultipleOwners  ( )  : Boolean ;  virtual;
• protected procedure SetMultipleOwners  ( AValue :  Boolean ) ;  virtual;
• protected function GetOwnerSwapping  ( )  : Boolean ;  virtual;
• protected procedure SetOwnerSwapping  ( AValue :  Boolean ) ;  virtual;
• protected function GetMultipleAttachments  ( )  : Boolean ;  virtual;
• protected procedure SetMultipleAttachments  ( AValue :  Boolean ) ;  virtual;
• protected function GetAttachmentsAllowed  ( )  : Boolean ;  virtual;
• protected procedure SetAttachmentsAllowed  ( AValue :  Boolean ) ;  virtual;
• protected function GetMultipleContainments  ( )  : Boolean ;  virtual;
• protected procedure SetMultipleContainments  ( AValue :  Boolean ) ;  virtual;
• protected function GetContainmentsAllowed  ( )  : Boolean ;  virtual;
• protected procedure SetContainmentsAllowed  ( AValue :  Boolean ) ;  virtual;
• protected function GetMinContainerHeight  ( )  : Single ;  virtual;
• protected procedure SetMinContainerHeight  ( AValue :  Single ) ;  virtual;
• protected function GetLineColor  ( )  : TAlphaColor ;  virtual;
• protected procedure DoOnSetup  ( ) ;  virtual;
• protected function FindComponentByClassAndTag  ( const  AClass :  TClass; const  ATag :  Integer  =  $0 )  : TComponent ;
• protected procedure DoOnLinePairNotify  ( ASender :  TObject; const  AItem :  PLinePair; AAction :  TCollectionNotification ) ;
• protected procedure DoOnDragDrop  ( ASender :  TObject; const  AData :  TDragObject; const  APoint :  TPointF ) ;  virtual;
• protected procedure DoOnDragOver  ( ASender :  TObject; const  AData :  TDragObject; const  APoint :  TPointF; var  AOperation :  TDragOperation ) ;  virtual;
• protected procedure DoOnMoveChildPatterns  ( const  AOfs :  TPointF ) ;  virtual;
• protected procedure DoOnTranslatePosition  ( const  AOffset :  TPointF ) ;  virtual;
• protected procedure DoOnSetAbsolutePosition  ( const  APoint :  TPointF ) ;  virtual;
• protected procedure DoOnUpdateLines  ( ) ;  virtual;
• protected procedure DoOnAdjustHeight  ( ) ;  virtual;
• protected procedure DoOnSetContainedParent  ( const  ASource :  TFlowChartPattern ) ;  virtual;
• protected function AddLineToParent  ( const  AParent :  TControl; const  AColor :  TAlphaColor )  : PLinePair ;  virtual;

  Adds and returns a new line pair from a pattern to a parent pattern.

• protected function GetLinePairIndex  ( const  AChild :  TFlowChartPattern )  : Integer ;  virtual;

  Returns the index of a specific line pair, where the from-value is Self and the to-value is AChild. The method returns -1, if no line pair could be found.

• protected procedure RemoveLinePair  ( const  AChild :  TFlowChartPattern ) ;  virtual;

  Removes a specific line pair and the visual line component from this pattern.

• protected procedure UpdateLine  ( const  ALine :  TFlowChartLine; const  AFrom :  TFlowChartPattern; const  ATo :  TFlowChartPattern; const  AColor :  TAlphaColor ) ;  virtual;

  Takes a specific line and adjusts the length and rotation of it.

• protected procedure UpdateLineOwners  ( ) ;  virtual;

  Updates all registered line owners and their lines, because it is possible, that multiple connections exist

• protected procedure UpdateChildLines  ( ) ;  virtual;

  Updates all lines to child rectangles

• protected function GetAbsolutePosition  ( )  : TPointF ;  virtual;
• protected function GetDisplayName  ( )  : string ;  virtual;
• public procedure SetPatternOwner  ( const  AValue :  TComponent ) ;  virtual;

  Reset the owner of this component. This method will remove the pattern form the previous pattern and adds it to the submitted component.

• public procedure TranslatePosition  ( const  AOffset :  TPointF ) ;

  Updates position of this pattern by a offset. To change the behaviour of this function override the protected method "DoOnTranslatePosition"

• public procedure UpdateAbsolutePosition  ( const  APoint :  TPointF ) ;

  Updates the absolute position of this pattern.

• public procedure AdjustHeight  ( ) ;

  Adjusts the height of a pattern. To overwrite the functionality, override the protected method DoOnAdjustHeight.

• public procedure UpdateLines  ( ) ;

  Update all connected lines. To change the behaviour of this function override the protected method "DoOnUpdateLines"

• public function GetLinePair  ( const  AChild :  TFlowChartPattern )  : PLinePair ;  virtual;

  Try to find the specific line pair to another pattern.

• public function HasMultipleOwners  ( )  : Boolean ;  virtual;

  Checks if more than owner is set in the LineOwners list

• public function CountLineOwners  ( )  : Integer ;  virtual;

  Counts the LineOwners and returns the number

• public procedure Setup  ( ) ;

  Overwrite the DoOnSetup method to initialize your individual extended pattern. Execute Setup() after construction to initialize sub-components. Do not use the constructor for creating sub-components, because on pattern cloning, you will have all components twice.

• public function IsTemplatePattern  ( )  : Boolean ;  virtual;

  Checks if a TFlowChartPattern is the template pattern, which will be cloned when a new instance is created.

• public function IsAttachable  ( const  ATemplate :  TFlowChartTemplate )  : Boolean ;  overload;

  Checks if a template is attachable to this pattern.

• public function IsAttachable  ( const  APattern :  TFlowChartPattern )  : Boolean ;  overload;

  Checks if a pattern is attachable to this pattern.

• public function IsAttached  ( const  APattern :  TFlowChartPattern )  : Boolean ;

  Checks if a pattern is already attached to this pattern.

• public function GetAttachedByInstance  ( const  AInst :  TObject )  : TFlowChartPattern ;

  Returns an attached flowchart pattern, where the instance is equal to the submitted instance

• public function IsContainable  ( const  ATemplate :  TFlowChartTemplate )  : Boolean ;  overload;

  Checks if a template can be container child of this pattern.

• public function IsContainable  ( const  APattern :  TFlowChartPattern )  : Boolean ;  overload;

  Checks if a pattern can be container child of this pattern.

• public function IsContained  ( const  APattern :  TFlowChartPattern )  : Boolean ;

  Checks if a pattern is already contained.

• public function GetContainedByInstance  ( const  AInst :  TObject )  : TFlowChartPattern ;

  Returns an contained flowchart pattern, where the instance is equal to the submitted instance

• public procedure AttachPattern  ( const  ASource :  TFlowChartPattern ) ;  virtual;

  Attaches a pattern to another pattern.

• public procedure ReattachPattern  ( const  ASource :  TFlowChartPattern ) ;  virtual;

  Reattaches a pattern to another pattern, while removing all previously owners.

• public procedure RemoveAttached  ( const  ASource :  TFlowChartPattern ) ;  virtual;

  Removes a pattern from another pattern.

• public procedure Detach  ( const  ASource :  TFlowChartPattern ) ;  virtual;

  Will remove the pattern from another patterns attach list. Will also remove the line pair and the drawn line.

• public procedure RemoveFromLineOwners  ( ) ;  virtual;

  Removes this pattern from all owners

• public procedure ClearAttached  ( ) ;  virtual;

  Will detach all attached patterns.

• public procedure ClearContained  ( ) ;  virtual;

  Will remove all contained patterns.

• public function CountAttached  ( )  : Integer ;  virtual;

  Returns the number of attached patterns.

• public procedure ContainPattern  ( const  ASource :  TFlowChartPattern ) ;  virtual;

  Puts a pattern into another pattern.

• public procedure RemoveContained  ( const  ASource :  TFlowChartPattern ) ;  virtual;

  Removes a pattern from the container of another pattern.

• public function CountContained  ( )  : Integer ;  virtual;

  Returns the number of contained patterns.

• public procedure AddLineOwner  ( const  APattern :  TFlowChartPattern ) ;  virtual;

  Add a pattern as owner of a line to this pattern.

• public procedure RemoveLineOwner  ( const  APattern :  TFlowChartPattern ) ;  virtual;

  Remove a pattern as owner of a line to this pattern from LineOwners list.

• public function IsLineOwner  ( const  APattern :  TFlowChartPattern )  : Boolean ;  virtual;

  Checks if a pattern already exists in LineOwners list.

• public function GetLineAnchor  ( const  AKind :  TFlowChartPatternAnchorKind )  : TPointF ;

  Request the default anchor for line attachment. If "UseDefaultAnchors" is set to TRUE, the method will use the default anchor positions. If "UseDefaultAnchors" is set to FALSE and the "Anchors" collection is not empty, the method will search for a matching anchor to this side. If no anchor could be found, the method will return the default anchor for this side.

Properties

• public Index : Integer

  The built index of this pattern.

  read FIndex
  
• public FlowChart : TFlowChartFrame

  Request the owning flow chart. This method is searches upwards for the TFlowChartFrame component. Do not use this property multiple times in your methods, instead store the result as temporary variable.

  read GetFlowChart
  
• public Instance : TObject

  The linked third-party instance of your logical structure.

  read FInstance
  write FInstance
  
• public Template : TFlowChartTemplate

  The linked flow chart template collection item.

  read FTemplate
  write FTemplate
  
• public TagIndex : Integer

  A unique index for this pattern to identify.

  read GetTagIndex
  
• public LineOwners : TObjectList<Gorilla.UI.FlowChart.TFlowChartPattern>

  A list of all owners connected to by line.

  read FLineOwners
  
• public Lines : TList<Gorilla.UI.FlowChart.PLinePair>

  All lines to linked child node patterns.

  read GetLines
  
• public LineColor : TAlphaColor

  Returns the line color for this pattern. By default the color comes from the DefaultLineColor of the parent flow chart component.

  read GetLineColor
  
• public Attached : TObjectList<Gorilla.UI.FlowChart.TFlowChartPattern>

  A list of attached child node patterns.

  read GetAttached
  
• public Contained : TObjectList<Gorilla.UI.FlowChart.TFlowChartPattern>

  A list of containing patterns.

  read GetContained
  
• public DisplayName : string

  Represents a name which can be used to identify a pattern visually, f.e. in a treeview

  read GetDisplayName
  
• public AbsolutePosition : TPointF

  Returns the absolute position of the pattern inside of the flowchart.

  read GetAbsolutePosition
  
• published UseDefaultAnchors : Boolean

  Defines if to use default anchors (left, top, right, bottom). By deactivating this feature, you need to have anchors added!

  read FUseDefaultAnchors
  write FUseDefaultAnchors
  
• published Anchors : TFlowChartPatternAnchors

  Contains a list of individual anchors.

  read FAnchors
  write FAnchors
  
• published IsMoveable : Boolean

  Defines if the pattern can be moved on flow chart.

  read GetIsMoveable
  write SetIsMoveable
  
• published IsDraggable : Boolean

  Defines if a pattern is generally draggable for containment or attachments.

  read GetIsDraggable
  write SetIsDraggable
  
• published CanPostLink : Boolean

  Defines if a pattern can be linked after it was created.

  read GetCanPostLink
  write SetCanPostLink
  
• published IsRoot : Boolean

  Defines if a new pattern can be created by dropping on flow chart box and create an new instance without a parent component.

  read GetIsRoot
  write SetIsRoot
  
• published Bidirectional : Boolean

  Allows to attach patterns to eachother.

  read GetBidirectional
  write SetBidirectional
  
• published MultipleOwners : Boolean

  Defines if this pattern can have multiple owners. This property will be checked before attaching and before the OnCanLink and OnCanCreate event is thrown.

  read GetMultipleOwners
  write SetMultipleOwners
  
• published OwnerSwapping : Boolean

  Defines if this pattern can automatically change the owner on drag-and-drop onto another pattern, while it was already linked to another pattern. This only works if MultipleOwners is disabled.

  read GetOwnerSwapping
  write SetOwnerSwapping
  
• published MultipleAttachments : Boolean

  Defines if this pattern allows multiple attached patterns.

  read GetMultipleAttachments
  write SetMultipleAttachments
  
• published AttachmentsAllowed : Boolean

  Defines if this pattern allows attaching patterns in general

  read GetAttachmentsAllowed
  write SetAttachmentsAllowed
  
• published MultipleContainments : Boolean

  Defines if this pattern allows multiple sub patterns.

  read GetMultipleContainments
  write SetMultipleContainments
  
• published ContainmentsAllowed : Boolean

  Defines if this pattern allows sub patterns in general

  read GetContainmentsAllowed
  write SetContainmentsAllowed
  
• published MinContainerHeight : Single

  Defines the minimum height for a container pattern. When the height of the pattern is adjusted this size is set as minimum if contained patterns exist

  read GetMinContainerHeight
  write SetMinContainerHeight
  
• published Shadow : TShadowEffect

  Configurable shadow effect of this pattern.

  read FShadow
  

Fields

• protected FCircle : TCircle
  

Methods

• protected function GetCircle  ( )  : TCircle ;  virtual;
• protected procedure DoOnSetup  ( ) ;  override;
• protected procedure DoOnSetContainedParent  ( const  ASource :  TFlowChartPattern ) ;  override;

Properties

• public Circle : TCircle

  Custom body circle of this pattern.

  read GetCircle
  

Fields

• protected FRectangle : TRectangle
  

Methods

• protected function GetRectangle  ( )  : TRectangle ;  virtual;
• protected procedure DoOnSetup  ( ) ;  override;
• protected procedure DoOnSetContainedParent  ( const  ASource :  TFlowChartPattern ) ;  override;

Properties

• public Rectangle : TRectangle

  Custom body rectangle of this pattern.

  read GetRectangle
  

Fields

• protected FHeader : TRectangle
  
• protected FCaption : TLabel
  
• protected FCheckBox : TCheckBox
  
• protected FIcon : TImage
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• protected procedure DoOnSetup  ( ) ;  override;
• protected function GetHeader  ( )  : TRectangle ;
• protected function GetCaption  ( )  : TLabel ;
• protected function GetCheckBox  ( )  : TCheckBox ;
• protected function GetIcon  ( )  : TImage ;
• public procedure SetIconImage  ( const  AImages :  TImageList; const  AIndex :  Integer ) ;  virtual;

  Use this method to apply a specific image from the imagelist AImages by an index.

Properties

• public Header : TRectangle

  The header rectangle aligned on top of the pattern. This component contains by default a checkbox, icon-image and a label.

  read GetHeader
  
• public Caption : TLabel

  Caption label component inside of the header rectangle.

  read GetCaption
  
• public Icon : TImage

  Icon image component inside of the header rectangle.

  read GetIcon
  
• public CheckBox : TCheckBox

  Checkbox component inside of the header rectangle.

  read GetCheckBox
  

Fields

• protected FText : TLabel
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• protected procedure DoOnSetup  ( ) ;  override;
• protected function GetText  ( )  : TLabel ;

Properties

• public Text : TLabel

  Text label component inside of the parent body rectangle.

  read GetText
  

Fields

• protected FOwnerClass : TClass
  
• protected FPattern : TFlowChartPattern
  
• protected FAttachables : TFlowChartTemplateList
  
• protected FContainables : TFlowChartTemplateList
  

Methods

• public constructor Create  ( ACollection :  TCollection ) ;
• public destructor Destroy  ( ) ;
• protected function GetAttachables  ( )  : TFlowChartTemplateList ;
• protected function GetContainables  ( )  : TFlowChartTemplateList ;
• public function IsAttachable  ( const  ATemplate :  TFlowChartTemplate )  : Boolean ;

  Checks if a specific template is attachable to an instance of the specfific template.

• public function IsContainable  ( const  ATemplate :  TFlowChartTemplate )  : Boolean ;

  Checks if a specific template can be put inside of an instance of this pattern.

• public procedure AddContainable  ( const  ATemplate :  TFlowChartTemplate ) ;

  Add a template as containable template to this. The added template will be displayed as pattern inside of another pattern. Only if the template is not registered yet in the attachables or containables list yet, it will be added. Otherwise it will throw an exception.

• public procedure RemoveContainable  ( const  ATemplate :  TFlowChartTemplate ) ;

  Remove a specific class template from this template.

• public function IsInContainables  ( const  ATemplate :  TFlowChartTemplate )  : Boolean ;

  Checks if a template is already in the containables-list.

• public procedure AddAttachable  ( const  ATemplate :  TFlowChartTemplate ) ;

  Add a template as attachable template to this. The added template will be displayed as child pattern of another pattern linked by a line. Only if the template is not registered yet in the attachables or containables list yet, it will be added. Otherwise it will throw an exception.

• public procedure RemoveAttachable  ( const  ATemplate :  TFlowChartTemplate ) ;

  Remove an attachable class template.

• public function IsInAttachables  ( const  ATemplate :  TFlowChartTemplate )  : Boolean ;

  Checks if a template is already in the attachables-list.

Properties

• published OwnerClass : TClass

  The class linked to this template.

  read FOwnerClass
  write FOwnerClass
  
• published Pattern : TFlowChartPattern

  The linked class pattern to this template.

  read FPattern
  write FPattern
  
• published Attachables : TObjectList<Gorilla.UI.FlowChart.TFlowChartTemplate>

  Attachable templates linked to this template. Those templates are displayed as pattern inside of another pattern.

  read GetAttachables
  
• published Containables : TObjectList<Gorilla.UI.FlowChart.TFlowChartTemplate>

  Containable templates linked to this template. Those templates are displayed as child pattern of another pattern linked by a line.

  read GetContainables