Umíme to s Delphi, 47. díl – vytvořte si vlastní komponentu, dokončení
- Kapitoly článku:
-
- Definování a testování
- Ukázková komponenta a vytvoření ikony pro komponentu
Poznámka: ani po dlouhém uvažování se mi bohužel nepodařilo vymyslet žádnou dostatečně názornou komponentu, která by měla smysluplné použití a zároveň by její vývoj bylo možné popsat na omezeném prostoru tohoto dílu seriálu…:) Zachránila mě nakonec komponenta Běžící text, kterou jsem převzal z knihy Slavoje Píska Začínáme programovat v Delphi, Grada 2000.
V prostředí Delphi pozavírejte veškerá otevřená okna (File – Close All). Vytvořte novou komponentu (Component – New Component). Pole v zobrazeném dialogu vyplňte podle následujícího obrázku:
Klepněte na OK a zapište zdrojový kód podle následujícího výpisu:
unit RunText;
interface
uses
Windows, Messages,
SysUtils, Classes, Controls, StdCtrls, ExtCtrls;
type
TRunText
= class(TCustomLabel)
private
FTimer:
TTimer;
procedure PosunText(Sender: TObject);
function GetActive: Boolean;
procedure SetActive(Start:
Boolean);
function GetSpeed: Integer;
procedure SetSpeed(MSec: Integer);
{ Private declarations
}
protected
{ Protected declarations }
public
constructor Create(AOwner: TComponent);
override;
{ Public declarations }
published
// zverejnime jen nektere vlastnosti TCustomLabel
property AutoSize;
property Alignment;
property Transparent;
property WordWrap;
property Caption;
// a vytvorime sve vlastni
vlastnosti
property Active: Boolean read GetActive write
SetActive;
property Speed: Integer read GetSpeed write
SetSpeed;
{ Published declarations }
end;
procedure Register;
implementation
constructor
TRunText.Create(AOwner: TComponent);
begin
inherited
Create(AOwner);
FTimer := TTimer.Create(Self);
FTimer.OnTimer := PosunText;
FTimer.Interval := 500;
FTimer.Enabled := True;
end; // constructor
procedure
TRunText.PosunText(Sender: TObject);
var S, Pom: String;
begin
Pom := Caption;
S := Copy(Pom, 1, 1);
Delete(Pom, 1,
1);
Pom := Pom + S;
Caption := Pom;
end; //
TRun.PosunText
function TRunText.GetActive: Boolean;
begin
Result := FTimer.Enabled;
end; //
TRunText.GetActive
procedure TRunText.SetActive(Start:
Boolean);
begin
FTimer.Enabled := Start;
end; //
TRunText.SetActive
function TRunText.GetSpeed:
Integer;
begin
Result := FTimer.Interval;
end; //
TRunText.GetSpeed
procedure TRunText.SetSpeed(MSec:
Integer);
begin
FTimer.Interval := MSec;
end; //
TRunText.SetSpeed
procedure Register;
begin
RegisterComponents(`Nase`, [TRunText]);
end;
end.
Dovolím si upozornit na několik maličkostí souvisejících s tímto zdrojovým kódem:
- je nutné připsat do sekce Uses modul ExtCtrls, aby bylo možné používat komponentu Timer;
- soukromý atribut FTimer je objektem typu TTimer, a proto jej musíme v konstruktoru dynamicky vytvořit. Je tedy nutné předefinovat konstruktor a v něm zavolat konstruktor Create třídy TTimer. Důležité je uvedení vlastníka časovače, protože díky tomu nemusíme časovač ručně uvolňovat z paměti (postará se o to vlastník v okamžiku, kdy sám na tomto světě končí);
- v konstruktoru nezapomeneme vyvolat konstruktor předka a dále provážeme událost OnTimer objektu FTimer s procedurou PosunText: tím zajistíme, že při generování události OnTimer (tedy po vypršení daného časového intervalu) bude vždy automaticky volána metoda PosunTextu;
- metody GetActive, SetActive, GetInterval, SetInterval slouží jako přístupové metody k vlastnostem Active a Interval;
- v sekci published zveřejníme jen některé vlastnosti třídy TCustomLabel. Ostatní jsou sice k dispozici (za běhu prgramu), ale neobjevují se v Object Inspectoru. Toho jsme přesně chtěli dosáhnout, proto jsme jako rodiče naší komponenty zvolili TCustomLabel a nikoliv přímo TLabel.
Nejprve zdrojový kód uložte. Pak vyberte Component – Install Component. V otevřeném dialogu buď vyberte existující balík nebo vytvořte nový (podle toho vyberte záložku v horní části). My vytvoříme nový balík jmenující se ZiveComponents:
Klepněte na OK a na následující dotaz odpovězte kladně (zajímá-li vás to, Delphi se ptá, má-li balík sestavit a následně instalovat do palety komponent):
Objeví se informační hláška říkající, že balíček s názvem ZiveComponents byl úspěšně instalován a že byla registrována komponenta RunText třídy TRunText:
Potvrďte a je hotovo. Nyní společně komponentu otestujeme uvedeným postupem (v testovací aplikaci, bez IDE). Uložte a pozavírejte veškerá okna (File – Save All, File – Close All) a vytvořte novou aplikaci. Na formulář umístěte tři tlačítka: btnVytvor, btnNastav, btnZrus. Nezapomeňte také modul s naší komponentou (tedy soubor RunText) uvést v sekci uses a definovat proměnnou typu TRunText (viz tučné fragmenty). Zdrojový kód této aplikace je zde:
unit hlavni;
interface
uses
Windows, Messages,
SysUtils, Variants, Classes, Graphics, Controls, Forms,
Dialogs,
StdCtrls;
type
TForm1 = class(TForm)
btnVytvor: TButton;
btnNastav: TButton;
btnZrus: TButton;
procedure btnVytvorClick(Sender:
TObject);
procedure btnNastavClick(Sender: TObject);
procedure btnZrusClick(Sender: TObject);
private
{ Private declarations }
public
{ Public
declarations }
end;
var
Form1:
TForm1;
implementation
uses RunText;
var RunTextComponent:
TRunText;
{$R *.dfm}
procedure TForm1.btnVytvorClick(Sender:
TObject);
begin
// vytvoreni instance komponenty
RunTextComponent := TRunText.Create(Self);
with RunTextComponent
do
begin
Parent := Self;
Left :=
20;
Top := 20;
Height := 40;
Width := 100;
Caption := `Toto je text naší slavné ukázkové
komponenty `;
end; // with
end;
procedure
TForm1.btnNastavClick(Sender: TObject);
begin
if
Assigned(RunTextComponent) then
begin
RunTextComponent.Caption := `Ukázka změny nastavení vlastnosti Caption
`;
RunTextComponent.Speed := 200;
end; //
if
end;
procedure TForm1.btnZrusClick(Sender:
TObject);
begin
RunTextComponent.Free;
end;
end.
Aplikaci si přeložte a spusťte. Klepnutím na tlačítko btnVytvor dojde k vytvoření a zobrazení běžícího textu. Po klepnutí na btnNastav se změní titulek a rychlost běhu komponenty. Po klepnutí na btnZrus se komponenta zruší a z formuláře zmizí.
Na úplný závěr si ukážeme, co si počít v případě, že bychom uvedeným postupem našli chybu a chtěli ji ve zdrojovém kódu komponenty opravit. V našem případě se třeba rozhodneme, že publikujeme jednu událost třídy TCustomLabel (zatím jsme tak neučinili, proto by se v Object Inspectoru žádné události komponenty TRunText nezobrazily). Bude nutné znovu otevřít balík ZiveComponents obsahující naši komponentu TRunText (např. File – Close All, File – Open Project, změnit filtr přípon souborů na Delphi packages <.dpk) a najít podadresář Lib adresáře, v němž se nachází Delphi – viz následující obrázek).
Otevře se balík, viz obrázek:
Nyní poklepejte na soubor RunText.pas a soubor se otevře v Code Editoru. Proveďte potřebné modifikace (viz zdrojový kód obhahující změněnou deklaraci třídy), pak soubor uložte (File – Save). Nyní je velmi důležité klepnout na tlačítko Compile v dialogu zobrazujícím balík (tedy v tom z předchozího obrázku). Klepněte na Compile, balík se zkompiluje, vy vše pozavírejte a můžete otevřít opět testovací aplikaci, případně vytvořit novou aplikaci a vyzkoušet komponentu i v době návrhu.
type
TRunText = class(TCustomLabel)
private
FTimer: TTimer;
procedure
PosunText(Sender: TObject);
function GetActive:
Boolean;
procedure SetActive(Start: Boolean);
function GetSpeed: Integer;
procedure SetSpeed(MSec:
Integer);
{ Private declarations }
protected
{ Protected declarations }
public
constructor Create(AOwner: TComponent); override;
{
Public declarations }
published
// zverejnime jen
nektere vlastnosti TCustomLabel
property AutoSize;
property Alignment;
property Transparent;
property WordWrap;
property Caption;
//
dale zverejnime jednu udalost
property OnMouseEnter;
// a vytvorime sve vlastni vlastnosti
property Active:
Boolean read GetActive write SetActive;
property Speed: Integer
read GetSpeed write SetSpeed;
{ Published declarations
}
end;
Elegantnějším řešením tohoto testování komponent je vytvoření tzv. skupiny projektů. V tom případě můžete mít zároveň otevřený balíček i testovací aplikaci (aplikace). Nutno dodat, že koneckonců můžete mít balík i aplikaci otevřenou i bez skupiny projektů.
Jak tedy vytvořit vlastní ikonu? Uvnitř souboru *.DCR musíme vytvořit bitmapu o velikosti 24 x 24 pixelů ze 16 nebo 256 barev. Jméno bitmapy musí být stejné jako jméno třídy komponenty, jen převedené na velká písmena. ukážeme si, jak vytvořit ikonu pro komponentu TRunText, kterou jsme vytvořili v předchozím příkladu:
- Otevřete Image Editor (z hlavního menu vyberte Tools – Image Editor).
- V Image Editoru zvolte File – New – Component Resource File (viz obrázek):
- Z hlavního menu vyberte Resource – New – Bitmap. Otevře se dialog New
Bitmap. Nastavte její rozměry (24 x 24) a počet barev (16):
- Vytvořila se nová bitmapa Bitmap1. Klepněte na její název pravým tlačítkem, vyberte Rename a přejmenujte ji na TRUNTEXT.
- Poklepejte na její název a vytvořte její vzhled:-) Pak návrhové okno uzavřete.
- V Image Editoru zůstalo otevřeno okno umožňující správu projektu. Z hlavní
nabídky vyberte File – Save As…, vyberte stejný adresář ve kterém se nachází
zdrojový soubor komponenty RunText.PAS a zadejte RunText.DCR:
- Uzavřete Image Editor. Aby se však nová ikona ukázala na paletě, je nutné komponentu znovu přidat do balíčku a ten nainstalovat. Komponenta se pak objeví na vybrané paletě i s novou ikonou.