< prev index next >
modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldTreeTableCell.java
Print this page
@@ -33,17 +33,18 @@
import javafx.util.Callback;
import javafx.util.StringConverter;
import javafx.util.converter.DefaultStringConverter;
/**
- * A class containing a {@link TableCell} implementation that draws a
+ * A class containing a {@link javafx.scene.control.TableCell} implementation that draws a
* {@link TextField} node inside the cell.
*
- * <p>By default, the TextFieldTableCell is rendered as a {@link Label} when not
+ * <p>By default, the TextFieldTableCell is rendered as a {@link javafx.scene.control.Label} when not
* being edited, and as a TextField when in editing mode. The TextField will, by
* default, stretch to fill the entire table cell.
*
+ * @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 TextFieldTreeTableCell<S,T> extends TreeTableCell<S,T> {
@@ -58,10 +59,11 @@
* the cell is double-clicked, or when
* {@link javafx.scene.control.TreeTableView#edit(int, javafx.scene.control.TreeTableColumn)} is called.
* This method will only work on {@link TreeTableColumn} instances which are of
* type String.
*
+ * @param <S> The type of the TableView generic type
* @return A {@link Callback} that can be inserted into the
* {@link TreeTableColumn#cellFactoryProperty() cell factory property} of a
* TreeTableColumn, that enables textual editing of the content.
*/
public static <S> Callback<TreeTableColumn<S,String>, TreeTableCell<S,String>> forTreeTableColumn() {
@@ -76,10 +78,12 @@
* its generic type. However, to enable this, a {@link StringConverter} must
* be provided that will convert the given String (from what the user typed
* in) into an instance of type T. This item will then be passed along to the
* {@link TreeTableColumn#onEditCommitProperty()} callback.
*
+ * @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} that can convert the given String
* (from what the user typed in) into an instance of type T.
* @return A {@link Callback} that can be inserted into the
* {@link TreeTableColumn#cellFactoryProperty() cell factory property} of a
* TreeTableColumn, that enables textual editing of the content.
@@ -147,24 +151,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();
}
< prev index next >