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

Class LayerCommandUtil

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.LayerCommandUtil

public class LayerCommandUtil
extends Object

Helper class for converting coordinates. Does only support conversions down the layer stack, e.g. for transporting commands.

Method Summary

Modifier and Type	Method	Description
static ColumnPositionCoordinate	convertColumnPositionToTargetContext(ColumnPositionCoordinate columnPositionCoordinate, ILayer targetLayer)	Convert the given ColumnPositionCoordinate to the given target ILayer.
static ColumnPositionCoordinate	convertColumnPositionToTargetContext(ColumnPositionCoordinate columnPositionCoordinate, ILayer targetLayer, boolean acceptNegativePosition)	Convert the given ColumnPositionCoordinate to the given target ILayer.
static PositionCoordinate	convertPositionToTargetContext(PositionCoordinate positionCoordinate, ILayer targetLayer)	Convert the given PositionCoordinate to the given target ILayer.
static PositionCoordinate	convertPositionToTargetContext(PositionCoordinate positionCoordinate, ILayer targetLayer, boolean acceptNegativePosition)	Convert the given PositionCoordinate to the given target ILayer.
static RowPositionCoordinate	convertRowPositionToTargetContext(RowPositionCoordinate rowPositionCoordinate, ILayer targetLayer)	Convert the given RowPositionCoordinate to the given target ILayer.
static RowPositionCoordinate	convertRowPositionToTargetContext(RowPositionCoordinate rowPositionCoordinate, ILayer targetLayer, boolean acceptNegativePosition)	Convert the given RowPositionCoordinate to the given target ILayer.

Methods inherited from class java.lang.Object

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

Method Details

convertPositionToTargetContext

public static PositionCoordinate convertPositionToTargetContext(PositionCoordinate positionCoordinate,
 ILayer targetLayer)

Convert the given PositionCoordinate to the given target ILayer.

Parameters:

positionCoordinate - The PositionCoordinate that should be converted.

targetLayer - The ILayer to which the PositionCoordinate should be converted to.

Returns:

The converted PositionCoordinate or null if a conversion is not possible.

convertPositionToTargetContext

public static PositionCoordinate convertPositionToTargetContext(PositionCoordinate positionCoordinate,
 ILayer targetLayer,
 boolean acceptNegativePosition)

Convert the given PositionCoordinate to the given target ILayer.

Parameters:

positionCoordinate - The PositionCoordinate that should be converted.

targetLayer - The ILayer to which the PositionCoordinate should be converted to.

acceptNegativePosition - true if a negative position value should be accepted, false if not.

Note: Accepting a negative position value could cause serious issues as a negative position typically means the position does not exist. Only in cases where the ViewportLayer and spanning is involved a negative position could make sense as the position could be for example not visible at the moment.

Returns:

The converted PositionCoordinate or null if a conversion is not possible.

Since:

1.6

convertColumnPositionToTargetContext

public static ColumnPositionCoordinate convertColumnPositionToTargetContext(ColumnPositionCoordinate columnPositionCoordinate,
 ILayer targetLayer)

Convert the given ColumnPositionCoordinate to the given target ILayer.

Parameters:

columnPositionCoordinate - The ColumnPositionCoordinate that should be converted.

targetLayer - The ILayer to which the ColumnPositionCoordinate should be converted to.

Returns:

The converted ColumnPositionCoordinate or null if a conversion is not possible.

convertColumnPositionToTargetContext

public static ColumnPositionCoordinate convertColumnPositionToTargetContext(ColumnPositionCoordinate columnPositionCoordinate,
 ILayer targetLayer,
 boolean acceptNegativePosition)

Convert the given ColumnPositionCoordinate to the given target ILayer.

Parameters:

columnPositionCoordinate - The ColumnPositionCoordinate that should be converted.

targetLayer - The ILayer to which the ColumnPositionCoordinate should be converted to.

acceptNegativePosition - true if a negative column position should be accepted, false if not.

Note: Accepting a negative position could cause serious issues as a negative position typically means the position does not exist. Only in cases where the ViewportLayer and spanning is involved a negative position could make sense as the position could be for example not visible at the moment.

Returns:

The converted ColumnPositionCoordinate or null if a conversion is not possible.

Since:

1.6

convertRowPositionToTargetContext

public static RowPositionCoordinate convertRowPositionToTargetContext(RowPositionCoordinate rowPositionCoordinate,
 ILayer targetLayer)

Convert the given RowPositionCoordinate to the given target ILayer.

Parameters:

rowPositionCoordinate - The RowPositionCoordinate that should be converted.

targetLayer - The ILayer to which the RowPositionCoordinate should be converted to.

Returns:

The converted RowPositionCoordinate or null if a conversion is not possible.

convertRowPositionToTargetContext

public static RowPositionCoordinate convertRowPositionToTargetContext(RowPositionCoordinate rowPositionCoordinate,
 ILayer targetLayer,
 boolean acceptNegativePosition)

Convert the given RowPositionCoordinate to the given target ILayer.

Parameters:

rowPositionCoordinate - The RowPositionCoordinate that should be converted.

targetLayer - The ILayer to which the RowPositionCoordinate should be converted to.

acceptNegativePosition - true if a negative row position should be accepted, false if not.

Note: Accepting a negative position could cause serious issues as a negative position typically means the position does not exist. Only in cases where the ViewportLayer and spanning is involved a negative position could make sense as the position could be for example not visible at the moment.

Returns:

The converted RowPositionCoordinate or null if a conversion is not possible.

Since:

1.6