Caption bar used by BiCollapsiblePanel. You don't typically create this component as it is created for you as part of BiCollapsiblePanel. You can however get hold of the BiCollapsiblePanelCaptionComponent from BiCollapsiblePanel and perform additional operations on it directly that might not be provided via the BiCollapsiblePanel interface.

This class extends BiComponent and therefore all methods and fields available for BiComponent are also available for BiCollapsiblePanelCaption .

Constructor

new BiCollapsiblePanelCaption ( [ sTitle [ ,sOrientation ] ] )

Parameters

NameTypeOptionalDefaultDescription
sTitleStringchecked"" Text displayed in the caption bar
sOrientationStringchecked"north""north", "south", "east", "west"

Properties

NameTypegetsetDescription
buttonOrientationStringcheckedcheckedThe position of the collapse button. Can be either "left" or "right. The default is right.
captionLabelBiLabelcheckedcheckedThe header text in the caption
centerTitleBooleancheckedcheckedThis will cause the text of the title label to be centered as opposed to being aligned to the left.
collapseButtonBiButtoncheckedThe button used to toggle the collapsed state of the BiCollapsiblePanel's contentPanel.
hideTitleBooleancheckedHides the caption title
orientationStringcheckedWhere inside the CollapsiblePanel the caption bar should be positioned. left/right/up/down. This property is normally handeled automatically by BiCollapsibelPanel.
showCaptionBackgroundBooleancheckedcheckedWhether the caption bar should have visible background chrome or not.
showCollapseButtonBooleancheckedcheckedShow or hide the collapse button
showCollapsedStateBooleancheckedcheckedSetting the collapsed state will apply the appropriate styles to buttons with regards to orientation etc.
titleStringcheckedcheckedText of the caption label.

Methods

None.

Events

None.

Static Methods

None.

Static Fields

None.

Enumerations

None.

Remarks

None.