Package org.eclipse.nebula.widgets.nattable.hideshow.indicator

Class HideIndicatorMenuConfiguration

java.lang.Object

org.eclipse.nebula.widgets.nattable.config.AbstractUiBindingConfiguration

org.eclipse.nebula.widgets.nattable.hideshow.indicator.HideIndicatorMenuConfiguration

All Implemented Interfaces:

IConfiguration

public class HideIndicatorMenuConfiguration
extends AbstractUiBindingConfiguration

Configuration that is used to register ui bindings for opening menus on right click on the cell edge of hidden columns and hidden rows.

Since:

1.6

Field Summary

Fields

Modifier and Type	Field	Description
protected ILayer	columnHeaderLayer	The layer in the column header that should be used to determine the height of the hidden column indicator.
protected org.eclipse.swt.widgets.Menu	columnHideIndicatorMenu	The menu for the hidden column indicator.
protected ILayer	rowHeaderLayer	The layer in the row header that should be used to determine the width of the hidden row indicator.
protected org.eclipse.swt.widgets.Menu	rowHideIndicatorMenu	The menu for the hidden row indicator.

Constructor Summary

Constructors

Constructor	Description
HideIndicatorMenuConfiguration(NatTable natTable, ILayer columnHeaderLayer, ILayer rowHeaderLayer)	Creates a menu configuration that attaches menus to the hidden row indicator and the hidden column indicator.

Method Summary

Modifier and Type	Method	Description
void	configureUiBindings(UiBindingRegistry uiBindingRegistry)	Configure NatTable's UiBindingRegistry upon receiving this callback.
protected PopupMenuBuilder	createColumnHeaderMenu(NatTable natTable)	Creates the PopupMenuBuilder for the column hide indicator menu with the menu items that should be added to the menu.
protected PopupMenuBuilder	createRowHeaderMenu(NatTable natTable)	Creates the PopupMenuBuilder for the row hide indicator menu with the menu items that should be added to the menu.

Methods inherited from class org.eclipse.nebula.widgets.nattable.config.AbstractUiBindingConfiguration

configureLayer, configureRegistry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

columnHeaderLayer

protected ILayer columnHeaderLayer

The layer in the column header that should be used to determine the height of the hidden column indicator. Should be the top most layer in the column header region, e.g. the FilterRowHeaderComposite in case filtering is included. Can be null which leads to label inspection of the table row the mouse cursor moves over.

rowHeaderLayer

protected ILayer rowHeaderLayer

The layer in the row header that should be used to determine the width of the hidden row indicator. Should be the top most layer in the row header region. Can be null which leads to label inspection of the table column the mouse cursor moves over.

columnHideIndicatorMenu

protected org.eclipse.swt.widgets.Menu columnHideIndicatorMenu

The menu for the hidden column indicator.

rowHideIndicatorMenu

protected org.eclipse.swt.widgets.Menu rowHideIndicatorMenu

The menu for the hidden row indicator.

Constructor Detail

HideIndicatorMenuConfiguration

public HideIndicatorMenuConfiguration(NatTable natTable,
                                      ILayer columnHeaderLayer,
                                      ILayer rowHeaderLayer)

Creates a menu configuration that attaches menus to the hidden row indicator and the hidden column indicator.

Parameters:

natTable - The NatTable instance to which the context menus should be added to.

columnHeaderLayer - The layer in the column header that should be used to determine the height of the hidden column indicator. Should be the top most layer in the column header region, e.g. the FilterRowHeaderComposite in case filtering is included. Can be null which leads to label inspection of the table row the mouse cursor moves over.

rowHeaderLayer - The layer in the row header that should be used to determine the width of the hidden row indicator. Should be the top most layer in the row header region. Can be null which leads to label inspection of the table column the mouse cursor moves over.

Method Detail

createColumnHeaderMenu

protected PopupMenuBuilder createColumnHeaderMenu(NatTable natTable)

Creates the PopupMenuBuilder for the column hide indicator menu with the menu items that should be added to the menu.

Parameters:

natTable - The NatTable where the menu should be attached.

Returns:

The PopupMenuBuilder that is used to build the column hide indicator menu.

createRowHeaderMenu

protected PopupMenuBuilder createRowHeaderMenu(NatTable natTable)

Creates the PopupMenuBuilder for the row hide indicator menu with the menu items that should be added to the menu.

Parameters:

natTable - The NatTable where the menu should be attached.

Returns:

The PopupMenuBuilder that is used to build the row hide indicator menu.

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.