< prev index next >

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

Print this page

        

@@ -50,10 +50,11 @@
  *
  * <p>To create a ComboBoxTableCell, it is necessary to provide 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 TableColumn.
  *
+ * @param <S> The type of the TableView generic type
  * @param <T> The type of the elements contained within the TableColumn.
  * @since JavaFX 2.2
  */
 public class ComboBoxTableCell<S,T> extends TableCell<S,T> {
 

@@ -67,10 +68,11 @@
      * Creates a ComboBox cell factory for use in {@link TableColumn} controls.
      * By default, the ComboBoxCell is rendered as a {@link Label} when not
      * being edited, and as a ComboBox when in editing mode. The ComboBox will,
      * by default, stretch to fill the entire list cell.
      *
+     * @param <S> The type of the TableView generic type
      * @param <T> The type of the elements contained within the TableColumn.
      * @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 TableColumn. Note that it is up to the developer to set
      *      {@link EventHandler event handlers} to listen to edit events in the

@@ -91,10 +93,11 @@
      * Creates a ComboBox cell factory for use in {@link TableColumn} controls.
      * By default, the ComboBoxCell is rendered as a {@link Label} when not
      * being edited, and as a ComboBox when in editing mode. The ComboBox will,
      * by default, stretch to fill the entire list cell.
      *
+     * @param <S> The type of the TableView generic type
      * @param <T> The type of the elements contained within the TableColumn.
      * @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

@@ -118,10 +121,11 @@
      * Creates a ComboBox cell factory for use in {@link TableColumn} controls.
      * By default, the ComboBoxCell is rendered as a {@link Label} when not
      * being edited, and as a ComboBox when in editing mode. The ComboBox will,
      * by default, stretch to fill the entire list cell.
      *
+     * @param <S> The type of the TableView generic type
      * @param <T> The type of the elements contained within the TableColumn.
      * @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 TableColumn. Note that it is up to the developer to set
      *      {@link EventHandler event handlers} to listen to edit events in the

@@ -141,10 +145,11 @@
      * Creates a ComboBox cell factory for use in {@link TableColumn} controls.
      * By default, the ComboBoxCell is rendered as a {@link Label} when not
      * being edited, and as a ComboBox when in editing mode. The ComboBox will,
      * by default, stretch to fill the entire list cell.
      *
+     * @param <S> The type of the TableView generic type
      * @param <T> The type of the elements contained within the TableColumn.
      * @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

@@ -260,24 +265,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();
     }
 

@@ -287,25 +295,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();
     }
 

@@ -316,11 +328,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 >