Package org.eclipse.nebula.widgets.nattable.hover.command

Class HoverStylingByIndexCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand

org.eclipse.nebula.widgets.nattable.hover.command.HoverStylingByIndexCommand

All Implemented Interfaces:

ILayerCommand

public class HoverStylingByIndexCommand
extends AbstractContextFreeCommand

Command that is used to apply hover styling in a NatTable.

This command needs to know about the HoverLayer on which it is executed because there might be several HoverLayer involved in a grid composition and therefore the command might be consumed by the wrong HoverLayer if we wouldn't know about the layer to handle it.

Since:

2.1

See Also:

• HoverLayer
• HoverStylingByIndexCommandHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
	HoverStylingByIndexCommand(int columnIndex, int rowIndex, HoverLayer hoverLayer)
protected	HoverStylingByIndexCommand(HoverStylingByIndexCommand command)	Constructor used for cloning purposes.

Method Summary

Modifier and Type	Method	Description
HoverStylingByIndexCommand	cloneCommand()	Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.
int	getColumnIndex()
HoverLayer	getHoverLayer()
int	getRowIndex()

Methods inherited from class org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand

convertToTargetLayer

Methods inherited from class java.lang.Object

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

Constructor Details

HoverStylingByIndexCommand

public HoverStylingByIndexCommand(int columnIndex,
 int rowIndex,
 HoverLayer hoverLayer)

Parameters:

columnIndex - The column index of the cell to apply the hover styling.

rowIndex - The row index of the cell to apply the hover styling.

hoverLayer - The HoverLayer that should handle the command. Necessary to avoid that other HoverLayer instances in a grid composition handle and consume the command.

HoverStylingByIndexCommand

protected HoverStylingByIndexCommand(HoverStylingByIndexCommand command)

Constructor used for cloning purposes.

Parameters:

command - The command that should be used to create a new instance.

Method Details

cloneCommand

public HoverStylingByIndexCommand cloneCommand()

Description copied from interface: ILayerCommand

Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.

Specified by:

cloneCommand in interface ILayerCommand

Overrides:

cloneCommand in class AbstractContextFreeCommand

Returns:

a cloned instance of the command

See Also:

• GridLayer.doCommand(ILayerCommand)

getColumnIndex

public int getColumnIndex()

Returns:

The column index of the cell to apply the hover styling.

getRowIndex

public int getRowIndex()

Returns:

The row index of the cell to apply the hover styling.

getHoverLayer

public HoverLayer getHoverLayer()

Returns:

The HoverLayer that should handle the command.