< prev index next >
modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxTreeCell.java
Print this page
@@ -68,11 +68,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 ChoiceBox} 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.
*/
@@ -114,11 +114,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 ChoiceBox} 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.
*/
@@ -252,24 +252,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();
}
@@ -281,10 +284,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 >