TitleBarControl Book

• ITitleBarControl interface
• Understanding the MXMLTitleBar class

The TitleBarControl is a bar control that is used in many of our container components such as the TaskPaneFX, TaskListFX and WindowFX along with others. It provides a common interface for creating title headers that can be swapped at runtime with other title bars that implement the ITitleBarControl interface.

• See [ITitleBarControl interface] for more information.

Properties

The title bar contains the following essential elements;

• title - for textual representation of the parent.
• titleIcon - for graphic representation of the parent.
• iconButton - for reference to the titleIcon used for tooltips and menu creation.
  • The iconButton is the actual getter reference to the titleIcon. The titleIcon is a class setter.
• minimizeButton - to act as a device to minimize/restore the parent.
• maximizeButton - to act as a device to maximize/restore the parent.
• closeButton - to act as a device to dismis the parent.

The title bar also contains visual manipulation of these elements with;

• minimizeButtonRenderer - custom factory button rendering.
• maximizeButtonRenderer - custom factory button rendering.
• closeButtonRenderer - custom factory button rendering.
• showMinimizeButton - show/hide the button in the bar.
• showMaximizeButton - show/hide the button in the bar.
• showCloseButton - show/hide the button in the bar.

Styles

The TitleBarControl inherits it's border styles from the class BorderControl. All classes that are not Container decendents will subclass BorderControl. All styles availible in the Container class are also available in the BorderControl class. The title bar uses padding, alignment, border skins and colors and border metrics when it lays out it's border.

The title bar inherits it's layout functionality from the IconLabelControl. This class lays out the label and icon for ach bar control. The TitleBarControl class extends this by adding layout for the additional buttons and also accounts for horizontal and vertical barPlacement.

• See [Understanding the TitleBarControl layout].

The buttonsStyleName style will set the styleName for the three buttons in the control. If this style is not set with a pointer to a string CSSStyleDeclaration, the buttons inherit the control's styleName.

All normal gaps, padding and alignment apply depending on the barPlacement property of the control.

Note :: The FSCollectionFX1 includes enhanced gradient borders, buttons and highlights. All of these styles are included in the control for use in mxml.

• See FSCollectionFX1 Library product.

Events

dataChange event

The dataChange event is dispatched when the data property of the TitleBarControl changes. Remember, this control is set up as a renderer in the fact that is uses it's data property first, then will use it's public properties if the data property has not been set.

iconClick event

TODO

iconMouseDown event

TODO