Please visit our new home community.embarcadero.com.
By: David Intersimone
Abstract: Creating a VCL for PHP Charting component. This article is a reproduction of the blog post by Jose Leon, developer of Delphi for PHP.
VCL for PHP Charting components - Property Editor
On the last article, we added some properties to the chart component, including a Series property, of array type, but such property cannot be edited directly through the Object Inspector. To allow the user edit such property, we need to write a property editor that visually allows the user to create all series and set its attributes.
On this article, we will see how to create a visual Property Editor in Delphi for Windows and how to attach it to the Series property to read and write information.
Preparing the property
On the first article, we analyzed the Open Flash Chart library and gathered some information about the features, to know what we need to do in order to wrap it.
The Series property is going to be responsible to hold all the information the chart is going to show.
By checking all the samples and all the documentation, we get a list of attributes a serie can have, and bear in mind, not all attributes apply to all types of series, but most of them are common.
Here is the list I extracted:
By reading the Open Flash Chart documentation and samples, all of these attributes are self explanatory, but just note that some of them are events. Yes, events, you can create and attach event handlers from a property editor, keep reading and you will see how.
Inheriting from Array Editor
For array properties like Series, there is a ready made property editor called Array Editor, which provides a convenient way of editing array properties that can contain subproperties. All the process of reading the property from the IDE, fill the property editor with the right values and write the information back, is done in the base class, so we just need to customize it for our needs.
To write a property editor, you will need Delphi for Windows, at the moment of writting this, you need Delphi 2007. You have to create a new package and add to the requires section two .dcp files, D4PHPTools.dcp and nativePropertyEditors.dcp, the first one contain common routines to interface with the IDE and base classes, and the second one, contain all the native property editors you can inherit from. Actually, you only need D4PHPTools.dcp, but like we are going to inherit from an existing property editor, you also need the second one.
On the package, you need to create a unit, which will contain your property editor code, lets name it uSeriesPropertyEditor.pas.
This is how the project manager should look like:
To write our new property editor, just inherit from TArrayPropertyEditor:
uses Windows, Classes, Dialogs, Controls,
Forms, Graphics, SysUtils, D4PHPIntf,
ComCtrls, valedit, grids,
TSeriesPropertyEditor = class(TArrayPropertyEditor)
procedure beforeShowEditor(dialog: TForm); override;
procedure vePropertiesGetPickList(Sender: TObject; const KeyName: string; Values: TStrings);
procedure vePropertiesEditButtonClick(Sender: TObject);
procedure vePropertiesDblClick(Sender: TObject);
procedure vePropertiesSelectCell(Sender: TObject; ACol, ARow: Integer; var CanSelect: Boolean);
procedure GetNewItemCaption(Sender: TObject; var itemcaption: string);
The only method to override is beforeShowEditor, which is called to prepare the editor for working, the rest of methods are helpers and event handlers for the controls in the editor.
Implementing the methods
The first method to implement is beforeShowEditor, the dialog parameter contains the form that is shown to the user, so we can customize it:
procedure TSeriesPropertyEditor.beforeShowEditor(dialog: TForm);
latestkeyname := '';
with dialog as TArrayEditorDlg do begin
OnGetNewItemCaption := GetNewItemCaption;
caption := 'Series Editor';
btnNewSubItem.Visible := false;
btnLoad.Visible := false;
captionproperty := 'Name';
btnDelete.Top := btnNewSubItem.top;
with defaultproperties do begin
veProperties.OnGetPickList := vePropertiesGetPickList;
veProperties.OnEditButtonClick := vePropertiesEditButtonClick;
veProperties.OnSelectCell := vePropertiesSelectCell;
veProperties.OnDblClick := vePropertiesDblClick;
On the first lines, we set the caption for the editor and the buttons that are going to be available. Also, we set which property, of the existing attributes, is going to be used to set the caption of the entry, in this case we set it to Name, so when the user changes that value on the right side of the editor, the name of the serie will be changed.
Later, all the default properties for a serie are added, with its default values, and finally, the event handlers are attached.
Setting the default name for new series
procedure TSeriesPropertyEditor.GetNewItemCaption(Sender: TObject;
var itemcaption: string);
itemcaption := 'Serie' + inttostr((sender as TArrayEditorDlg).tvItems.Items.Count + 1);
This method is called when a new item is created by the user, in this case, a new serie, it just returns on itemcaption the name of the serie with a sequence number.
Creating events from the property editor
procedure TSeriesPropertyEditor.vePropertiesDblClick(Sender: TObject);
x, y: integer;
if (latestkeyname = 'OnClick') then begin
ename := trim((sender as TValueListEditor).Values[latestkeyname]);
control := (sender as TValueListEditor).Values['Name'];
if (ename = '') then ename := control + 'Click';
addEvent('?>' + #13 + #10 + #13 + #10 + '<?php', ename, x, y);
(sender as TValueListEditor).Values[latestkeyname] := ename;
if (latestkeyname = 'OnGetData') then begin
if (ename = '') then ename := control + 'GetData';
addEvent('' + #13 + #10 + #13 + #10 + '', ename, x, y);
if (latestkeyname = 'OnCustomize') then begin
if (ename = '') then ename := control + 'Customize';
This method is executed when a cell is double clicked, and, if we check the cell is an event:
All this for the three events a serie can have.
Offering values for a property
procedure TSeriesPropertyEditor.vePropertiesGetPickList(Sender: TObject;
const KeyName: string; Values: TStrings);
if (KeyName = 'OnGetData') or (KeyName = 'OnCustomize') then begin
if (KeyName = 'Type') then begin
with values do begin
if (KeyName = 'Animate') then begin
if (KeyName = 'DataSource') then begin
And finally, this method is called when the user drops down the value box on the values editor, so we can offer a list of valid values. In this case, for Type, we offer all the types of charts the user can create, for Animate, just true or false, and for DataSource, we show a list of Datasource components found on the form. The getcomponents function is a built-in function offered by the IDE.
To attach this property editor to the Series property of the OpenChart component, just use the initialization section this way:
//Register all property editors
registerPropertyEditor('OpenChart', 'Series', TSeriesPropertyEditor);
So the IDE knows which property editor use when the user tries to edit such property.
And here is the property editor working:
Hide imageClick to see full-sized image
Could not retrieve comments. Please try again later.
Click here to download a free 30-day trial of HTML5 Builder, part of RAD Studio>
@RADtools on Twitter
Server Response from: ETNASC02