A visual component that can be collapsed and expanded.
It is composed of a caption bar of type
BiCollapsiblePanelCaption and a content panel.
You can add any components that you want to the content panel.
The caption holds a title text of type
BiLabel and a collapse button of type
BiButton used to collapse and expand
the content panel area. Collapse and expand actions are animatied by a
If you anchor this component top/left/right/bottom it is important that you set its orientation state accordingly.
Depending on the orientation state the panel can collapse/expand vertically/horizontally and the collapse button
images will update accordingly to reflect collapse state and achoring.
This class extends
and therefore all methods and fields available for
are also available for
|Sets the title of the label in the caption|
|Sets the orientation of the component (see orientation property for detailed info)|
|The animator responsible for folding/unfolding|
|The position of the collapse button. Can be either "left" or "right. The default is right.|
|The caption container component|
|This will cause the text of the title label to be centered as opposed to being aligned to the left.|
|Add your own components here.|
|Whether the content panel is currently closed/folded or not.|
|Causes the content panel to be initially folded when the component is first created. The default is false.|
|Indicates the alignment of the caption which also sets the expand direction. Valid values are "north" (meant to expand downwards), "south" (meant to expand upwards), "east" (meant to expand to the right), "west" (meant to expand to the left). east/west therefore expands horizontally and north/south expands vertically.|
|Whether the caption bar should have visible background chrome or not.|
|Show or hide the collapse button|
|The duration of the animation. This is a convenience property that is delegated to
the animator. For more information see the speed property of
|Text of the caption label.|
|If the panel should collapse or not when the caption is clicked. The default is false.|
|This will close the content panel.|
|Opens/closes the content panel.|
|This will open the content panel.|
|The panel is about to close|
|The panel is about to open|
|The panel was closed|
|The panel was opened|
|Returns true if the expand direction is down or up for the panel, returns false if it is left or right.|
Requires you to include the animation package in the Adf. This component delegates some of its properties to child components.
This will close the content panel.
object.fold ( [ bQuickFold ] )
|Do not animate to folded state, just fold.|
Opens/closes the content panel.
object.toggleFolding ( )
This will open the content panel.
object.unfold ( )
Returns true if the expand direction is down or up for the panel, returns false if it is left or right.
BiCollapsiblePanel . getVerticalOrientation ( sOrientation )
|String with one of the values north/south/west/east|