Class GroupByHeaderMenuConfiguration

java.lang.Object
org.eclipse.nebula.widgets.nattable.config.AbstractUiBindingConfiguration
org.eclipse.nebula.widgets.nattable.extension.glazedlists.groupBy.GroupByHeaderMenuConfiguration
All Implemented Interfaces:
IConfiguration

public class GroupByHeaderMenuConfiguration extends AbstractUiBindingConfiguration
Configuration for adding a context menu to the groupBy header. By adding this configuration a popup menu is openend to perform an ungroup action when performing a right click on a groupBy indicator.
  • Field Details

    • UNGROUP_BY_MENU_ITEM_ID

      public static final String UNGROUP_BY_MENU_ITEM_ID
      See Also:
    • groupByHeaderLayer

      protected final GroupByHeaderLayer groupByHeaderLayer
      The GroupByHeaderLayer to which the menu should be attached.
      Since:
      2.1
    • groupByHeaderMenu

      protected org.eclipse.swt.widgets.Menu groupByHeaderMenu
      The groupBy header menu.
  • Constructor Details

    • GroupByHeaderMenuConfiguration

      public GroupByHeaderMenuConfiguration(NatTable natTable, GroupByHeaderLayer groupByHeaderLayer)
      Creates the groupBy header menu configuration to add a popup menu to the groupBy header.
      Parameters:
      natTable - The current NatTable instance.
      groupByHeaderLayer - The GroupByHeaderLayer to which the menu should be attached.
  • Method Details

    • configureUiBindings

      public void configureUiBindings(UiBindingRegistry uiBindingRegistry)
      Description copied from interface: IConfiguration
      Configure NatTable's UiBindingRegistry upon receiving this callback. A mechanism to customize key/mouse bindings.
      Parameters:
      uiBindingRegistry - The UiBindingRegistry instance to register ui bindings to.
    • createGroupByHeaderMenu

      protected PopupMenuBuilder createGroupByHeaderMenu(NatTable natTable)
      Creates the PopupMenuBuilder for the groupBy header menu with the menu items to ungroup.
      Parameters:
      natTable - The NatTable where the menu should be attached.
      Returns:
      The PopupMenuBuilder that is used to build the groupBy header menu.