changeset 5558:17a35fcb4070

[DOC ONLY] RT-31685: Some Controls classes have empty javadoc.
author jgiles
date Tue, 29 Oct 2013 16:59:35 +1300
parents 584c05320426
children f66ed6275113
files modules/controls/src/main/java/javafx/scene/control/ColorPicker.java modules/controls/src/main/java/javafx/scene/control/CustomMenuItem.java modules/controls/src/main/java/javafx/scene/control/Menu.java modules/controls/src/main/java/javafx/scene/control/MenuButton.java modules/controls/src/main/java/javafx/scene/control/PasswordField.java modules/controls/src/main/java/javafx/scene/control/RadioMenuItem.java modules/controls/src/main/java/javafx/scene/control/SeparatorMenuItem.java modules/controls/src/main/java/javafx/scene/control/Slider.java modules/controls/src/main/java/javafx/scene/control/SplitPane.java modules/controls/src/main/java/javafx/scene/control/ToggleGroup.java
diffstat 10 files changed, 49 insertions(+), 22 deletions(-) [+]
line wrap: on
line diff
--- a/modules/controls/src/main/java/javafx/scene/control/ColorPicker.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/ColorPicker.java	Tue Oct 29 16:59:35 2013 +1300
@@ -115,7 +115,8 @@
         setValue(color);
         getStyleClass().add(DEFAULT_STYLE_CLASS);
     }
-    
+
+    /** {@inheritDoc} */
     @Override void valueInvalidated() {
         // do nothing - we dont want to fire action event when value changes.
     }
--- a/modules/controls/src/main/java/javafx/scene/control/CustomMenuItem.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/CustomMenuItem.java	Tue Oct 29 16:59:35 2013 +1300
@@ -74,7 +74,7 @@
      **************************************************************************/
     
     /**
-     * 
+     * Creates a default CustomMenuItem instance.
      */
     public CustomMenuItem() {
         this(null, true);
--- a/modules/controls/src/main/java/javafx/scene/control/Menu.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/Menu.java	Tue Oct 29 16:59:35 2013 +1300
@@ -84,7 +84,7 @@
 public class Menu extends MenuItem {
 
     /**
-     * <p>Called when the contentMenu for this menu <b>will</b> be shown. However if the
+     * <p>Called when the contextMenu for this menu <b>will</b> be shown. However if the
      * contextMenu is empty then this will not be called.
      * </p>
      */
@@ -92,7 +92,7 @@
             new EventType<Event>(Event.ANY, "MENU_ON_SHOWING");
 
     /**
-     * <p>Called when the contentMenu for this menu shows. However if the
+     * <p>Called when the contextMenu for this menu shows. However if the
      * contextMenu is empty then this will not be called.
      * </p>
      */
@@ -100,7 +100,7 @@
             new EventType<Event>(Event.ANY, "MENU_ON_SHOWN");
 
     /**
-     * <p>Called when the contentMenu for this menu <b>will</b> be hidden. However if the
+     * <p>Called when the contextMenu for this menu <b>will</b> be hidden. However if the
      * contextMenu is empty then this will not be called.
      * </p>
      */
@@ -108,7 +108,7 @@
             new EventType<Event>(Event.ANY, "MENU_ON_HIDING");
 
     /**
-     * <p>Called when the contentMenu for this menu is hidden. However if the
+     * <p>Called when the contextMenu for this menu is hidden. However if the
      * contextMenu is empty then this will not be called.
      * </p>
      */
@@ -221,12 +221,12 @@
 
 
     // --- On Showing
-    public final ObjectProperty<EventHandler<Event>> onShowingProperty() { return onShowing; }
     /**
      * Called just prior to the {@code ContextMenu} being shown, even if the menu has
      * no items to show. Note however that this won't be called if the menu does
      * not have a valid anchor node.
      */
+    public final ObjectProperty<EventHandler<Event>> onShowingProperty() { return onShowing; }
     public final void setOnShowing(EventHandler<Event> value) { onShowingProperty().set(value); }
     public final EventHandler<Event> getOnShowing() { return onShowingProperty().get(); }
     private ObjectProperty<EventHandler<Event>> onShowing = new ObjectPropertyBase<EventHandler<Event>>() {
@@ -247,10 +247,10 @@
 
 
     // -- On Shown
-    public final ObjectProperty<EventHandler<Event>> onShownProperty() { return onShown; }
     /**
      * Called just after the {@link ContextMenu} is shown.
      */
+    public final ObjectProperty<EventHandler<Event>> onShownProperty() { return onShown; }
     public final void setOnShown(EventHandler<Event> value) { onShownProperty().set(value); }
     public final EventHandler<Event> getOnShown() { return onShownProperty().get(); }
     private ObjectProperty<EventHandler<Event>> onShown = new ObjectPropertyBase<EventHandler<Event>>() {
@@ -271,10 +271,10 @@
 
 
     // --- On Hiding
-    public final ObjectProperty<EventHandler<Event>> onHidingProperty() { return onHiding; }
     /**
      * Called just prior to the {@link ContextMenu} being hidden.
      */
+    public final ObjectProperty<EventHandler<Event>> onHidingProperty() { return onHiding; }
     public final void setOnHiding(EventHandler<Event> value) { onHidingProperty().set(value); }
     public final EventHandler<Event> getOnHiding() { return onHidingProperty().get(); }
     private ObjectProperty<EventHandler<Event>> onHiding = new ObjectPropertyBase<EventHandler<Event>>() {
@@ -295,10 +295,10 @@
 
 
     // --- On Hidden
-    public final ObjectProperty<EventHandler<Event>> onHiddenProperty() { return onHidden; }
     /**
      * Called just after the {@link ContextMenu} has been hidden.
      */
+    public final ObjectProperty<EventHandler<Event>> onHiddenProperty() { return onHidden; }
     public final void setOnHidden(EventHandler<Event> value) { onHiddenProperty().set(value); }
     public final EventHandler<Event> getOnHidden() { return onHiddenProperty().get(); }
     private ObjectProperty<EventHandler<Event>> onHidden = new ObjectPropertyBase<EventHandler<Event>>() {
@@ -392,11 +392,13 @@
         }
         setShowing(false);
     }
-    
+
+    /** {@inheritDoc} */
     @Override public <E extends Event> void addEventHandler(EventType<E> eventType, EventHandler<E> eventHandler) {
         eventHandlerManager.addEventHandler(eventType, eventHandler);
     }
-    
+
+    /** {@inheritDoc} */
     @Override public <E extends Event> void removeEventHandler(EventType<E> eventType, EventHandler<E> eventHandler) {
         eventHandlerManager.removeEventHandler(eventType, eventHandler);
     }
--- a/modules/controls/src/main/java/javafx/scene/control/MenuButton.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/MenuButton.java	Tue Oct 29 16:59:35 2013 +1300
@@ -142,6 +142,9 @@
     }
 
     // --- Showing
+    /**
+     * Indicates whether the {@link ContextMenu} is currently visible.
+     */
     private ReadOnlyBooleanWrapper showing = new ReadOnlyBooleanWrapper(this, "showing", false) {
         @Override protected void invalidated() {
             pseudoClassStateChanged(PSEUDO_CLASS_SHOWING, get());
@@ -149,10 +152,7 @@
         }
     };
     private void setShowing(boolean value) { showing.set(value); }
-    /**
-     * Indicates whether the {@link ContextMenu} is currently visible.
-     */
-    public final boolean isShowing() { return showing.get(); }    
+    public final boolean isShowing() { return showing.get(); }
     public final ReadOnlyBooleanProperty showingProperty() { return showing.getReadOnlyProperty(); }
     
     
--- a/modules/controls/src/main/java/javafx/scene/control/PasswordField.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/PasswordField.java	Tue Oct 29 16:59:35 2013 +1300
@@ -30,6 +30,10 @@
  * @since JavaFX 2.0
  */
 public class PasswordField extends TextField {
+
+    /**
+     * Creates a default PasswordField instance.
+     */
     public PasswordField() {
         getStyleClass().add("password-field");
     }
@@ -43,16 +47,14 @@
     /**
      * Does nothing for PasswordField.
      */
-    @Override
-    public void cut() {
+    @Override public void cut() {
         // No-op
     }
 
     /**
      * Does nothing for PasswordField.
      */
-    @Override
-    public void copy() {
+    @Override public void copy() {
         // No-op
     }
 }
--- a/modules/controls/src/main/java/javafx/scene/control/RadioMenuItem.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/RadioMenuItem.java	Tue Oct 29 16:59:35 2013 +1300
@@ -133,6 +133,9 @@
      **************************************************************************/
     
     // --- Toggle Group
+    /**
+     * Represents the {@link ToggleGroup} that this RadioMenuItem belongs to.
+     */
     private ObjectProperty<ToggleGroup> toggleGroup;
     @Override public final void setToggleGroup(ToggleGroup value) {
         toggleGroupProperty().set(value);
--- a/modules/controls/src/main/java/javafx/scene/control/SeparatorMenuItem.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/SeparatorMenuItem.java	Tue Oct 29 16:59:35 2013 +1300
@@ -57,9 +57,9 @@
      * Constructors                                                            *
      *                                                                         *
      **************************************************************************/
-    
+
     /**
-     * 
+     * Creates a default SeparatorMenuItem instance.
      */
     public SeparatorMenuItem() {
         super(new Separator(Orientation.HORIZONTAL), false);
--- a/modules/controls/src/main/java/javafx/scene/control/Slider.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/Slider.java	Tue Oct 29 16:59:35 2013 +1300
@@ -98,6 +98,9 @@
  */
 public class Slider extends Control {
 
+    /**
+     * Creates a default Slider instance.
+     */
     public Slider() {
         initialize();
     }
--- a/modules/controls/src/main/java/javafx/scene/control/SplitPane.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/SplitPane.java	Tue Oct 29 16:59:35 2013 +1300
@@ -456,6 +456,14 @@
      * @since JavaFX 2.0
      */
     public static class Divider {
+
+        /**
+         * Creates a default Divider instance.
+         */
+        public Divider() {
+
+        }
+
         /**
          * <p>Represents the location where the divider should ideally be
          * positioned, between 0.0 and 1.0 (inclusive). 0.0 represents the
--- a/modules/controls/src/main/java/javafx/scene/control/ToggleGroup.java	Tue Oct 29 16:34:09 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/ToggleGroup.java	Tue Oct 29 16:59:35 2013 +1300
@@ -47,6 +47,14 @@
  * @since JavaFX 2.0
  */
 public class ToggleGroup {
+
+    /**
+     * Creates a default ToggleGroup instance.
+     */
+    public ToggleGroup() {
+
+    }
+
     /**
      * The list of toggles within the ToggleGroup.
      */