JadeSkinArea Class

Product Information > JADE Developer’s Reference > Chapter 9 - Using Skins to Enhance JADE Applications > JadeSkinArea Class

JadeSkinArea Class

The JadeSkinArea class, a subclass of the JadeSkinEntity class, defines the way in which a rectangular area is drawn.

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

Constant	Integer Value	Constant	Integer Value
BorderStyle_3DRaised	3	BorderStyle_3DSunken	2
BorderStyle_Images	4	BorderStyle_None	0
BorderStyle_Single	1

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

Property	Default Value	Description
backColor	Default_Color	Background color of the area if the inner image is not supplied or it is not a brush
imgBorderBottomLeft	Null	Optional bottom left of the area
imgBorderBottomRight	Null	Optional bottom right of the area
imgBorderBottomStrip	Null	Optional bottom strip of the area
imgBorderLeftStrip	Null	Optional left strip of the area
imgBorderRightStrip	Null	Optional right strip of the area
imgBorderTopLeft	Null	Optional top left of the area
imgBorderTopRight	Null	Optional top right of the area
imgBorderTopStrip	Null	Optional top strip of the area
imgInner	Null	Optional inner image for the area
innerIsBrush	True	Specifies whether the optional inner image is a brush for the entire area or a centered image (set to true by default)

The following diagram illustrates the layout of a skin, which is made up of eight border segments and an inner segment.

A JadeSkinArea is drawn as follows.

Segment 1

The top-left image (imgBorderTopLeft) is drawn at actual size. The top-left of the image is positioned at the top-left of the control.

The height drawn is usually the minimum of the top-left image height and the top-center strip height.

The exception is if the top-left image height is greater than the top-center strip height and the top-left image width is less than the left-center strip width. In that case, the top-left image height is used.

The top-left image can be higher than the top-center strip if the left-center strip is at least the same width.
Segment 2

The top-right image (imgBorderTopRight) is drawn at actual size. The top-right of the image is positioned at the top-right of the control.

The height drawn is usually the minimum of the top-right image height and the top-center strip height.

The exception is if the top-right image height is greater than the top-center strip height and the top-right image width is less than the right-center strip width. In that case, the top-right image height is used

The top-right image can be higher than the top-center strip if the right-center strip is at least the same width.
Segment 3

The top center strip (imgBorderTopStrip) is drawn at actual image height and stretched horizontally between the top-left and top-right images.
Segment 4

The bottom-left image (imgBorderBottomLeft) is drawn at actual size. The bottom-left of the image is positioned at the bottom-left of the control.

The height drawn is usually the minimum of the bottom-left image height and the bottom-center strip height.

The exception is if the bottom-left image height is greater than the bottom-center strip height and the bottom-left image width is less than the left-center strip width. In that case, the bottom-left image height is used.

This allows the bottom-left image to be higher than the bottom-center strip if the left-center strip is at least the same width.
Segment 5

The bottom-right image (imgBorderBottomRight) is drawn at actual size. The bottom-right of the image is positioned at the bottom-right of the control.

The height drawn is usually the minimum of the bottom-right image height and the bottom-center strip height.

The exception is if the bottom-right image height is greater than the bottom-center strip height and the bottom-right image width is less than the right-center strip width. In that case, the bottom-right image height is used.

This allows the bottom-right image to be higher that bottom-center strip if the right-center strip is at least the same width.
Segment 6

The bottom center strip (imgBorderBottomStrip) is drawn at actual image height and stretched horizontally between the bottom-left and bottom-right images.
Segment 7

The left-center strip (imgBorderLeftStrip) is drawn at actual image width and stretched vertically between the top-left and the bottom-left images.
Segment 8

The right-center strip (imgBorderRightStrip) is drawn at actual image width and stretched vertically between the top-right and the bottom-right images.
Segment 9

The center image (imgInner)is drawn stretched from the left-center image to the right-center image and from the top-center image to the bottom-center image. If there is no center image, it is filled with the background color specified for the skin.

Segments 3 and 6 determine the respective top and bottom heights of the border. Segments 7 and 8 determine the respective left and right widths of the border.

Unexpected results may occur if an image has a size that is inappropriate or does not correspond to a specific area.

A corner segment is drawn to its full height if the width is the same as the corresponding left or right strip. For example, segment 1 can be higher that segment 3, provided that segment 1 is the same width as segment 7. You can use this to achieve rounded border effects. For details, see "JadeSkinWindow Class", in the following section.

The following characteristics of the JadeSkinArea class are affected by additional subclass property values.

If optional border images (that is, areas 1 through 8 in the above diagram) are not present, the inner area of the skin is the entire area.
You can define the optional inner image by setting the value of the imgInner property to a brush that is repeatedly drawn over the entire inner area or an image that is drawn centered in the inner area.
A backColor property value is used only if the inner image (that is, the imgInner property) is not defined or it is not a brush.

For details, see Chapter 1 of the JADE Encyclopaedia of Classes.