< prev index next >

modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxTreeCell.java

Print this page

        

@@ -70,11 +70,11 @@
      * default, stretch to fill the entire tree cell.
      *
      * @param <T> The type of the elements contained within the TreeView.
      * @param items Zero or more items that will be shown to the user when the
      *      {@link ComboBox} menu is showing. These items must be of the same
-     *      type as the TreeView<T>, such that upon selection, they replace the
+     *      type as the {@literal TreeView<T>}, such that upon selection, they replace the
      *      existing value in the TreeItem {@link TreeItem#valueProperty() value}
      *      property.
      * @return A {@link Callback} that will return a TreeCell that is able to
      *      work on the type of element contained within the TreeView.
      */

@@ -115,11 +115,11 @@
      * @param <T> The type of the elements contained within the TreeView.
      * @param converter A {@link StringConverter} to convert the given item (of
      *      type T) to a String for displaying to the user.
      * @param items Zero or more items that will be shown to the user when the
      *      {@link ComboBox} menu is showing. These items must be of the same
-     *      type as the TreeView<T>, such that upon selection, they replace the
+     *      type as the {@literal TreeView<T>}, such that upon selection, they replace the
      *      existing value in the TreeItem {@link TreeItem#valueProperty() value}
      *      property.
      * @return A {@link Callback} that will return a TreeCell that is able to
      *      work on the type of element contained within the TreeView.
      */

@@ -251,24 +251,27 @@
     private ObjectProperty<StringConverter<T>> converter =
             new SimpleObjectProperty<StringConverter<T>>(this, "converter");
 
     /**
      * The {@link StringConverter} property.
+     * @return the {@link StringConverter} property
      */
     public final ObjectProperty<StringConverter<T>> converterProperty() {
         return converter;
     }
 
     /**
      * Sets the {@link StringConverter} to be used in this cell.
+     * @param value the {@link StringConverter} to be used in this cell
      */
     public final void setConverter(StringConverter<T> value) {
         converterProperty().set(value);
     }
 
     /**
      * Returns the {@link StringConverter} used in this cell.
+     * @return the {@link StringConverter} used in this cell
      */
     public final StringConverter<T> getConverter() {
         return converterProperty().get();
     }
 

@@ -278,25 +281,29 @@
             new SimpleBooleanProperty(this, "comboBoxEditable");
 
     /**
      * A property representing whether the ComboBox, when shown to the user,
      * is editable or not.
+     * @return the property representing whether the ComboBox, when shown to the
+     * user, is editable or not
      */
     public final BooleanProperty comboBoxEditableProperty() {
         return comboBoxEditable;
     }
 
     /**
      * Configures the ComboBox to be editable (to allow user input outside of the
      * options provide in the dropdown list).
+     * @param value the editable value to be set for this ComboBox
      */
     public final void setComboBoxEditable(boolean value) {
         comboBoxEditableProperty().set(value);
     }
 
     /**
      * Returns true if the ComboBox is editable.
+     * @return true if the ComboBox is editable
      */
     public final boolean isComboBoxEditable() {
         return comboBoxEditableProperty().get();
     }
 

@@ -307,11 +314,12 @@
      * Public API                                                              *
      *                                                                         *
      **************************************************************************/
 
     /**
-     * Returns the items to be displayed in the ChoiceBox when it is showing.
+     * Returns the items to be displayed in the ComboBox when it is showing.
+     * @return the items to be displayed in this ComboBox when it is showing
      */
     public ObservableList<T> getItems() {
         return items;
     }
 
< prev index next >