< prev index next >

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

Print this page

        

@@ -519,10 +519,11 @@
             updatePseudoClassState();
         };
 
         WeakReference<DialogPane> dialogPaneRef = new WeakReference<>(null);
 
+        @Override
         protected void invalidated() {
             DialogPane oldDialogPane = dialogPaneRef.get();
             if (oldDialogPane != null) {
                 // clean up
                 oldDialogPane.expandedProperty().removeListener(expandedListener);

@@ -572,27 +573,30 @@
     /**
      * A property representing the content text for the dialog pane. The content text
      * is lower precedence than the {@link DialogPane#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 getDialogPane().contentTextProperty();
     }
 
     /**
      * Returns the currently-set content text for this DialogPane.
+     * @return the currently-set content text for this DialogPane
      */
     public final String getContentText() {
         return getDialogPane().getContentText();
     }
 
     /**
      * Sets the string to show in the dialog content area. Note that the content text
      * is lower precedence than the {@link DialogPane#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) {
         getDialogPane().setContentText(contentText);
     }
 

@@ -601,27 +605,30 @@
     /**
      * A property representing the header text for the dialog pane. The header text
      * is lower precedence than the {@link DialogPane#headerProperty() 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.
+     * @return a property representing the header text for the dialog pane
      */
     public final StringProperty headerTextProperty() {
         return getDialogPane().headerTextProperty();
     }
 
     /**
      * Returns the currently-set header text for this DialogPane.
+     * @return the currently-set header text for this DialogPane
      */
     public final String getHeaderText() {
         return getDialogPane().getHeaderText();
     }
 
     /**
      * Sets the string to show in the dialog header area. Note that the header text
      * is lower precedence than the {@link DialogPane#headerProperty() 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.
+     * @param headerText the string to show in the dialog header area
      */
     public final void setHeaderText(String headerText) {
         getDialogPane().setHeaderText(headerText);
     }
 

@@ -664,10 +671,11 @@
      * A property representing what has been returned from the dialog. A result
      * is generated through the {@link #resultConverterProperty() result converter},
      * which is intended to convert from the {@link ButtonType} that the user
      * clicked on into a value of type R. Refer to the {@link Dialog} class
      * JavaDoc for more details.
+     * @return a property representing what has been returned from the dialog
      */
     public final ObjectProperty<R> resultProperty() {
         return resultProperty;
     }
 

@@ -692,10 +700,11 @@
      * result - that is a requirement of the dialog implementation by making use
      * of the result converter. In some cases, the result type of a Dialog
      * subclass is ButtonType (which means that the result converter can be null),
      * but in some cases (where the result type, R, is not ButtonType or Void),
      * this callback must be specified.
+     * @return the API to convert the {@link ButtonType} that the user clicked on
      */
     public final ObjectProperty<Callback<ButtonType, R>> resultConverterProperty() {
         return resultConverterProperty;
     }
 

@@ -709,10 +718,11 @@
 
 
     // --- showing
     /**
      * Represents whether the dialog is currently showing.
+     * @return the property representing whether the dialog is currently showing
      */
     public final ReadOnlyBooleanProperty showingProperty() {
         return dialog.showingProperty();
     }
 

@@ -727,10 +737,11 @@
 
 
     // --- resizable
     /**
      * Represents whether the dialog is resizable.
+     * @return the property representing whether the dialog is resizable
      */
     public final BooleanProperty resizableProperty() {
         return dialog.resizableProperty();
     }
 

@@ -756,70 +767,78 @@
 
 
     // --- width
     /**
      * Property representing the width of the dialog.
+     * @return the property representing the width of the dialog
      */
     public final ReadOnlyDoubleProperty widthProperty() {
         return dialog.widthProperty();
     }
 
     /**
      * Returns the width of the dialog.
+     * @return the width of the dialog
      */
     public final double getWidth() {
         return widthProperty().get();
     }
 
     /**
      * Sets the width of the dialog.
+     * @param width the width of the dialog
      */
     public final void setWidth(double width) {
         dialog.setWidth(width);
     }
 
 
     // --- height
     /**
      * Property representing the height of the dialog.
+     * @return the property representing the height of the dialog
      */
     public final ReadOnlyDoubleProperty heightProperty() {
         return dialog.heightProperty();
     }
 
     /**
      * Returns the height of the dialog.
+     * @return the height of the dialog
      */
     public final double getHeight() {
         return heightProperty().get();
     }
 
     /**
      * Sets the height of the dialog.
+     * @param height the height of the dialog
      */
     public final void setHeight(double height) {
         dialog.setHeight(height);
     }
 
 
     // --- title
     /**
      * Return the titleProperty of the dialog.
+     * @return the titleProperty of the dialog
      */
     public final StringProperty titleProperty(){
         return this.dialog.titleProperty();
     }
 
     /**
      * Return the title of the dialog.
+     * @return the title of the dialog
      */
     public final String getTitle(){
         return this.dialog.titleProperty().get();
     }
     /**
      * Change the Title of the dialog.
-     * @param title
+     * @param title the Title of the dialog
      */
     public final void setTitle(String title){
         this.dialog.titleProperty().set(title);
     }
 

@@ -834,10 +853,11 @@
     }
 
     /**
      * The horizontal location of this {@code Dialog}. Changing this attribute
      * will move the {@code Dialog} horizontally.
+     * @return the horizontal location of this {@code Dialog}
      */
     public final ReadOnlyDoubleProperty xProperty() {
         return dialog.xProperty();
     }
 

@@ -851,10 +871,11 @@
     }
 
     /**
      * The vertical location of this {@code Dialog}. Changing this attribute
      * will move the {@code Dialog} vertically.
+     * @return the vertical location of this {@code Dialog}
      */
     public final ReadOnlyDoubleProperty yProperty() {
         return dialog.yProperty();
     }
 
< prev index next >