< prev index next >
modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxTreeTableCell.java
Print this page
@@ -48,10 +48,11 @@
*
* <p>To create a ChoiceBoxTreeTableCell, it is necessary to provide zero or more
* items that will be shown to the user when the {@link ChoiceBox} menu is
* showing. These items must be of the same type as the TreeTableColumn.
*
+ * @param <S> The type of the TableView generic type
* @param <T> The type of the elements contained within the TreeTableColumn.
* @since JavaFX 8.0
*/
public class ChoiceBoxTreeTableCell<S,T> extends TreeTableCell<S,T> {
@@ -65,10 +66,11 @@
* Creates a ChoiceBox cell factory for use in {@link TreeTableColumn} controls.
* By default, the ChoiceBoxCell is rendered as a {@link Label} when not
* being edited, and as a ChoiceBox when in editing mode. The ChoiceBox 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 TreeTableColumn.
* @param items Zero or more items that will be shown to the user when the
* {@link ChoiceBox} menu is showing. These items must be of the same
* type as the TreeTableColumn. Note that it is up to the developer to set
* {@link EventHandler event handlers} to listen to edit events in the
@@ -88,10 +90,11 @@
* Creates a ChoiceBox cell factory for use in {@link TreeTableColumn} controls.
* By default, the ChoiceBoxCell is rendered as a {@link Label} when not
* being edited, and as a ChoiceBox when in editing mode. The ChoiceBox
* 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 TreeTableColumn.
* @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 ChoiceBox} menu is showing. These items must be of the same
@@ -115,10 +118,11 @@
* Creates a ChoiceBox cell factory for use in {@link TreeTableColumn} controls.
* By default, the ChoiceBoxCell is rendered as a {@link Label} when not
* being edited, and as a ChoiceBox when in editing mode. The ChoiceBox 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 TreeTableColumn.
* @param items Zero or more items that will be shown to the user when the
* {@link ChoiceBox} menu is showing. These items must be of the same
* type as the TreeTableColumn. Note that it is up to the developer to set
* {@link EventHandler event handlers} to listen to edit events in the
@@ -138,10 +142,11 @@
* Creates a ChoiceBox cell factory for use in {@link TreeTableColumn} controls.
* By default, the ChoiceBoxCell is rendered as a {@link Label} when not
* being edited, and as a ChoiceBox when in editing mode. The ChoiceBox 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 TreeTableColumn.
* @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 ChoiceBox} menu is showing. These items must be of the same
@@ -256,24 +261,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();
}
@@ -285,10 +293,11 @@
* *
**************************************************************************/
/**
* Returns the items to be displayed in the ChoiceBox when it is showing.
+ * @return the items to be displayed in the ChoiceBox when it is showing
*/
public ObservableList<T> getItems() {
return items;
}
< prev index next >