< prev index next >

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

Print this page 

        
@@ -129,10 +129,11 @@
      * finding a specific Node within the scene graph. While the id of a Node
      * should be unique within the scene graph, this uniqueness is not enforced.
      * This is analogous to the "id" attribute on an HTML element
      * (<a href="http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier">CSS ID Specification</a>).
      *
+     * @return the id property
      * @defaultValue null
      */
     public final StringProperty idProperty() { return bridge.idProperty(); }
 
     /**

@@ -399,10 +400,11 @@
      * computed minimum width.
      * <p>
      * Setting this value to the <code>USE_PREF_SIZE</code> flag will cause
      * <code>getMinWidth(forHeight)</code> to return the control's preferred width,
      * enabling applications to easily restrict the resizability of the control.
+     * @param value the minimum width
      */
     public final void setMinWidth(double value) { minWidthProperty().set(value); }
 
     /**
      * Property for overriding the control's computed minimum width.

@@ -414,10 +416,11 @@
      * computed minimum width.
      * <p>
      * Setting this value to the <code>USE_PREF_SIZE</code> flag will cause
      * <code>getMinWidth(forHeight)</code> to return the control's preferred width,
      * enabling applications to easily restrict the resizability of the control.
+     * @return the minimum width
      */
     public final double getMinWidth() { return minWidth == null ? USE_COMPUTED_SIZE : minWidth.get(); }
     public final DoubleProperty minWidthProperty() {
         if (minWidth == null) {
             minWidth = new DoublePropertyBase(USE_COMPUTED_SIZE) {

@@ -467,10 +470,11 @@
      * <p>
      * Setting this value to the <code>USE_PREF_SIZE</code> flag will cause
      * <code>getMinHeight(forWidth)</code> to return the control's preferred height,
      * enabling applications to easily restrict the resizability of the control.
      *
+     * @param value the minimum height
      */
     public final void setMinHeight(double value) { minHeightProperty().set(value); }
 
     /**
      * Property for overriding the control's computed minimum height.

@@ -483,10 +487,11 @@
      * <p>
      * Setting this value to the <code>USE_PREF_SIZE</code> flag will cause
      * <code>getMinHeight(forWidth)</code> to return the control's preferred height,
      * enabling applications to easily restrict the resizability of the control.
      *
+     * @return the minimum height
      */
     public final double getMinHeight() { return minHeight == null ? USE_COMPUTED_SIZE : minHeight.get(); }
     public final DoubleProperty minHeightProperty() {
         if (minHeight == null) {
             minHeight = new DoublePropertyBase(USE_COMPUTED_SIZE) {

@@ -540,10 +545,11 @@
      * doesn't meet the application's layout needs.
      * <p>
      * Defaults to the <code>USE_COMPUTED_SIZE</code> flag, which means that
      * <code>getPrefWidth(forHeight)</code> will return the control's internally
      * computed preferred width.
+     * @param value the preferred width
      */
     public final void setPrefWidth(double value) { prefWidthProperty().set(value); }
 
     /**
      * Property for overriding the control's computed preferred width.

@@ -551,10 +557,11 @@
      * doesn't meet the application's layout needs.
      * <p>
      * Defaults to the <code>USE_COMPUTED_SIZE</code> flag, which means that
      * <code>getPrefWidth(forHeight)</code> will return the control's internally
      * computed preferred width.
+     * @return the preferred width
      */
     public final double getPrefWidth() { return prefWidth == null ? USE_COMPUTED_SIZE : prefWidth.get(); }
     public final DoubleProperty prefWidthProperty() {
         if (prefWidth == null) {
             prefWidth = new DoublePropertyBase(USE_COMPUTED_SIZE) {

@@ -595,10 +602,11 @@
      * <p>
      * Defaults to the <code>USE_COMPUTED_SIZE</code> flag, which means that
      * <code>getPrefHeight(forWidth)</code> will return the control's internally
      * computed preferred width.
      *
+     * @param value the preferred height
      */
     public final void setPrefHeight(double value) { prefHeightProperty().set(value); }
 
     /**
      * Property for overriding the control's computed preferred height.

@@ -607,10 +615,11 @@
      * <p>
      * Defaults to the <code>USE_COMPUTED_SIZE</code> flag, which means that
      * <code>getPrefHeight(forWidth)</code> will return the control's internally
      * computed preferred width.
      *
+     * @return the preferred height
      */
     public final double getPrefHeight() { return prefHeight == null ? USE_COMPUTED_SIZE : prefHeight.get(); }
     public final DoubleProperty prefHeightProperty() {
         if (prefHeight == null) {
             prefHeight = new DoublePropertyBase(USE_COMPUTED_SIZE) {

@@ -672,10 +681,11 @@
      * computed maximum width.
      * <p>
      * Setting this value to the <code>USE_PREF_SIZE</code> flag will cause
      * <code>getMaxWidth(forHeight)</code> to return the control's preferred width,
      * enabling applications to easily restrict the resizability of the control.
+     * @param value the maximum width
      */
     public final void setMaxWidth(double value) { maxWidthProperty().set(value); }
 
     /**
      * Property for overriding the control's computed maximum width.

@@ -687,10 +697,11 @@
      * computed maximum width.
      * <p>
      * Setting this value to the <code>USE_PREF_SIZE</code> flag will cause
      * <code>getMaxWidth(forHeight)</code> to return the control's preferred width,
      * enabling applications to easily restrict the resizability of the control.
+     * @return the maximum width
      */
     public final double getMaxWidth() { return maxWidth == null ? USE_COMPUTED_SIZE : maxWidth.get(); }
     public final DoubleProperty maxWidthProperty() {
         if (maxWidth == null) {
             maxWidth = new DoublePropertyBase(USE_COMPUTED_SIZE) {

@@ -739,10 +750,11 @@
      * <p>
      * Setting this value to the <code>USE_PREF_SIZE</code> flag will cause
      * <code>getMaxHeight(forWidth)</code> to return the control's preferred height,
      * enabling applications to easily restrict the resizability of the control.
      *
+     * @param value the maximum height
      */
     public final void setMaxHeight(double value) { maxHeightProperty().set(value); }
 
     /**
      * Property for overriding the control's computed maximum height.

@@ -755,10 +767,11 @@
      * <p>
      * Setting this value to the <code>USE_PREF_SIZE</code> flag will cause
      * <code>getMaxHeight(forWidth)</code> to return the control's preferred height,
      * enabling applications to easily restrict the resizability of the control.
      *
+     * @return the maximum height
      */
     public final double getMaxHeight() { return maxHeight == null ? USE_COMPUTED_SIZE : maxHeight.get(); }
     public final DoubleProperty maxHeightProperty() {
         if (maxHeight == null) {
             maxHeight = new DoublePropertyBase(USE_COMPUTED_SIZE) {

@@ -1032,10 +1045,12 @@
     public List<CssMetaData<? extends Styleable, ?>> getCssMetaData() {
         return getClassCssMetaData();
     }
 
     /**
+     * @param pseudoClass the pseudo class
+     * @param active the active state
      * @see Node#pseudoClassStateChanged(javafx.css.PseudoClass, boolean)
      * @since JavaFX 8.0
      */
     public final void pseudoClassStateChanged(PseudoClass pseudoClass, boolean active) {
         bridge.pseudoClassStateChanged(pseudoClass, active);

@@ -1052,17 +1067,19 @@
     }
 
     /**
      * {@inheritDoc}
      *
-     * A PopupControl&apos;s styles are based on the popup &quot;owner&quot; which is the
+     * {@literal A PopupControl's styles are based on the popup "owner" which is the}
      * {@link javafx.stage.PopupWindow#getOwnerNode() ownerNode} or,
-     * if the ownerNode is not set, the root of the {@link javafx.stage.PopupWindow#getOwnerWindow() ownerWindow&apos;s}
+     * if the ownerNode is not set, the root of the
+     * {@link javafx.stage.PopupWindow#getOwnerWindow() ownerWindow's}
      * scene. If the popup has not been shown, both ownerNode and ownerWindow will be null and {@code null} will be returned.
      *
-     * Note that the PopupWindow&apos;s scene root is not returned because there is no way to guarantee that the
-     * PopupWindow&apos;s scene root would properly return the ownerNode or ownerWindow.
+     * {@literal Note that the PopupWindow's scene root is not returned because
+     * there is no way to guarantee that the PopupWindow's scene root would
+     * properly return the ownerNode or ownerWindow.}
      *
      * @return {@link javafx.stage.PopupWindow#getOwnerNode()}, {@link javafx.stage.PopupWindow#getOwnerWindow()},
      * or null.
      * @since JavaFX 8.0
      */

@@ -1091,10 +1108,11 @@
 
     /**
      * {@inheritDoc}
      * @since JavaFX 8.0
      */
+    @Override
     public final ObservableSet<PseudoClass> getPseudoClassStates() {
         return FXCollections.emptyObservableSet();
     }
 
     /** {@inheritDoc} */

@@ -1118,11 +1136,11 @@
 
         /**
          * Requests a layout pass to be performed before the next scene is
          * rendered. This is batched up asynchronously to happen once per
          * "pulse", or frame of animation.
-         * <p/>
+         * <p>
          * If this parent is either a layout root or unmanaged, then it will be
          * added directly to the scene's dirty layout list, otherwise requestLayout
          * will be invoked on its parent.
          */
         @Override public void requestLayout() {

@@ -1136,10 +1154,11 @@
             super.requestLayout();
         }
 
         /**
          * This method should be treated as final and should not be overridden by any subclasses of CSSBridge.
+         * @return the styleable parent
          */
         @Override
         public Styleable getStyleableParent() {
             return PopupControl.this.getStyleableParent();
         }



< prev index next >