Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

8270314: TreeTableCell: inconsistent naming for tableRow and tableColumn property methods #575

Closed
wants to merge 4 commits into from
Closed

8270314: TreeTableCell: inconsistent naming for tableRow and tableColumn property methods #575

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e34d6ff
8270314: TreeTableCell: inconsistent naming for tableRow and tableCol…
kevinrushforth Jul 13, 2021
759d889
Fix typo in javadoc comment
kevinrushforth Jul 15, 2021
5c519ed
Renamed updateTreeTable{Row,Column} to updateTable{Row,Column}
kevinrushforth Jul 16, 2021
ffb85ca
Added javadoc comments for new getTableCell method so we can add an @…
kevinrushforth Jul 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
64 changes: 43 additions & 21 deletions modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableCell.java
View file
Open in desktop
Expand Up @@ -712,39 +712,42 @@ private void updateItem(int oldIndex) {
**************************************************************************/

/**
* Updates the TreeTableView associated with this TreeTableCell. This is typically
* only done once when the TreeTableCell is first added to the TreeTableView.
*
* Updates the {@code TreeTableView} associated with this {@code TreeTableCell}.
* This is typically only done once when the {@code TreeTableCell} is first
* added to the {@code TreeTableView}.
* <p>
* Note: This function is intended to be used by experts, primarily
* by those implementing new Skins. It is not common
* for developers or designers to access this function directly.
* @param tv the TreeTableView associated with this TreeTableCell
* @param tv the {@code TreeTableView} associated with this {@code TreeTableCell}
*/
public final void updateTreeTableView(TreeTableView<S> tv) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes to the docs for this method were just formatting changes to match the corresponding changes to row and column methods (I did the same thing earlier for the property methods).

setTreeTableView(tv);
}

/**
* Updates the TreeTableRow associated with this TreeTableCell.
*
* Updates the {@code TreeTableRow} associated with this {@code TreeTableCell}.
* <p>
* Note: This function is intended to be used by experts, primarily
* by those implementing new Skins. It is not common
* for developers or designers to access this function directly.
* @param treeTableRow the TreeTableRow associated with this TreeTableCell
* @param row the {@code TreeTableRow} associated with this {@code TreeTableCell}
* @since 17
*/
public final void updateTreeTableRow(TreeTableRow<S> treeTableRow) {
this.setTableRow(treeTableRow);
public final void updateTableRow(TreeTableRow<S> row) {
this.setTableRow(row);
}

/**
* Updates the TreeTableColumn associated with this TreeTableCell.
*
* Updates the {@code TreeTableColumn} associated with this {@code TreeTableCell}.
* <p>
* Note: This function is intended to be used by experts, primarily
* by those implementing new Skins. It is not common
* for developers or designers to access this function directly.
* @param col the TreeTableColumn associated with this TreeTableCell
* @param column the {@code TreeTableColumn} associated with this {@code TreeTableCell}
* @since 17
*/
public final void updateTreeTableColumn(TreeTableColumn<S,T> col) {
public final void updateTableColumn(TreeTableColumn<S,T> column) {
// remove style class of existing tree table column, if it is non-null
TreeTableColumn<S,T> oldCol = getTableColumn();
if (oldCol != null) {
Expand All @@ -764,20 +767,39 @@ public final void updateTreeTableColumn(TreeTableColumn<S,T> col) {
}
}

setTableColumn(col);
setTableColumn(column);

if (col != null) {
getStyleClass().addAll(col.getStyleClass());
col.getStyleClass().addListener(weakColumnStyleClassListener);
if (column != null) {
getStyleClass().addAll(column.getStyleClass());
column.getStyleClass().addListener(weakColumnStyleClassListener);

col.idProperty().addListener(weakColumnIdListener);
col.styleProperty().addListener(weakColumnStyleListener);
column.idProperty().addListener(weakColumnIdListener);
column.styleProperty().addListener(weakColumnStyleListener);

possiblySetId(col.getId());
possiblySetStyle(col.getStyle());
possiblySetId(column.getId());
possiblySetStyle(column.getStyle());
}
}

// The following methods were misnamed and are deprecated in favor of the
// correctly named methods.
/**
* @deprecated Use {@link updateTableRow} instead.
* @param row the {@code TreeTableRow}
*/
@Deprecated(since = "17")
public final void updateTreeTableRow(TreeTableRow<S> row) {
updateTableRow(row);
}

/**
* @deprecated Use {@link updateTableColumn} instead.
* @param column the {@code TreeTableColumn}
*/
@Deprecated(since = "17")
public final void updateTreeTableColumn(TreeTableColumn<S,T> column) {
updateTableColumn(column);
}


/***************************************************************************
Expand Down
4 changes: 2 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableColumnHeader.java
View file
Open in desktop
Expand Up @@ -725,9 +725,9 @@ private <T,S> void resizeColumnToFitContent(TreeTableView<T> ttv, TreeTableColum
treeTableRow.updateIndex(row);
treeTableRow.updateTreeItem(ttv.getTreeItem(row));

cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.updateTreeTableView(ttv);
cell.updateTreeTableRow(treeTableRow);
cell.updateTableRow(treeTableRow);
cell.updateIndex(row);

if ((cell.getText() != null && !cell.getText().isEmpty()) || cell.getGraphic() != null) {
Expand Down
4 changes: 2 additions & 2 deletions modules/javafx.controls/src/main/java/javafx/scene/control/skin/TreeTableRowSkin.java
View file
Open in desktop
Expand Up @@ -265,7 +265,7 @@ public final DoubleProperty indentProperty() {
TreeTableColumn tableColumn = (TreeTableColumn<T,?>) tcb;
TreeTableCell cell = (TreeTableCell) tableColumn.getCellFactory().call(tableColumn);

cell.updateTreeTableColumn(tableColumn);
cell.updateTableColumn(tableColumn);
cell.updateTreeTableView(tableColumn.getTreeTableView());

return cell;
Expand Down Expand Up @@ -321,7 +321,7 @@ public final DoubleProperty indentProperty() {

/** {@inheritDoc} */
@Override protected void updateCell(TreeTableCell<T, ?> cell, TreeTableRow<T> row) {
cell.updateTreeTableRow(row);
cell.updateTableRow(row);
}

/** {@inheritDoc} */
Expand Down
2 changes: 1 addition & 1 deletion modules/javafx.controls/src/test/java/test/javafx/scene/control/CellTest.java
View file
Open in desktop
Expand Up @@ -92,7 +92,7 @@ public CellTest(Class type) {
} else if (cell instanceof TreeTableCell) {
TreeTableRow tableRow = new TreeTableRow();
CellShim.updateItem(tableRow, "TableRow", false);
((TreeTableCell)cell).updateTreeTableRow(tableRow);
((TreeTableCell)cell).updateTableRow(tableRow);
TreeTableCellShim.set_lockItemOnEdit((TreeTableCell)cell, true);
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...les/javafx.controls/src/test/java/test/javafx/scene/control/TreeTableCellEditingTest.java
View file
Open in desktop
Expand Up @@ -176,7 +176,7 @@ public void setup() {
editingColumn.setCellValueFactory(param -> null);
table.getColumns().add(editingColumn);
cell.updateTreeTableView(table);
cell.updateTreeTableColumn(editingColumn);
cell.updateTableColumn(editingColumn);
// make sure that focus change doesn't interfere with tests
// (editing cell loosing focus will be canceled from focusListener in Cell)
// Note: not really needed for Tree/TableCell because the cell is never focused
Expand Down
24 changes: 12 additions & 12 deletions modules/javafx.controls/src/test/java/test/javafx/scene/control/TreeTableCellTest.java
View file
Open in desktop
Expand Up @@ -151,7 +151,7 @@ public void cleanup() {

@Test public void treeItemIsNullWhenIndexIsOutOfRange() {
cell.updateIndex(50);
cell.updateTreeTableRow(row);
cell.updateTableRow(row);
cell.updateTreeTableView(tree);
assertNull(cell.getTableRow().getTreeItem());
}
Expand Down Expand Up @@ -506,7 +506,7 @@ public void cleanup() {

@Test public void checkTableRowProperty() {
cell.updateTreeTableView(tree);
cell.updateTreeTableRow(row);
cell.updateTableRow(row);
assertSame(row, cell.getTableRow());
assertSame(row, cell.tableRowProperty().get());
assertFalse(cell.tableRowProperty() instanceof ObjectProperty);
Expand All @@ -515,7 +515,7 @@ public void cleanup() {
@Test public void checkTableColumnProperty() {
TreeTableColumn<String, String> column = new TreeTableColumn<>();
cell.updateTreeTableView(tree);
cell.updateTreeTableColumn(column);
cell.updateTableColumn(column);
assertSame(column, cell.getTableColumn());
assertSame(column, cell.tableColumnProperty().get());
assertFalse(cell.tableColumnProperty() instanceof ObjectProperty);
Expand All @@ -533,7 +533,7 @@ public void cleanup() {
TreeTableColumn col = new TreeTableColumn("TEST");
col.setCellValueFactory(param -> null);
tree.getColumns().add(col);
cell.updateTreeTableColumn(col);
cell.updateTableColumn(col);
cell.updateTreeTableView(tree);

// set index to 0, which results in the cell value factory returning
Expand Down Expand Up @@ -688,8 +688,8 @@ public void testCellInUneditableRowIsNotEditable() {
treeTableColumn.setEditable(true);
tree.getColumns().add(treeTableColumn);

cell.updateTreeTableColumn(treeTableColumn);
cell.updateTreeTableRow(row);
cell.updateTableColumn(treeTableColumn);
cell.updateTableRow(row);
cell.updateTreeTableView(tree);

cell.updateIndex(0);
Expand All @@ -713,8 +713,8 @@ public void testCellInUneditableTableIsNotEditable() {
treeTableColumn.setEditable(true);
tree.getColumns().add(treeTableColumn);

cell.updateTreeTableColumn(treeTableColumn);
cell.updateTreeTableRow(row);
cell.updateTableColumn(treeTableColumn);
cell.updateTableRow(row);
cell.updateTreeTableView(tree);

cell.updateIndex(0);
Expand All @@ -738,8 +738,8 @@ public void testCellInUneditableColumnIsNotEditable() {
treeTableColumn.setEditable(false);
tree.getColumns().add(treeTableColumn);

cell.updateTreeTableColumn(treeTableColumn);
cell.updateTreeTableRow(row);
cell.updateTableColumn(treeTableColumn);
cell.updateTableRow(row);
cell.updateTreeTableView(tree);

cell.updateIndex(0);
Expand All @@ -759,7 +759,7 @@ private void setupForEditing() {
editingColumn.setCellValueFactory(cc -> new SimpleObjectProperty<>(""));

cell.updateTreeTableView(tree);
cell.updateTreeTableColumn(editingColumn);
cell.updateTableColumn(editingColumn);
}

@Test
Expand Down Expand Up @@ -893,7 +893,7 @@ public void testMisbehavingCancelEditTerminatesEdit() {
editingColumn.setCellValueFactory(param -> null);
tree.getColumns().add(editingColumn);
cell.updateTreeTableView(tree);
cell.updateTreeTableColumn(editingColumn);
cell.updateTableColumn(editingColumn);
// test editing: first round
// switch cell off editing by table api
int editingIndex = 1;
Expand Down
2 changes: 1 addition & 1 deletion ...vafx.controls/src/test/java/test/javafx/scene/control/cell/CheckBoxTreeTableCellTest.java
View file
Open in desktop
Expand Up @@ -69,7 +69,7 @@ public class CheckBoxTreeTableCellTest {

private void setTableViewAndTableColumn(TreeTableCell cell) {
cell.updateTreeTableView(tableView);
cell.updateTreeTableColumn(tableColumn);
cell.updateTableColumn(tableColumn);
}


Expand Down
14 changes: 7 additions & 7 deletions ...afx.controls/src/test/java/test/javafx/scene/control/cell/ChoiceBoxTreeTableCellTest.java
View file
Open in desktop
Expand Up @@ -294,7 +294,7 @@ public void test_startEdit_tableViewEditableIsTrue_tableColumnIsNull() {
tableView.setEditable(true);
ChoiceBoxTreeTableCell<Object,Object> cell = new ChoiceBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);

tableView.edit(0, tc);
assertFalse(cell.isEditing());
Expand All @@ -308,7 +308,7 @@ public void test_startEdit_tableViewEditableIsTrue_tableColumnIsNull() {
ChoiceBoxTreeTableCell<Object,Object> cell = new ChoiceBoxTreeTableCell<>();
cell.setEditable(true);
cell.updateTreeTableView(tableView);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);

tableView.edit(0, tc);
assertFalse(cell.isEditing());
Expand Down Expand Up @@ -353,7 +353,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ChoiceBoxTreeTableCell<Object,Object> cell = new ChoiceBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);

tableView.edit(0, tc);
assertTrue(cell.isEditing());
Expand All @@ -368,7 +368,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ChoiceBoxTreeTableCell<Object,Object> cell = new ChoiceBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.setEditable(true);

tableView.edit(0, tc);
Expand All @@ -385,7 +385,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ChoiceBoxTreeTableCell<Object,Object> cell = new ChoiceBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.setEditable(true);

tableView.edit(0, tc);
Expand All @@ -405,7 +405,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ChoiceBoxTreeTableCell<Object,Object> cell = new ChoiceBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.setEditable(true);

tableView.edit(0, tc);
Expand All @@ -425,7 +425,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ChoiceBoxTreeTableCell<Object,Object> cell = new ChoiceBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.setEditable(true);

tableView.edit(0, tc);
Expand Down
14 changes: 7 additions & 7 deletions ...vafx.controls/src/test/java/test/javafx/scene/control/cell/ComboBoxTreeTableCellTest.java
View file
Open in desktop
Expand Up @@ -317,7 +317,7 @@ public void test_startEdit_tableViewEditableIsTrue_tableColumnIsNull() {
tableView.setEditable(true);
ComboBoxTreeTableCell<Object,Object> cell = new ComboBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);

tableView.edit(0, tc);
assertFalse(cell.isEditing());
Expand All @@ -331,7 +331,7 @@ public void test_startEdit_tableViewEditableIsTrue_tableColumnIsNull() {
ComboBoxTreeTableCell<Object,Object> cell = new ComboBoxTreeTableCell<>();
cell.setEditable(true);
cell.updateTreeTableView(tableView);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);

tableView.edit(0, tc);
assertFalse(cell.isEditing());
Expand Down Expand Up @@ -376,7 +376,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ComboBoxTreeTableCell<Object,Object> cell = new ComboBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);

tableView.edit(0, tc);
assertTrue(cell.isEditing());
Expand All @@ -391,7 +391,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ComboBoxTreeTableCell<Object,Object> cell = new ComboBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.setEditable(true);

tableView.edit(0, tc);
Expand All @@ -408,7 +408,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ComboBoxTreeTableCell<Object,Object> cell = new ComboBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.setEditable(true);

tableView.edit(0, tc);
Expand All @@ -428,7 +428,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ComboBoxTreeTableCell<Object,Object> cell = new ComboBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.setEditable(true);

tableView.edit(0, tc);
Expand All @@ -448,7 +448,7 @@ public void test_startEdit_cellEditableIsTrue_tableViewIsNull_isNotEmpty() {
ComboBoxTreeTableCell<Object,Object> cell = new ComboBoxTreeTableCell<>();
cell.updateTreeTableView(tableView);
cell.updateIndex(0);
cell.updateTreeTableColumn(tc);
cell.updateTableColumn(tc);
cell.setEditable(true);

tableView.edit(0, tc);
Expand Down
2 changes: 1 addition & 1 deletion ...x.controls/src/test/java/test/javafx/scene/control/cell/ProgressBarTreeTableCellTest.java
View file
Open in desktop
Expand Up @@ -65,7 +65,7 @@ public class ProgressBarTreeTableCellTest {

private void setTableViewAndTreeTableColumn(TreeTableCell cell) {
cell.updateTreeTableView(tableView);
cell.updateTreeTableColumn(tableColumn);
cell.updateTableColumn(tableColumn);
}


Expand Down