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

Class DisplayModeMouseEventMatcher

java.lang.Object

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

All Implemented Interfaces:

IMouseEventMatcher

public class DisplayModeMouseEventMatcher
extends Object
implements IMouseEventMatcher

This class is used to check a mouse event against the DisplayMode of the cell at the mouse event's position. Optionally, the matcher can be chained with an additional IMouseEventMatcher (results are and'ed).

Constructor Summary

Constructors

Constructor and Description
DisplayModeMouseEventMatcher(String displayMode) Creates a DisplayModeMouseEventMatcher that checks only if the specified display mode matches.
DisplayModeMouseEventMatcher(String displayMode, IMouseEventMatcher aggregate) Creates a DisplayModeMouseEventMatcher that checks if the specified display mode matches and the aggregate matcher.

Method Summary

Modifier and Type	Method and Description
static DisplayModeMouseEventMatcher	displayMode(String displayMode)
static DisplayModeMouseEventMatcher	displayMode(String displayMode, IMouseEventMatcher aggregate)
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 java.lang.Object

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

Constructor Detail

DisplayModeMouseEventMatcher

public DisplayModeMouseEventMatcher(String displayMode)

Creates a DisplayModeMouseEventMatcher that checks only if the specified display mode matches.

Parameters:

displayMode - the DisplayMode to be matched.

DisplayModeMouseEventMatcher

public DisplayModeMouseEventMatcher(String displayMode,
                                    IMouseEventMatcher aggregate)

Creates a DisplayModeMouseEventMatcher that checks if the specified display mode matches and the aggregate matcher.

Parameters:

displayMode - the DisplayMode to be matched.

aggregate - (optional) an additional IMouseEventMatcher to be chained with the result of this matcher (results are and'ed).

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

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

displayMode

public static DisplayModeMouseEventMatcher displayMode(String displayMode,
                                                       IMouseEventMatcher aggregate)

Parameters:

displayMode - the DisplayMode to be matched.

aggregate - (optional) an additional IMouseEventMatcher to be chained with the result of this matcher (results are and'ed).

Returns:

a DisplayModeMouseEventMatcher that checks if the specified display mode matches and the aggregate matcher.

displayMode

public static DisplayModeMouseEventMatcher displayMode(String displayMode)

Parameters:

displayMode - the DisplayMode to be matched.

Returns:

a DisplayModeMouseEventMatcher that checks only if the specified display mode matches.