< prev index next >
modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableColumn.java
Print this page
@@ -66,11 +66,10 @@
* right-clicks the column header area
* <li>Have the contents of the table be sorted (using
* {@link #comparatorProperty() comparator}, {@link #sortable sortable} and
* {@link #sortTypeProperty() sortType})
* </ul>
- * </p>
*
* When creating a TreeTableColumn instance, perhaps the two most important properties
* to set are the column {@link #textProperty() text} (what to show in the column
* header area), and the column {@link #cellValueFactory cell value factory}
* (which is used to populate individual cells in the column). This can be
@@ -134,10 +133,13 @@
* *
**************************************************************************/
/**
* Parent event for any TreeTableColumn edit event.
+ * @param <S> the type of the TableView generic type
+ * @param <T> the type of the content in all cells in this TableColumn
+ * @return the edit event
*/
@SuppressWarnings("unchecked")
public static <S,T> EventType<TreeTableColumn.CellEditEvent<S,T>> editAnyEvent() {
return (EventType<TreeTableColumn.CellEditEvent<S,T>>) EDIT_ANY_EVENT;
}
@@ -147,10 +149,13 @@
/**
* Indicates that the user has performed some interaction to start an edit
* event, or alternatively the
* {@link TreeTableView#edit(int, javafx.scene.control.TreeTableColumn)}
* method has been called.
+ * @param <S> the type of the TableView generic type
+ * @param <T> the type of the content in all cells in this TableColumn
+ * @return the edit start event
*/
@SuppressWarnings("unchecked")
public static <S,T> EventType<TreeTableColumn.CellEditEvent<S,T>> editStartEvent() {
return (EventType<TreeTableColumn.CellEditEvent<S,T>>) EDIT_START_EVENT;
}
@@ -158,10 +163,13 @@
new EventType<>(editAnyEvent(), "EDIT_START");
/**
* Indicates that the editing has been canceled, meaning that no change should
* be made to the backing data source.
+ * @param <S> the type of the TableView generic type
+ * @param <T> the type of the content in all cells in this TableColumn
+ * @return the edit cancel event
*/
@SuppressWarnings("unchecked")
public static <S,T> EventType<TreeTableColumn.CellEditEvent<S,T>> editCancelEvent() {
return (EventType<TreeTableColumn.CellEditEvent<S,T>>) EDIT_CANCEL_EVENT;
}
@@ -170,10 +178,13 @@
/**
* Indicates that the editing has been committed by the user, meaning that
* a change should be made to the backing data source to reflect the new
* data.
+ * @param <S> the type of the TableView generic type
+ * @param <T> the type of the content in all cells in this TableColumn
+ * @return the edit commit event
*/
@SuppressWarnings("unchecked")
public static <S,T> EventType<TreeTableColumn.CellEditEvent<S,T>> editCommitEvent() {
return (EventType<TreeTableColumn.CellEditEvent<S,T>>) EDIT_COMMIT_EVENT;
}
@@ -689,24 +700,27 @@
this.value = value;
}
/**
* Returns the value passed in to the constructor.
+ * @return the value passed in to the constructor
*/
public TreeItem<S> getValue() {
return value;
}
/**
* Returns the {@link TreeTableColumn} passed in to the constructor.
+ * @return the {@link TreeTableColumn} passed in to the constructor
*/
public TreeTableColumn<S,T> getTreeTableColumn() {
return tableColumn;
}
/**
* Returns the {@link TableView} passed in to the constructor.
+ * @return the {@link TableView} passed in to the constructor
*/
public TreeTableView<S> getTreeTableView() {
return treeTableView;
}
}
@@ -811,10 +825,11 @@
/**
* Convenience method that returns the value for the row (that is, from
* the TableView {@link TableView#itemsProperty() items} list), for the
* row contained within the {@link TablePosition} returned in
* {@link #getTreeTablePosition()}.
+ * @return the row value
*/
public TreeItem<S> getRowValue() {
// List<S> items = getTreeTableView().getItems();
// if (items == null) return null;
< prev index next >