< prev index next >

modules/javafx.controls/src/main/java/javafx/scene/control/DialogPane.java

Print this page

        

*** 464,473 **** --- 464,474 ---- * 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 {@link DialogPane} class * javadoc. + * @return the property representing the header area of the dialog pane */ public final ObjectProperty<Node> headerProperty() { return header; }
*** 488,504 **** --- 489,507 ---- * header text will not be displayed in a default DialogPane instance. * * <p>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 {@link DialogPane} class javadoc.</p> + * @param headerText the string to show in the dialog header area */ public final void setHeaderText(String headerText) { this.headerText.set(headerText); } /** * Returns the currently-set header text for this DialogPane. + * @return the currently-set header text for this DialogPane */ public final String getHeaderText() { return headerText.get(); }
*** 509,518 **** --- 512,522 ---- * header text will not be displayed in a default DialogPane instance. * * <p>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 {@link DialogPane} class javadoc.</p> + * @return the property representing the header text for the dialog pane */ public final StringProperty headerTextProperty() { return headerText; }
*** 553,562 **** --- 557,567 ---- this.content.setValue(content); } /** * Property representing the content area of the dialog. + * @return the property representing the content area of the dialog */ public final ObjectProperty<Node> contentProperty() { return content; }
*** 572,598 **** --- 577,606 ---- /** * Sets the string to show in the dialog content area. Note that the content text * is lower precedence than the {@link #contentProperty() 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. + * @param contentText the string to show in the dialog content area */ public final void setContentText(String contentText) { this.contentText.set(contentText); } /** * Returns the currently-set content text for this DialogPane. + * @return the currently-set content text for this DialogPane */ public final String getContentText() { return contentText.get(); } /** * A property representing the content text for the dialog pane. The content text * is lower precedence than the {@link #contentProperty() 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. + * @return the property representing the content text for the dialog pane */ public final StringProperty contentTextProperty() { return contentText; }
*** 624,649 **** --- 632,660 ---- /** * 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. + * @return the property that represents the dialog expandable content area */ public final ObjectProperty<Node> expandableContentProperty() { return expandableContentProperty; } /** * Returns the dialog expandable content node, if one is set, or null * otherwise. + * @return the dialog expandable content node */ public final Node getExpandableContent() { return expandableContentProperty.get(); } /** * Sets the dialog expandable content node, or null if no expandable content * needs to be shown. + * @param content the dialog expandable content node */ public final void setExpandableContent(Node content) { this.expandableContentProperty.set(content); }
*** 661,670 **** --- 672,682 ---- } }; /** * Represents whether the dialogPane is expanded. + * @return the property representing whether the dialogPane is expanded */ public final BooleanProperty expandedProperty() { return expandedProperty; }
*** 741,750 **** --- 753,763 ---- * {@link #createDetailsButton()} method). * </ol> * * <p>The default implementation of this method creates and returns a new * {@link ButtonBar} instance. + * @return the created button bar */ protected Node createButtonBar() { ButtonBar buttonBar = new ButtonBar(); buttonBar.setMaxWidth(Double.MAX_VALUE);
*** 792,801 **** --- 805,815 ---- * <li>If your button changes its visuals based on whether the dialog pane * is expanded or collapsed, you should add a listener to the * {@link #expandedProperty() expanded} property, so that you may update * the button visuals. * </ol> + * @return the created details button */ protected Node createDetailsButton() { final Hyperlink detailsButton = new Hyperlink(); final String moreText = ControlResources.getString("Dialog.detail.button.more"); //$NON-NLS-1$ final String lessText = ControlResources.getString("Dialog.detail.button.less"); //$NON-NLS-1$
< prev index next >