javafx.scene.control

Class TitledPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.TitledPane

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

@DefaultProperty(value="content")
public class TitledPane
extends Labeled

A TitledPane is a panel with a title that can be opened and closed.

The panel in a TitledPane can be any Node such as UI controls or groups of nodes added to a layout container.

It is not recommended to set the MinHeight, PrefHeight, or MaxHeight for this control. Unexpected behavior will occur because the TitledPane's height changes when it is opened or closed.

Note that whilst TitledPane extends from Labeled, the inherited properties are used to manipulate the TitledPane header, not the content area itself. If the intent is to modify the content area, consider using a layout container such as StackPane and setting your actual content inside of that. You can then manipulate the StackPane to get the layout results you are after.

Example:

  TitledPane t1 = new TitledPane("T1", new Button("B1"));
 

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
BooleanProperty	animated The animated state of the TitledPane.
BooleanProperty	collapsible The collapsible state of the TitledPane.
ObjectProperty<Node>	content The content of the TitledPane.
BooleanProperty	expanded The expanded state of the TitledPane.

Properties inherited from class javafx.scene.control.Labeled

alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText

Properties inherited from class javafx.scene.control.Control

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Field Summary

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
TitledPane() Creates a new TitledPane with no title or content.
TitledPane(String title, Node content) Creates a new TitledPane with a title and content.

Method Summary

Modifier and Type	Method and Description
BooleanProperty	animatedProperty() The animated state of the TitledPane.
BooleanProperty	collapsibleProperty() The collapsible state of the TitledPane.
ObjectProperty<Node>	contentProperty() The content of the TitledPane.
protected Skin<?>	createDefaultSkin() Create a new instance of the default skin for this control.
void	executeAccessibleAction(AccessibleAction action, Object... parameters) This method is called by the assistive technology to request the action indicated by the argument should be executed.
BooleanProperty	expandedProperty() The expanded state of the TitledPane.
static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
Node	getContent() The content of the TitledPane.
Orientation	getContentBias() If wrapText is true, then contentBias will be HORIZONTAL, otherwise it is null.
List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
boolean	isAnimated() Returns the animated state of the TitledPane.
boolean	isCollapsible() Returns the collapsible state of the TitlePane.
boolean	isExpanded() Gets the value of the property expanded.
Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) * Accessibility handling * *
void	setAnimated(boolean value) Specifies how the TitledPane should open and close.
void	setCollapsible(boolean value) Specifies if the TitledPane can be collapsed.
void	setContent(Node value) The content of the TitlePane which can be any Node such as UI controls or groups of nodes added to a layout container.
void	setExpanded(boolean value) Sets the expanded state of the TitledPane.

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getContentDisplay, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, toString, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

content

public final ObjectProperty<Node> contentProperty

The content of the TitledPane.

Returns:

The content of the TitlePane.

expanded

public final BooleanProperty expandedProperty

The expanded state of the TitledPane.

See Also:

isExpanded(), setExpanded(boolean)

animated

public final BooleanProperty animatedProperty

The animated state of the TitledPane.

See Also:

isAnimated(), setAnimated(boolean)

collapsible

public final BooleanProperty collapsibleProperty

The collapsible state of the TitledPane.

See Also:

isCollapsible(), setCollapsible(boolean)

Constructor Detail

TitledPane

public TitledPane()

Creates a new TitledPane with no title or content.

TitledPane

public TitledPane(String title,
                  Node content)

Creates a new TitledPane with a title and content.

Parameters:

title - The title of the TitledPane.

content - The content of the TitledPane.

Method Detail

setContent

public final void setContent(Node value)

The content of the TitlePane which can be any Node such as UI controls or groups of nodes added to a layout container.

Parameters:

value - The content for this TitlePane.

getContent

public final Node getContent()

The content of the TitledPane. Null is returned when if there is no content.

Returns:

The content of this TitledPane.

contentProperty

public final ObjectProperty<Node> contentProperty()

The content of the TitledPane.

Returns:

The content of the TitlePane.

setExpanded

public final void setExpanded(boolean value)

Sets the expanded state of the TitledPane. The default is true.

isExpanded

public final boolean isExpanded()

Gets the value of the property expanded.

Property description:

The expanded state of the TitledPane.

expandedProperty

public final BooleanProperty expandedProperty()

The expanded state of the TitledPane.

See Also:

isExpanded(), setExpanded(boolean)

setAnimated

public final void setAnimated(boolean value)

Specifies how the TitledPane should open and close. The panel will be animated out when this value is set to true. The default is true.

isAnimated

public final boolean isAnimated()

Returns the animated state of the TitledPane.

Returns:

The animated state of the TitledPane.

animatedProperty

public final BooleanProperty animatedProperty()

The animated state of the TitledPane.

See Also:

isAnimated(), setAnimated(boolean)

setCollapsible

public final void setCollapsible(boolean value)

Specifies if the TitledPane can be collapsed. The default is true.

isCollapsible

public final boolean isCollapsible()

Returns the collapsible state of the TitlePane.

Returns:

The collapsible state of the TitledPane.

collapsibleProperty

public final BooleanProperty collapsibleProperty()

The collapsible state of the TitledPane.

See Also:

isCollapsible(), setCollapsible(boolean)

createDefaultSkin

protected Skin<?> createDefaultSkin()

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Overrides:

createDefaultSkin in class Control

Returns:

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

getClassCssMetaData

public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()

Returns:

The CssMetaData associated with this class, which may include the CssMetaData of its super classes.

Since:

JavaFX 8.0

getControlCssMetaData

public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class Labeled

Returns:

unmodifiable list of the controls css styleable properties

Since:

JavaFX 8.0

getContentBias

public Orientation getContentBias()

Description copied from class: Labeled

If wrapText is true, then contentBias will be HORIZONTAL, otherwise it is null.

Overrides:

getContentBias in class Labeled

Returns:

orientation of width/height dependency or null if there is none

See Also:

Node.isResizable(), Node.minWidth(double), Node.minHeight(double), Node.prefWidth(double), Node.prefHeight(double), Node.maxWidth(double), Node.maxHeight(double)

queryAccessibleAttribute

public Object queryAccessibleAttribute(AccessibleAttribute attribute,
                                       Object... parameters)

* Accessibility handling * *

Overrides:

queryAccessibleAttribute in class Control

Parameters:

attribute - the requested attribute

parameters - optional list of parameters

Returns:

the value for the requested attribute

See Also:

AccessibleAttribute

executeAccessibleAction

public void executeAccessibleAction(AccessibleAction action,
                                    Object... parameters)

Description copied from class: Node

This method is called by the assistive technology to request the action indicated by the argument should be executed.

This method is commonly overridden by subclasses to implement action that are required for a specific role.
If a particular action is not handled, the super class implementation must be called.

Overrides:

executeAccessibleAction in class Control

Parameters:

action - the action to execute

parameters - optional list of parameters

See Also:

AccessibleAction