Class: ToolPanel

Properties  Events  Methods    Index of Classes

Creates tool panels - panels that are not listed on the Windows task list

Hierarchy

cObject
---cUIObject
------DfBaseObject
---------DfBaseWindow
------------DfBaseUIWindow
---------------DfBaseContainer
------------------DfBaseDialog
---------------------DfBasePanel
------------------------DfBasetoolPanel
---------------------------FloatingPanel
------------------------------ToolPanel
---------------------------------cCJGridFieldChooserPanel
---------------------------------SplashScreenPanel

Library: Windows Application Class Library

Package: Windows.pkg

Description

The ToolPanel container class creates panels that are not listed on the Windows task list. It is ideal for creating popup containers that you want to float on the Windows desktop but not appear on the Windows task list. This class can be used to creating non-modal floating panels. If you need to create a popup modal panel you should use its subclass ModalPanel (or the data aware subclass dbModalPanel).

Sample

Object MyPanel is a ToolPanel
    Set Size to 100 150
    Set Label to "My Tool Panel"
    :
End_Object


Syntax

Use windows
 
Object object_name is a ToolPanel
    set size to height width
    set locate_mode to LocateMode
    set label to title
    :
End_Object


Of Special Note

ToolPanel objects usually used to create floating popup "tool" or helper panels. They are almost always non-modal. If a modal popup object is required you would base the object on the ModalPanel class. ToolPanels are usually closed by sending the close_panel message.

Caption Bar Label

The text that will appear in a panel's caption bar is set with the Label property. Note that this label will not appear in the windows task list. This is the primary difference between a ToolPanel and a BasicPanel.

Resizing a Panel

When an object of this class is resized by users, this object sends the onResize message to itself. This message is supplied with no definition as a "hook" procedure to use when some action, such as resizing child list objects, is desired on resizing of this object.

Locating a Panel

The location of a panel is determined by the properties location and locate_mode. The defaut "smart" locate_mode will be cause the panel to be centered or appear relative to the object that invoked it. This can be changed by changing the locate_mode property or by explicitly setting a location.

Tool-bars, Status-bars, client-area Ids

It is not expected that ToolPanel objects will contain tool-bars, status-bars or a client-area.

Exiting the Application

ToolPanel obejcts do normally not participate in the exit-application verification or notification process.