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

Class RowHideIndicatorEventMatcher

java.lang.Object

org.eclipse.nebula.widgets.nattable.ui.matcher.MouseEventMatcher

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

All Implemented Interfaces:

IMouseEventMatcher

public class RowHideIndicatorEventMatcher
extends MouseEventMatcher

MouseEventMatcher that checks for cell edges at row borders and for the existence of row hide indicator labels.

Since:

1.6

Field Summary

Fields

Modifier and Type	Field	Description
protected ILayer	rowHeaderLayer

Fields inherited from class org.eclipse.nebula.widgets.nattable.ui.matcher.MouseEventMatcher

LEFT_BUTTON, RIGHT_BUTTON

Constructor Summary

Constructors

Constructor	Description
RowHideIndicatorEventMatcher(int stateMask, String eventRegion, int button, ILayer rowHeaderLayer)

Method Summary

Modifier and Type	Method	Description
boolean	matches(NatTable natTable, org.eclipse.swt.events.MouseEvent event, LabelStack regionLabels)	Figures out if the mouse event occurred in the supplied region.

Methods inherited from class org.eclipse.nebula.widgets.nattable.ui.matcher.MouseEventMatcher

bodyLeftClick, bodyRightClick, columnGroupHeaderLeftClick, columnGroupHeaderRightClick, columnHeaderLeftClick, columnHeaderRightClick, equals, getButton, getEventRegion, getStateMask, hashCode, rowGroupHeaderLeftClick, rowGroupHeaderRightClick, rowHeaderLeftClick, rowHeaderRightClick

Methods inherited from class java.lang.Object

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

Field Detail

rowHeaderLayer

protected ILayer rowHeaderLayer

Constructor Detail

RowHideIndicatorEventMatcher

public RowHideIndicatorEventMatcher(int stateMask,
                                    String eventRegion,
                                    int button,
                                    ILayer rowHeaderLayer)

Parameters:

stateMask - The state of the keyboard modifier keys and mouse masks at the time the event was generated to match.

eventRegion - The region label of the region in which the event should be processed only. Typically GridRegion.COLUMN_HEADER.

button - The mouse button that should be pressed to match.

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

matches

public boolean matches(NatTable natTable,
                       org.eclipse.swt.events.MouseEvent event,
                       LabelStack regionLabels)

Description copied from interface: IMouseEventMatcher

Figures out if the mouse event occurred in the supplied region.

Specified by:

matches in interface IMouseEventMatcher

Overrides:

matches in class MouseEventMatcher

Parameters:

natTable - The NatTable on which the MouseEvent occured.

event - The SWT MouseEvent.

regionLabels - The LabelStack with the region labels of the MouseEvent coordinates.

Returns:

true if the MouseEvent matches this IMouseEventMatcher and should therefore be handled, false if not