StatusLine Class

A status line control is a special frame control that aligns itself to the bottom and width of its container by default, providing a status line for the container.

Use the status line to display text that the user cannot directly change.

The status line has 3D effects by default. The status line text is always displayed within the area bounded by the 3D borders.

As the StatusLine class is a subclass of the Control class, it inherits all of the properties and methods defined in the Control and Window classes.

The status line is in effect a Frame control with the alignContainer property set to align to the bottom of the container. When the container is resized, the status line control is also resized. A StatusLine control that is aligned to their parent by using the alignContainer property will not scroll and it will remains in place in its parent when the scroll bar of the parent is shifted. It therefore remains visible and unchanged when the scroll bar of the parent is adjusted.

The status line has additional auto-size features beyond those of a label. Because the status line can also be a container, when controls are placed inside the status line, the control resizes in height to fit the controls placed inside it when the autoSize property is set to true. For example, multiple text boxes or labels could be inserted into the status line to display discrete pieces of information on the status line.

When the value of the StatusLine control autoSize property is true:

• If a child control left property value position is less than zero, the control is moved to be zero (0) when the parentAspect, relativeLeft, and relativeWidth property values of the child do not affect the horizontal position (not stretch horizontal, anchor right, and centered horizontal, and the relativeLeft and relativeWidth property values are false).

• If a child control is not fully visible horizontally, the child is right‑aligned in the status line control if it can be fully displayed or positioned at zero (0) if it cannot when the parentAspect, relativeLeft, and relativeWidth property values of the child do not affect the horizontal position (not stretch horizontal, anchor right, and centered horizontal, and the relativeLeft and relativeWidth property values are false).

• If a child control top position is less than zero (0), the control is moved to be zero when the parentAspect property value of the child does not affect the vertical position (not stretch vertical, anchor bottom, or centered vertical).

• If a child control is not fully visible vertically, the child is bottom‑aligned in the StatusLine control when the parentAspect property value of the child does not affect the vertical position (not stretch vertical, anchor bottom and centered vertically).

• The values of the relativeTop and relativeHeight properties of child controls are always set to false, as their functionality is not compatible with auto‑sizing the height of the StatusLine control (as has always been the case).

• All parentAspect flag values and relativeLeft and relativeWidth values are applied.

The height of the StatusLine control is then determined by analyzing the child control as follows, to determine the maximum height required. For a child control that does not have a fixed height and has the parentAspect property with the:

• ParentAspect_StretchBottom flag set, the height required is the top position, height, and parentBottomOffset property values of the child.

• ParentAspect_AnchorBottom flag set, the height required is the height and parentBottomOffset property values of the child; otherwise, the height of the child control.

For a summary of the constants, properties, methods, and events defined in the StatusLine class, see "StatusLine Class Constants", "StatusLine Properties", "StatusLine Methods", and "StatusLine Events", in the following subsections.

For details about docking status line controls, see the JadeDockBar, JadeDockBase, and JadeDockContainer classes, earlier in this document.