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

Class CellPainterMouseEventMatcher

java.lang.Object

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

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

All Implemented Interfaces:

IMouseEventMatcher

Direct Known Subclasses:

ClearFilterIconMouseEventMatcher

public class CellPainterMouseEventMatcher
extends MouseEventMatcher

Matches a mouse click on an ICellPainter within a cell in a specified region.

Field Summary

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

LEFT_BUTTON, RIGHT_BUTTON

Constructor Summary

Constructors

Constructor	Description
CellPainterMouseEventMatcher(String regionName, int button, Class<? extends ICellPainter> targetCellPainterClass)	Creates a CellPainterMouseEventMatcher for a given region name, mouse button and a target cellPainter class.
CellPainterMouseEventMatcher(String regionName, int button, ICellPainter targetCellPainter)	Creates a CellPainterMouseEventMatcher for a given region name, mouse button and a specific target cellPainter instance.

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

Constructor Detail

CellPainterMouseEventMatcher

public CellPainterMouseEventMatcher(String regionName,
                                    int button,
                                    ICellPainter targetCellPainter)

Creates a CellPainterMouseEventMatcher for a given region name, mouse button and a specific target cellPainter instance. Can be used in case one single painter instance is registered that should be checked for.

Parameters:

regionName - The name of the region where this matcher should react on. Typically a GridRegion if a default grid is used. Can also be another value in case a custom region label is defined in a custom composition.

button - The mouse button this matcher should react on, e.g. MouseEventMatcher.LEFT_BUTTON and MouseEventMatcher.RIGHT_BUTTON

targetCellPainter - The ICellPainter instance that should be used for the check.

CellPainterMouseEventMatcher

public CellPainterMouseEventMatcher(String regionName,
                                    int button,
                                    Class<? extends ICellPainter> targetCellPainterClass)

Creates a CellPainterMouseEventMatcher for a given region name, mouse button and a target cellPainter class. Can be used in case every instance of a painter should be treated the same way, e.g. checkboxes.

Parameters:

regionName - The name of the region where this matcher should react on. Typically a GridRegion if a default grid is used. Can also be another value in case a custom region label is defined in a custom composition.

button - The mouse button this matcher should react on, e.g. MouseEventMatcher.LEFT_BUTTON and MouseEventMatcher.RIGHT_BUTTON

targetCellPainterClass - The concrete type of the ICellPainter that should be used for the check.

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