Created
February 11, 2015 17:56
-
-
Save Roland09/d92829cdf5e5fee6fee9 to your computer and use it in GitHub Desktop.
This is an example about how you can customize the table menu button in a JavaFX TableView with node finding using a style class. It works without reflection.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import javafx.collections.ObservableList; | |
import javafx.event.EventHandler; | |
import javafx.geometry.Side; | |
import javafx.scene.Node; | |
import javafx.scene.control.CheckBox; | |
import javafx.scene.control.ContextMenu; | |
import javafx.scene.control.CustomMenuItem; | |
import javafx.scene.control.Label; | |
import javafx.scene.control.SeparatorMenuItem; | |
import javafx.scene.control.TableColumn; | |
import javafx.scene.control.TableView; | |
import javafx.scene.input.MouseEvent; | |
import com.sun.javafx.scene.control.skin.TableHeaderRow; | |
import com.sun.javafx.scene.control.skin.TableViewSkin; | |
public class TableUtils { | |
/** | |
* Make table menu button visible and replace the context menu with a custom context menu via reflection. | |
* The preferred height is modified so that an empty header row remains visible. This is needed in case you remove all columns, so that the menu button won't disappear with the row header. | |
* IMPORTANT: Modification is only possible AFTER the table has been made visible, otherwise you'd get a NullPointerException | |
* @param tableView | |
*/ | |
public static void addCustomTableMenu( TableView tableView) { | |
// enable table menu | |
tableView.setTableMenuButtonVisible(true); | |
// replace internal mouse listener with custom listener | |
setCustomContextMenu( tableView); | |
} | |
private static void setCustomContextMenu( TableView table) { | |
TableViewSkin<?> tableSkin = (TableViewSkin<?>) table.getSkin(); | |
// get all children of the skin | |
ObservableList<Node> children = tableSkin.getChildren(); | |
// find the TableHeaderRow child | |
for (int i = 0; i < children.size(); i++) { | |
Node node = children.get(i); | |
if (node instanceof TableHeaderRow) { | |
TableHeaderRow tableHeaderRow = (TableHeaderRow) node; | |
// setting the preferred height for the table header row | |
// if the preferred height isn't set, then the table header would disappear if there are no visible columns | |
// and with it the table menu button | |
// by setting the preferred height the header will always be visible | |
// note: this may need adjustments in case you have different heights in columns (eg when you use grouping) | |
double defaultHeight = tableHeaderRow.getHeight(); | |
tableHeaderRow.setPrefHeight(defaultHeight); | |
for( Node child: tableHeaderRow.getChildren()) { | |
// child identified as cornerRegion in TableHeaderRow.java | |
if( child.getStyleClass().contains( "show-hide-columns-button")) { | |
// get the context menu | |
ContextMenu columnPopupMenu = createContextMenu( table); | |
// replace mouse listener | |
child.setOnMousePressed(me -> { | |
// show a popupMenu which lists all columns | |
columnPopupMenu.show(child, Side.BOTTOM, 0, 0); | |
me.consume(); | |
}); | |
} | |
} | |
} | |
} | |
} | |
/** | |
* Create a menu with custom items. The important thing is that the menu remains open while you click on the menu items. | |
* @param cm | |
* @param table | |
*/ | |
private static ContextMenu createContextMenu( TableView table) { | |
ContextMenu cm = new ContextMenu(); | |
// create new context menu | |
CustomMenuItem cmi; | |
// select all item | |
Label showAll = new Label("Show all"); | |
showAll.addEventHandler(MouseEvent.MOUSE_CLICKED, new EventHandler<MouseEvent>() { | |
@Override | |
public void handle(MouseEvent event) { | |
for (Object obj : table.getColumns()) { | |
((TableColumn<?, ?>) obj).setVisible(true); | |
} | |
} | |
}); | |
cmi = new CustomMenuItem(showAll); | |
cmi.setHideOnClick(false); | |
cm.getItems().add(cmi); | |
// deselect all item | |
Label hideAll = new Label("Hide all"); | |
hideAll.addEventHandler(MouseEvent.MOUSE_CLICKED, new EventHandler<MouseEvent>() { | |
@Override | |
public void handle(MouseEvent event) { | |
for (Object obj : table.getColumns()) { | |
((TableColumn<?, ?>) obj).setVisible(false); | |
} | |
} | |
}); | |
cmi = new CustomMenuItem(hideAll); | |
cmi.setHideOnClick(false); | |
cm.getItems().add(cmi); | |
// separator | |
cm.getItems().add(new SeparatorMenuItem()); | |
// menu item for each of the available columns | |
for (Object obj : table.getColumns()) { | |
TableColumn<?, ?> tableColumn = (TableColumn<?, ?>) obj; | |
CheckBox cb = new CheckBox(tableColumn.getText()); | |
cb.selectedProperty().bindBidirectional(tableColumn.visibleProperty()); | |
cmi = new CustomMenuItem(cb); | |
cmi.setHideOnClick(false); | |
cm.getItems().add(cmi); | |
} | |
return cm; | |
} | |
} |
Hello Roland09 - I first found one first attempt in SO and now this - thank you for this great sample which helps me a lot!
Of course it works with
import javafx.scene.control.skin.TableHeaderRow;
import javafx.scene.control.skin.TableViewSkin;
(OpenFX 18).
Best, Elke
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uses com.sun.* classes. Is it possible to do it without those?