< prev index next >
modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldTableCell.java
Print this page
@@ -38,10 +38,11 @@
*
* <p>By default, the TextFieldTableCell is rendered as a {@link 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 TableColumn.
* @since JavaFX 2.2
*/
public class TextFieldTableCell<S,T> extends TableCell<S,T> {
@@ -56,10 +57,11 @@
* the cell is double-clicked, or when
* {@link TableView#edit(int, javafx.scene.control.TableColumn)} is called.
* This method will only work on {@link TableColumn} 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 TableColumn#cellFactoryProperty() cell factory property} of a
* TableColumn, that enables textual editing of the content.
*/
public static <S> Callback<TableColumn<S,String>, TableCell<S,String>> forTableColumn() {
@@ -74,10 +76,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 TableColumn#onEditCommitProperty()} callback.
*
+ * @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} 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 TableColumn#cellFactoryProperty() cell factory property} of a
* TableColumn, that enables textual editing of the content.
@@ -145,24 +149,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 >