JadeSkinWindow Class

The JadeSkinWindow class, a subclass of the JadeSkinArea class, is the abstract superclass of all Window class skins and it contains the defined image and category of the skin. Applying a region to a window enables it to be of any shape and include "holes" inside it. In addition, any part of any child outside the defined region is not displayed.

For details about the JadeSkinWindow class properties summarized in the following table, see Chapter 1 of the JADE Encyclopaedia of Classes.

To understand the way in which a region is constructed, consider that the image specified by the myImageMask property is drawn (stretched) over the top of the window, including any border area. Only black pixels are considered part of the window when it is painted or clicked on.

The result could be a window with rounded corners, a window with holes in it, and so on.

Because the mask image is built to the same size as the actual window, if border masks are defined, the only reasonable region that could be constructed is one where the corners are shaped. As all other areas are stretched to fit, it is likely that they would not provide a suitable result. You would achieve a better result by defining only an inner image for the mask that is stretched.

If the mySkinCategory property is set to "Company Logo", for example, the skin is applied only to a window of the appropriate type that has the Window::skinCategoryName property also set to "Company Logo".

In addition, you can define a skin category for a control subclass (for example, each BaseControl subclass) and associate a different category name with each of those skins. The constructor of each control subclass can then set the appropriate category name on the control so that the correct JadeSkinBaseControl class skin is then applied.

JadeSkinForm Class

The JadeSkinForm class, a subclass of the JadeSkinWindow class, describes the skin of a form. Use the JadeSkinArea class to define the image drawn for the active border and the inner (client area) of the form. If the form has a backdrop picture, this image is drawn.

When erasing the inner area of the form:

1. If the form backBrush property is not null, the inner area is erased using that brush.

2. If the form skin has a JadeSkinArea class imgInner property value that is a brush, the inner area is erased using that brush.

3. If the form backColor property is not Color_3DFace, the inner area is erased using the background color of the form.

4. If the backColor property of the skin area is not Default_Color, erase using the backColor property value of the skin.

5. The Color_3DFace value is used when erasing.

6. If the form was erased using a color and the skin of the form has a JadeSkinArea class imgInner property value that is not a brush, that image is drawn centered in the inner area of the form skin.

The JadeSkinForm class contains the JADE skins defined for forms in your applications and encapsulates the behavior required to define and maintain JADE skins using the JadeSkinMaintenance and JadeSkinSelection forms provided by the JADE RootSchema.

For details about using runtime skin facilities provided by JADE methods, see "Run Time Skin Facilities", later in this chapter.

The set of skin images used by JADE is provided with the product release so that you can use these skins in your applications, if required. (By default, skins are not used.)

The form border for a skin is made up of 11 images, as shown in the following diagram.

The following is a description f the form border areas.

• Images 1, 3, 4, 6, 9, and 11 are shown at actual size.

• Images 2, 5, 7, 8, and 10 are stretched to fit the width or height of the form.

• Images 1, 2, and 3 must have the same height to enable the form to display correctly.

• Images 4, 5, and 6 must have the same height to enable the form to display correctly.

• Images 9, 10, and 11 must have the same height to enable the form to display correctly.

• The whole of image 1 is treated as the control menu area for the form.

• When an MDI child is maximized, the whole of image 4 is treated as the system menu area for the MDI child.

• Form icons are placed adjacently at the top right hand edge of the area defined by image 3.

• MDI child form icons are placed adjacently at the top right hand edge of the area defined by image 6.

• Form icons that are disabled are not displayed.

The following areas are not affected by using a skin.

• Only JADE forms adopt the skin presentation. Windows forms such as message boxes, common dialogs, and the JADE exception dialogs are unchanged.

• When a form is resized, Windows draws the standard form image while the resize is occurring.

• A minimized MDI form displays the standard image, as there is normally insufficient room to display the skinned image for that short caption line.

• Windows-drawn menu items are unchanged by the skin. This includes the system menus.

• Any changes made to the skin do not affect any current users of that skin.

• Windows sounds do not occur when forms are minimized, maximized, and so on, as the form buttons are not in the Windows standard positions and their actions must be performed programmatically by JADE. (Windows does not issue those sounds when such actions are performed programmatically.)

For details about maintaining and using JADE skins, see "Defining and Maintaining JADE Skins at Run Time" under "Maintaining Skins Using Extended Functionality", in Chapter 2 of the JADE Runtime Application Guide.

For details about the JadeSkinForm class properties summarized in the following table, see Chapter 1 of the JADE Encyclopaedia of Classes.

JadeSkinControl Class

The JadeSkinControl class, a subclass of the JadeSkinWindow class, is the abstract superclass that provides the definition of elements common for each control that can be skinned. For details, see Chapter 1 of the JADE Encyclopaedia of Classes.

Use the properties of the JadeSkinArea class to define the image drawn for the active border and the inner (client area) of each control. When erasing the inner area of a control:

1. If the control backBrush property of the form is not null, the inner area is erased using that brush.

2. If the control skin has a JadeSkinArea class imgInner property value that is a brush, the inner area is erased using that brush.

3. If the backColor property of the skin area is not Default_Color and the backColor property of the control is the default or the skin was set by using the Control class setSkin method, erase using the backColor property value of the skin.

4. If the value of the backColor property of the control is Color_3DFace and the form of the control has a skin whose backColor property is not set to Default_Color, the inner area is erased using the backColor property value of the form’s skin.

5. Erase using the backColor property value of the control.

6. If the control was erased using a color and the skin of the control has an inner image defined in the JadeSkinArea class imgInner property that is not a brush (that is, the JadeSkinArea class innerIsBrush property is set to false), that image is drawn centered in the inner area.

The constants provided by the JadeSkinControl class are listed in the following table.

For details about the JadeSkinControl class properties summarized in the following table, see Chapter 1 of the JADE Encyclopaedia of Classes.

The subclasses of the JadeSkinControl class are summarized in the following table. For details, see Chapter 1 of the JADE Encyclopaedia of Classes.

Skins do not apply to the ActiveXControl, MultiMedia, and Ocx control classes, as these are totally drawn by the controls themselves.

JadeSkinBaseControl Class

The JadeSkinBaseControl class, a subclass of the JadeSkinControl class, holds the definition of a skin for subclasses of the BaseControl class.

JadeSkinBrowseButtons Class

The JadeSkinBrowseButtons class, a subclass of the JadeSkinControl class, holds the definition of a skin for BrowseButtons controls.

The properties defined in the JadeSkinBrowseButtons class are summarized in the following table.

If a button image is not supplied for a non-up state, the up image is used. For painting to be successful, the skin requires all of the up images to be supplied.

JadeSkinButton Class

The JadeSkinButton class, a subclass of the JadeSkinControl class, holds the definition of a skin for Button controls.

The properties defined in the JadeSkinButton class are summarized in the following table.

If the createRegionFromMask property is set to true, the JadeSkinWindow::myImageMask property is used to create a window region. If it is set to false (the default), the full rectangular button area is drawn using the skin. The region defined by the myImageMask property then applies only to mouse actions. For example, if the button is an unusual-shaped image on a background, the button displays only the rollover and click images when the mouse is positioned over that special area.

Each state can consist of up to eight border segments and an inner image, an inner image only, or no images (in which case the background color is used to fill the non-border area). These images are drawn inside any defined border area. If you do not define a specific state, the myButtonUp image is used.

The following diagram on the left is an example of a button with a raised three-dimensional effect and the diagram on the right is an example of a button with a sunken three-dimensional effect.

JadeSkinCheckBox Class

The JadeSkinCheckBox class, a subclass of the JadeSkinControl class, holds the definition of a skin for CheckBox controls. If the check box button image of the skin is higher than the check box control using that skin, the check box control is enlarged in height to display the entire button image.

The properties defined in the JadeSkinCheckBox class are summarized in the following table.

If you do not supply a specific state, the appropriate up image is used. If you do not supply the appropriate up image, the default check box image is drawn. For example, the following diagram is an example of a CheckBox control with the Control class borderStyle property set to BorderStyle_3DSunken and the Control class backBrush property set.

JadeSkinComboBox Class

The JadeSkinComboBox class, a subclass of the JadeSkinControl class, holds the definition of a skin for ComboBox controls.

The properties defined in the JadeSkinComboBox class are summarized in the following table.

When defining the skin for a ComboBox control, note the following points.

• A simple combo box is a text box followed by a list box covering the whole combo area.

• A spin box ignores any defined buttons for the combo box skin. The skin of the vertical scroll bar for the application is used to draw the spin box over the top of any defined border.

• When the combo box has a text box portion, the text box allows only a solid background color and does not successfully handle any defined brush.

• A combo box skin consists of a border definition and a button that is placed on the right side of the border area. The way in which it is painted depends on the defined border, as follows.

  • If the combo box skin has the JadeSkinControl class borderStyle property set to BorderStyle_UseImages, the button image is centered vertically and offset from the right-hand edge of the combo box by the value of the buttonRightOffset property, as shown in the following example.

    

  • If the combo box skin has the borderStyle property set to a value other than BorderStyle_UseImages, the button is drawn inside whatever border is defined (against right inner edge of the border and stretched vertically), as shown in the following example.

    

JadeSkinFolder Class

The JadeSkinFolder class, a subclass of the JadeSkinControl class, holds the definition of a skin for Folder controls.

The properties defined in the JadeSkinFolder class are summarized in the following table.

JadeSkinFrame Class

The JadeSkinFrame class, a subclass of the JadeSkinControl class, holds the definition of a skin for Frame controls.

JadeSkinGroupBox Class

The JadeSkinGroupBox class, a subclass of the JadeSkinControl class, holds the definition of a skin for GroupBox controls. As a group box control has no non-client area (border area) and the entire skin image is drawn in the client area, children may be positioned anywhere within that control and cover the drawn images.

The group box skin images are drawn over the entire control area. The drawing of the caption depends on whether the skin definition includes a skin label reference (myLabelSkin). If there is no skin label reference, the caption is drawn transparently over the skin image. If the skin references a label definition, that label skin is drawn on top of the group box skin image.

The label is sized so that there is a three-pixel gap from the border area of the label to the left, right, top, and bottom of the caption. The caption or the label is drawn at the position indicated by the captionPosition, captionPositionLeftOffset, and captionPositionTopOffset properties.

The constants provided by the JadeSkinGroupBox class are listed in the following table.

The properties defined in the JadeSkinGroupBox class are summarized in the following table.

The following diagram is an example of two group boxes. The example at the left has only the top and right border strips set.

JadeSkinJadeDockBase Class

The JadeSkinJadeDockBase class, a subclass of the JadeSkinControl class, is the abstract class that defines elements of a docking control skin. The properties defined in the JadeSkinJadeDockBase class are summarized in the following table.

The first example at the left of the following diagram shows an image drawn horizontally (by using the myHorizontalGripBar property) for the grip bar of a vertically aligned docking control, in which the grip bar is the two horizontal lines at the top of the diagram. The second example at the right of the following diagram shows an image drawn vertically (by using the myVerticalGripBar property) for the grip bar for a horizontally aligned docking control, in which the grip bar is the two vertical lines at the left of the diagram.

The JadeSkinJadeDockBase class provides the JadeSkinJadeDockBar control subclass and JadeSkinJadeDockContainer control subclass.

JadeSkinJadeDockBar Class

The JadeSkinJadeDockBar class, a subclass of the JadeSkinJadeDockBase class, holds the definition of a skin for JadeDockBar controls.

JadeSkinJadeDockContainer Class

The JadeSkinJadeDockContainer class, a subclass of the JadeSkinJadeDockBase class, holds the definition of a skin for JadeDockContainer controls.

JadeSkinJadeEditMask Class

The JadeSkinJadeEditMask class, a subclass of the JadeSkinControl class, holds the definition of a skin for JadeEditMask controls.

JadeSkinJadeMask Class

The JadeSkinJadeMask class, a subclass of the JadeSkinControl class, holds the definition of a skin for JadeMask controls and has the property summarized in the following table.

JadeSkinJadeRichText Class

The JadeSkinJadeRichText class, a subclass of the JadeSkinControl class, holds the definition of a skin for JadeRichText controls.

JadeSkinLabel Class

The JadeSkinLabel class, a subclass of the JadeSkinControl class, holds the definition of a skin for Label controls.

JadeSkinListBox Class

The JadeSkinListBox class, a subclass of the JadeSkinControl class, holds the definition of a skin for ListBox controls. The properties defined in the JadeSkinListBox class are summarized in the following table.

The following diagram shows an example of a ListBox class with a defined skin.

JadeSkinOleControl Class

The JadeSkinOleControl class, a subclass of the JadeSkinControl class, holds the definition of a skin for OleControl controls.

JadeSkinOptionButton Class

The JadeSkinOptionButton class, a subclass of the JadeSkinControl class, holds the definition of a skin for OptionButton controls. If the option button image of the skin is higher than the option button control using that skin, the option button control is enlarged in height to display the entire image. The properties defined in the JadeSkinOptionButton class are summarized in the following table.

If you do not supply a specific state, the appropriate up image is used. If you do not supply the appropriate up image, the default option button image is drawn.

JadeSkinPicture Class

The JadeSkinPicture class, a subclass of the JadeSkinControl class, holds the definition of a skin for Picture controls.

JadeSkinProgressBar Class

The JadeSkinProgressBar class, a subclass of the JadeSkinControl class, holds the definition of a skin for ProgressBar controls and has the property summarized in the following table.

JadeSkinScrollBar Class

The JadeSkinScrollBar class, a subclass of the JadeSkinControl class, is the abstract class that contains information common to vertical and horizontal scroll bars. The properties defined in the JadeSkinScrollBar class are summarized in the following table.

The JadeSkinScrollBar class provides the JadeSkinHScroll and JadeSkinVScroll control subclasses.

JadeSkinHScroll Class

The JadeSkinHScroll class, a subclass of the JadeSkinScrollBar class, holds the definition of a skin for HScroll subclasses of ScrollBar controls.

The properties defined in the JadeSkinHScroll class are summarized in the following table.

The height of the border area and the height of the myLeftButton.imgUp image determine the height of the scroll bar. For a scroll bar control, the image is stretched vertically to fit the area inside the borders, as shown in the example in the following diagram.

If you do not supply the image for a specific state, the appropriate up image is used. The default scroll button image is drawn if you do not supply the up image.

JadeSkinVScroll Class

The JadeSkinVScroll class, a subclass of the JadeSkinScrollBar class, holds the definition of a skin for VScroll subclasses of ScrollBar controls.

The properties defined in the JadeSkinVScroll class are summarized in the following table.

The width of the border area and the width of the myTopButton.imgUp image determine the width of the scroll bar. For a scroll bar control, the image is stretched horizontally to fit the area inside the borders.

If you do not supply the image for a specific state, the appropriate up image is used. The default scroll button image is drawn if you do not supply the up image.

JadeSkinSheet Class

The JadeSkinSheet class, a subclass of the JadeSkinControl class, holds the definition of a skin for Sheet controls. The following diagram shows an example of a sheet with a sunken three-dimensional effect.

For details about the JadeSkinSheet class property summarized in the following table, see Chapter 1 of the JADE Encyclopaedia of Classes.

JadeSkinStatusLine Class

The JadeSkinStatusLine class, a subclass of the JadeSkinControl class, holds the definition of a skin for StatusLine controls.

The following diagram shows an example of a skinned status line.

JadeSkinTable Class

The JadeSkinTable class, a subclass of the JadeSkinControl class, holds the definition of a skin for Table controls. The properties defined in the JadeSkinTable class are summarized in the following table.

The default value of Default_Color for these properties indicates that the table uses its normal color. The following diagram shows an example of the Table class with an applied skin.

JadeSkinTextBox Class

The JadeSkinTextBox class, a subclass of the JadeSkinControl class, holds the definition of a skin for TextBox controls.

VERSION 7.1.09  |  Copyright©2017  Jade Software Corporation Limited.  All rights reserved.