JavaFX 24 · javafx.scene.control.DialogPane · APIdia, the JavaDoc alternative

DialogPane should be considered to be the root node displayed within a Dialog instance. In this role, the DialogPane is responsible for the placement of headers, graphics, content, and buttons. The default implementation of DialogPane (that is, the DialogPane class itself) handles the layout via the normal layoutChildren() method. This method may be overridden by subclasses wishing to handle the layout in an alternative fashion).

In addition to the header and content properties, there exists header text and content text properties. The way the *Text properties work is that they are a lower precedence compared to the Node properties, but they are far more convenient for developers in the common case, as it is likely the case that a developer more often than not simply wants to set a string value into the header or content areas of the DialogPane.

It is important to understand the implications of setting non-null values in the header and headerText properties. The key points are as follows:

The header property takes precedence over the headerText property, so if both are set to non-null values, header will be used and headerText will be ignored.
If headerText is set to a non-null value, and a graphic has also been set, the default position for the graphic shifts from being located to the left of the content area to being to the right of the header text.
If header is set to a non-null value, and a graphic has also been set, the graphic is removed from its default position (to the left of the content area), and is not placed to the right of the custom header node. If the graphic is desired, it should be manually added in to the layout of the custom header node manually.

DialogPane operates on the concept of ButtonType. A ButtonType is a descriptor of a single button that should be represented visually in the DialogPane. Developers who create a DialogPane therefore must specify the button types that they want to display, and this is done via the getButtonTypes() method, which returns a modifiable ObservableList, which users can add to and remove from as desired.

The ButtonType class defines a number of pre-defined button types, such as ButtonType#OK and ButtonType#CANCEL. Many users of the JavaFX dialogs API will find that these pre-defined button types meet their needs, particularly due to their built-in support for default and cancel buttons, as well as the benefit of the strings being translated into all languages which JavaFX is translated to. For users that want to define their own ButtonType (most commonly to define a button with custom text), they may do so via the constructors available on the ButtonType class.

Developers will quickly find that the amount of configurability offered via the ButtonType class is minimal. This is intentional, but does not mean that developers can not modify the buttons created by the ButtonType that have been specified. To do this, developers simply call the lookupButton(ButtonType) method with the ButtonType (assuming it has already been set in the getButtonTypes() list. The returned Node is typically of type Button, but this depends on if the createButton(ButtonType) method has been overridden.

The DialogPane class offers a few methods that can be overridden by subclasses, to more easily enable custom functionality. These methods include the following:

These methods are documented, so please take note of the expectations placed on any developer who wishes to override these methods with their own functionality.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	DialogPane.StyleableProperties

Field Summary

Modifier and Type	Field and Description
private final Node	buttonBar
private final Map<ButtonType, Node>	buttonNodes
private final ObservableList<ButtonType>	buttons
private final ObjectProperty<Node>	content
private final Label	contentLabel
private final StringProperty	contentText
private Node	detailsButton
private Dialog<?>	dialog
private final ObjectProperty<Node>	expandableContentProperty
private final BooleanProperty	expandedProperty
private final StackPane	graphicContainer
private final ObjectProperty<Node>	graphicProperty
private final ObjectProperty<Node>	header
private final StringProperty	headerText
private final GridPane	headerTextPanel
private StyleableStringProperty	imageUrl
private double	oldHeight

Constructor Summary

Access	Constructor and Description
public	DialogPane() Creates a new DialogPane instance with a style class of 'dialog-pane'.

Method Summary

Modifier and Type	Method and Description
protected double	computeMinHeight(double the width that should be used if min height depends on it width) Overrides javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region.
protected double	computeMinWidth(double the height that should be used if min width depends on it height) Overrides javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region.
protected double	computePrefHeight(double the width that should be used if preferred height depends on it width) Overrides javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.
protected double	computePrefWidth(double the height that should be used if preferred width depends on it height) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height.
public final ObjectProperty<Node>	Returns: the property representing the content area of the dialog contentProperty() Property representing the content area of the dialog.
public final StringProperty	Returns: the property representing the content text for the dialog pane contentTextProperty() A property representing the content text for the dialog pane.
protected Node	Returns: A JavaFX `Node` that represents the given `ButtonType`, most commonly an instance of `Button`. createButton(ButtonType The `ButtonType` to create a button from. buttonType) This method can be overridden by subclasses to create a custom button that will subsequently inserted into the DialogPane button area (created via the `createButtonBar()` method, but mostly commonly it is an instance of `ButtonBar`.
protected Node	Returns: the created button bar createButtonBar() This method can be overridden by subclasses to provide the button bar.
pack-priv static Label	createContentLabel(String The text to display text) Creates a Label node that works well within a Dialog.
protected Node	Returns: the created details button createDetailsButton() This method can be overridden by subclasses to create a custom details button.
public final ObjectProperty<Node>	Returns: the property that represents the dialog expandable content area expandableContentProperty() A property that represents the dialog expandable content area.
public final BooleanProperty	Returns: the property representing whether the dialogPane is expanded expandedProperty() Represents whether the dialogPane is expanded.
private Node	getActualContent()
private Node	getActualGraphic()
private Node	getActualHeader()
public final ObservableList<ButtonType>	Returns: The `ObservableList` of `button types` available to the user. getButtonTypes() Observable list of button types used for the dialog button bar area (created via the `createButtonBar()` method).
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.layout.Region.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public final Node	Returns: dialog's content getContent() Returns the dialog content as a Node (even if it was set as a String using `setContentText(String)` - this was simply transformed into a `Node` (most probably a `Label`).
public final String	Returns: the currently-set content text for this DialogPane getContentText() Returns the currently-set content text for this DialogPane.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.layout.Region.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public final Node	Returns: the dialog expandable content node getExpandableContent() Returns the dialog expandable content node, if one is set, or null otherwise.
public final Node	getGraphic()
public final Node	Returns: the header of the dialog pane. getHeader() Node which acts as the dialog pane header.
public final String	Returns: the currently-set header text for this DialogPane getHeaderText() Returns the currently-set header text for this DialogPane.
public final ObjectProperty<Node>	Returns: An ObjectProperty wrapping the current graphic. graphicProperty() The dialog graphic, presented either in the header, if one is showing, or to the left of the `content`.
pack-priv boolean	hasExpandableContent()
pack-priv boolean	hasHeader()
public final ObjectProperty<Node>	Returns: the property representing the header area of the dialog pane headerProperty() Property representing the header area of the dialog pane.
public final StringProperty	Returns: the property representing the header text for the dialog pane headerTextProperty() A property representing the header text for the dialog pane.
private StyleableStringProperty	imageUrlProperty() The imageUrl property is set from CSS and then the graphic property is set from the invalidated method.
public final boolean	Returns: true if dialogPane is expanded. isExpanded() Returns whether or not the dialogPane is expanded.
private boolean	isTextHeader()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final Node	Returns: The Node used to represent the button type, as created by `createButton(ButtonType)`, and only if the button type is part of the `button types` list, otherwise null. lookupButton(ButtonType The `ButtonType` for which a Node representation is requested. buttonType) This method provides a way in which developers may retrieve the actual Node for a given `ButtonType` (assuming it is part of the `button types` list).
public final void	setContent(Node dialog's content content) Assign dialog content.
public final void	setContentText(String the string to show in the dialog content area contentText) Sets the string to show in the dialog content area.
pack-priv void	setDialog(Dialog<?> dialog)
public final void	setExpandableContent(Node the dialog expandable content node content) Sets the dialog expandable content node, or null if no expandable content needs to be shown.
public final void	setExpanded(boolean true if dialogPane should be expanded. value) Sets whether the dialogPane is expanded.
public final void	setGraphic(Node The new dialog graphic, or null if no graphic should be shown. graphic) Sets the dialog graphic, which will be displayed either in the header, if one is showing, or to the left of the `content`.
public final void	setHeader(Node The new header of the DialogPane. header) Assigns the dialog pane header.
public final void	setHeaderText(String the string to show in the dialog header area headerText) Sets the string to show in the dialog header area.
private void	updateButtons(ButtonBar buttonBar)
private void	updateContentArea()
private void	updateHeaderArea()

Inherited from javafx.scene.layout.Pane:: getChildren

Field Detail

buttonBar	back to summary
private final Node buttonBar

buttonNodes	back to summary
private final Map<ButtonType, Node> buttonNodes

buttons	back to summary
private final ObservableList<ButtonType> buttons

content	back to summary
private final ObjectProperty<Node> content

contentLabel	back to summary
private final Label contentLabel

contentText	back to summary
private final StringProperty contentText

detailsButton	back to summary
private Node detailsButton

dialog	back to summary
private Dialog<?> dialog

expandableContentProperty	back to summary
private final ObjectProperty<Node> expandableContentProperty

expandedProperty	back to summary
private final BooleanProperty expandedProperty

graphicContainer	back to summary
private final StackPane graphicContainer

graphicProperty	back to summary
private final ObjectProperty<Node> graphicProperty

header	back to summary
private final ObjectProperty<Node> header

headerText	back to summary
private final StringProperty headerText

headerTextPanel	back to summary
private final GridPane headerTextPanel

imageUrl	back to summary
private StyleableStringProperty imageUrl

oldHeight	back to summary
private double oldHeight

Constructor Detail

DialogPane	back to summary
public DialogPane() Creates a new DialogPane instance with a style class of 'dialog-pane'.

Method Detail

computeMinHeight	back to summary
protected double computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Doc from javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Parameters width:double Doc from javafx.scene.Parent.computeMinHeight. the width that should be used if min height depends on it Returns:double the computed minimum height for this region Annotations @Override

computeMinHeight

back to summary

protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Parameters

width:double

Doc from javafx.scene.Parent.computeMinHeight.

the width that should be used if min height depends on it

Returns:double

the computed minimum height for this region

Annotations

@Override

computeMinWidth	back to summary
protected double computeMinWidth(double height) Overrides javafx.scene.layout.Region.computeMinWidth. Doc from javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Parameters height:double Doc from javafx.scene.Parent.computeMinWidth. the height that should be used if min width depends on it Returns:double the computed minimum width of this region Annotations @Override

computeMinWidth

back to summary

protected double computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Doc from javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Parameters

height:double

Doc from javafx.scene.Parent.computeMinWidth.

the height that should be used if min width depends on it

Returns:double

the computed minimum width of this region

Annotations

@Override

computePrefHeight	back to summary
protected double computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. Doc from javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Parameters width:double Doc from javafx.scene.Parent.computePrefHeight. the width that should be used if preferred height depends on it Returns:double the computed preferred height for this region Annotations @Override

computePrefHeight

back to summary

protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Parameters

width:double

Doc from javafx.scene.Parent.computePrefHeight.

the width that should be used if preferred height depends on it

Returns:double

the computed preferred height for this region

Annotations

@Override

computePrefWidth	back to summary
protected double computePrefWidth(double height) Overrides javafx.scene.layout.Region.computePrefWidth. Doc from javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Parameters height:double Doc from javafx.scene.Parent.computePrefWidth. the height that should be used if preferred width depends on it Returns:double the computed preferred width for this region Annotations @Override

computePrefWidth

back to summary

protected double computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Parameters

height:double

Doc from javafx.scene.Parent.computePrefWidth.

the height that should be used if preferred width depends on it

Returns:double

the computed preferred width for this region

Annotations

@Override

contentProperty	back to summary
public final ObjectProperty<Node> contentProperty() Property representing the content area of the dialog. Returns:ObjectProperty<Node> the property representing the content area of the dialog

contentProperty

back to summary

public final ObjectProperty<Node> contentProperty()

Property representing the content area of the dialog.

Returns:ObjectProperty<Node>: the property representing the content area of the dialog

contentTextProperty back to summary

contentTextProperty	back to summary
public final StringProperty contentTextProperty() A property representing the content text for the dialog pane. The content text is lower precedence than the `content node`, meaning that if both the content node and the contentText properties are set, the content text will not be displayed in a default DialogPane instance. Returns:StringProperty the property representing the content text for the dialog pane

public final StringProperty contentTextProperty()

A property representing the content text for the dialog pane. The content text is lower precedence than the content node, meaning that if both the content node and the contentText properties are set, the content text will not be displayed in a default DialogPane instance.

Returns:StringProperty: the property representing the content text for the dialog pane

createButton back to summary

createButton	back to summary
protected Node createButton(ButtonType buttonType) This method can be overridden by subclasses to create a custom button that will subsequently inserted into the DialogPane button area (created via the `createButtonBar()` method, but mostly commonly it is an instance of `ButtonBar`. Parameters buttonType:ButtonType The `ButtonType` to create a button from. Returns:Node A JavaFX `Node` that represents the given `ButtonType`, most commonly an instance of `Button`.

protected Node createButton(ButtonType buttonType)

This method can be overridden by subclasses to create a custom button that will subsequently inserted into the DialogPane button area (created via the createButtonBar() method, but mostly commonly it is an instance of ButtonBar.

Parameters

buttonType:ButtonType: The ButtonType to create a button from.

Returns:Node

A JavaFX Node that represents the given ButtonType, most commonly an instance of Button.

createButtonBar back to summary

createButtonBar	back to summary
protected Node createButtonBar() This method can be overridden by subclasses to provide the button bar. Note that by overriding this method, the developer must take on multiple responsibilities: The developer must immediately iterate through all `button types` and call `createButton(ButtonType)` for each of them in turn. The developer must add a listener to the `button types` list, and when this list changes update the button bar as appropriate. Similarly, the developer must watch for changes to the `expandable content` property, adding and removing the details button (created via `createDetailsButton()` method). The default implementation of this method creates and returns a new `ButtonBar` instance. Returns:Node the created button bar

protected Node createButtonBar()

This method can be overridden by subclasses to provide the button bar. Note that by overriding this method, the developer must take on multiple responsibilities:

The developer must immediately iterate through all button types and call createButton(ButtonType) for each of them in turn.
The developer must add a listener to the button types list, and when this list changes update the button bar as appropriate.
Similarly, the developer must watch for changes to the expandable content property, adding and removing the details button (created via createDetailsButton() method).

The default implementation of this method creates and returns a new ButtonBar instance.

Returns:Node: the created button bar

createContentLabel	back to summary
pack-priv static Label createContentLabel(String text) Creates a Label node that works well within a Dialog. Parameters text:String The text to display

createContentLabel

back to summary

pack-priv static Label createContentLabel(String text)

Creates a Label node that works well within a Dialog.

Parameters

text:String: The text to display

createDetailsButton back to summary

createDetailsButton	back to summary
protected Node createDetailsButton() This method can be overridden by subclasses to create a custom details button. To override this method you must do two things: The button will need to have its own code set to handle mouse / keyboard interaction and to toggle the state of the `expanded` property. If your button changes its visuals based on whether the dialog pane is expanded or collapsed, you should add a listener to the `expanded` property, so that you may update the button visuals. Returns:Node the created details button

protected Node createDetailsButton()

This method can be overridden by subclasses to create a custom details button.

To override this method you must do two things:

The button will need to have its own code set to handle mouse / keyboard interaction and to toggle the state of the expanded property.
If your button changes its visuals based on whether the dialog pane is expanded or collapsed, you should add a listener to the expanded property, so that you may update the button visuals.

Returns:Node: the created details button

expandableContentProperty	back to summary
public final ObjectProperty<Node> expandableContentProperty() A property that represents the dialog expandable content area. Any Node can be placed in this area, but it will only be shown when the user clicks the 'Show Details' expandable button. This button will be added automatically when the expandable content property is non-null. Returns:ObjectProperty<Node> the property that represents the dialog expandable content area

expandableContentProperty

back to summary

public final ObjectProperty<Node> expandableContentProperty()

A property that represents the dialog expandable content area. Any Node can be placed in this area, but it will only be shown when the user clicks the 'Show Details' expandable button. This button will be added automatically when the expandable content property is non-null.

Returns:ObjectProperty<Node>: the property that represents the dialog expandable content area

expandedProperty	back to summary
public final BooleanProperty expandedProperty() Represents whether the dialogPane is expanded. Returns:BooleanProperty the property representing whether the dialogPane is expanded

expandedProperty

back to summary

public final BooleanProperty expandedProperty()

Represents whether the dialogPane is expanded.

Returns:BooleanProperty: the property representing whether the dialogPane is expanded

getActualContent	back to summary
private Node getActualContent()

getActualGraphic	back to summary
private Node getActualGraphic()

getActualHeader	back to summary
private Node getActualHeader()

getButtonTypes back to summary

getButtonTypes	back to summary
public final ObservableList<ButtonType> getButtonTypes() Observable list of button types used for the dialog button bar area (created via the `createButtonBar()` method). Modifying the contents of this list will immediately change the buttons displayed to the user within the dialog pane. Returns:ObservableList<ButtonType> The `ObservableList` of `button types` available to the user.

public final ObservableList<ButtonType> getButtonTypes()

Observable list of button types used for the dialog button bar area (created via the createButtonBar() method). Modifying the contents of this list will immediately change the buttons displayed to the user within the dialog pane.

Returns:ObservableList<ButtonType>: The ObservableList of button types available to the user.

getClassCssMetaData back to summary

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

Hides javafx.scene.layout.Region.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData

getContent back to summary

getContent	back to summary
public final Node getContent() Returns the dialog content as a Node (even if it was set as a String using `setContentText(String)` - this was simply transformed into a `Node` (most probably a `Label`). Returns:Node dialog's content

public final Node getContent()

Returns the dialog content as a Node (even if it was set as a String using setContentText(String) - this was simply transformed into a Node (most probably a Label).

Returns:Node: dialog's content

getContentText	back to summary
public final String getContentText() Returns the currently-set content text for this DialogPane. Returns:String the currently-set content text for this DialogPane

getContentText

back to summary

public final String getContentText()

Returns the currently-set content text for this DialogPane.

Returns:String: the currently-set content text for this DialogPane

getCssMetaData back to summary

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

Overrides javafx.scene.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.layout.Region.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Returns:List<CssMetaData<? extends Styleable, ?>>

Doc from javafx.scene.Node.getCssMetaData.

The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.

Annotations

@Override

getExpandableContent	back to summary
public final Node getExpandableContent() Returns the dialog expandable content node, if one is set, or null otherwise. Returns:Node the dialog expandable content node

getExpandableContent

back to summary

public final Node getExpandableContent()

Returns the dialog expandable content node, if one is set, or null otherwise.

Returns:Node: the dialog expandable content node

getGraphic	back to summary
public final Node getGraphic()

getHeader	back to summary
public final Node getHeader() Node which acts as the dialog pane header. Returns:Node the header of the dialog pane.

getHeader

back to summary

public final Node getHeader()

Node which acts as the dialog pane header.

Returns:Node: the header of the dialog pane.

getHeaderText	back to summary
public final String getHeaderText() Returns the currently-set header text for this DialogPane. Returns:String the currently-set header text for this DialogPane

getHeaderText

back to summary

public final String getHeaderText()

Returns the currently-set header text for this DialogPane.

Returns:String: the currently-set header text for this DialogPane

graphicProperty back to summary

graphicProperty	back to summary
public final ObjectProperty<Node> graphicProperty() The dialog graphic, presented either in the header, if one is showing, or to the left of the `content`. Returns:ObjectProperty<Node> An ObjectProperty wrapping the current graphic.

public final ObjectProperty<Node> graphicProperty()

The dialog graphic, presented either in the header, if one is showing, or to the left of the content.

Returns:ObjectProperty<Node>: An ObjectProperty wrapping the current graphic.

hasExpandableContent	back to summary
pack-priv boolean hasExpandableContent()

hasHeader	back to summary
pack-priv boolean hasHeader()

headerProperty back to summary

headerProperty	back to summary
public final ObjectProperty<Node> headerProperty() Property representing the header area of the dialog pane. Note that if this header is set to a non-null value, that it will take up the entire top area of the DialogPane. It will also result in the DialogPane switching its layout to the 'header' layout - as outlined in the `DialogPane` class javadoc. Returns:ObjectProperty<Node> the property representing the header area of the dialog pane

public final ObjectProperty<Node> headerProperty()

Property representing the header area of the dialog pane. Note that if this header is set to a non-null value, that it will take up the entire top area of the DialogPane. It will also result in the DialogPane switching its layout to the 'header' layout - as outlined in the DialogPane class javadoc.

Returns:ObjectProperty<Node>: the property representing the header area of the dialog pane

headerTextProperty back to summary

public final StringProperty headerTextProperty()

A property representing the header text for the dialog pane. The header text is lower precedence than the header node, meaning that if both the header node and the headerText properties are set, the header text will not be displayed in a default DialogPane instance.

When headerText is set to a non-null value, this will result in the DialogPane switching its layout to the 'header' layout - as outlined in the DialogPane class javadoc.

Returns:StringProperty: the property representing the header text for the dialog pane

imageUrlProperty	back to summary
private StyleableStringProperty imageUrlProperty() The imageUrl property is set from CSS and then the graphic property is set from the invalidated method. This ensures that the same image isn't reloaded.

isExpanded

back to summary

public final boolean isExpanded()

Returns whether or not the dialogPane is expanded.

Returns:boolean: true if dialogPane is expanded.

isTextHeader	back to summary
private boolean isTextHeader()

layoutChildren back to summary

protected void layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

Subclasses should override this function to layout content as needed.

Annotations

@Override

lookupButton back to summary

public final Node lookupButton(ButtonType buttonType)

This method provides a way in which developers may retrieve the actual Node for a given ButtonType (assuming it is part of the button types list).

Parameters

buttonType:ButtonType: The ButtonType for which a Node representation is requested.

Returns:Node

The Node used to represent the button type, as created by createButton(ButtonType), and only if the button type is part of the button types list, otherwise null.

setContent

back to summary

public final void setContent(Node content)

Assign dialog content. Any Node can be used

Parameters

content:Node: dialog's content

setContentText back to summary

public final void setContentText(String contentText)

Sets the string to show in the dialog content area. Note that the content text is lower precedence than the content node, meaning that if both the content node and the contentText properties are set, the content text will not be displayed in a default DialogPane instance.

Parameters

contentText:String: the string to show in the dialog content area

setDialog	back to summary
pack-priv void setDialog(Dialog<?> dialog)

setExpandableContent

back to summary

public final void setExpandableContent(Node content)

Sets the dialog expandable content node, or null if no expandable content needs to be shown.

Parameters

content:Node: the dialog expandable content node

setExpanded back to summary

public final void setExpanded(boolean value)

Sets whether the dialogPane is expanded. This only makes sense when there is expandable content to show.

Parameters

value:boolean: true if dialogPane should be expanded.

setGraphic back to summary

public final void setGraphic(Node graphic)

Sets the dialog graphic, which will be displayed either in the header, if one is showing, or to the left of the content.

Parameters

graphic:Node: The new dialog graphic, or null if no graphic should be shown.

setHeader

back to summary

public final void setHeader(Node header)

Assigns the dialog pane header. Any Node can be used.

Parameters

header:Node: The new header of the DialogPane.

setHeaderText back to summary

public final void setHeaderText(String headerText)

Sets the string to show in the dialog header area. Note that the header text is lower precedence than the header node, meaning that if both the header node and the headerText properties are set, the header text will not be displayed in a default DialogPane instance.

When headerText is set to a non-null value, this will result in the DialogPane switching its layout to the 'header' layout - as outlined in the DialogPane class javadoc.

Parameters

headerText:String: the string to show in the dialog header area

updateButtons	back to summary
private void updateButtons(ButtonBar buttonBar)

updateContentArea	back to summary
private void updateContentArea()

updateHeaderArea	back to summary
private void updateHeaderArea()

Modifier and Type	Field and Description
private static final CssMetaData<DialogPane, String>	GRAPHIC
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES

public Class DialogPane

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DialogPane.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail