Package org.eclipse.nebula.widgets.nattable.fillhandle

Class FillHandleCompositeFreezeLayerPainter

java.lang.Object

org.eclipse.nebula.widgets.nattable.layer.CompositeLayer.CompositeLayerPainter

org.eclipse.nebula.widgets.nattable.painter.layer.CompositeFreezeLayerPainter

org.eclipse.nebula.widgets.nattable.fillhandle.FillHandleCompositeFreezeLayerPainter

All Implemented Interfaces:

FillHandleBoundsProvider, ILayerPainter

public class FillHandleCompositeFreezeLayerPainter
extends CompositeFreezeLayerPainter
implements FillHandleBoundsProvider

Specialization of the CompositeFreezeLayerPainter that retrieves the fill handle bounds from the separate paint calls and stores them locally.

Since:

2.5

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.swt.graphics.Rectangle	handleBounds	The bounds of the current visible selection handle or null if no fill handle is currently rendered.

Constructor Summary

Constructors

Constructor	Description
FillHandleCompositeFreezeLayerPainter(CompositeFreezeLayer compositeFreezeLayer)	Creates a FillHandleCompositeFreezeLayerPainter that can be set directly on a CompositeFreezeLayer.
FillHandleCompositeFreezeLayerPainter(CompositeLayer compositeLayer, CompositeFreezeLayer compositeFreezeLayer)	Creates a FillHandleCompositeFreezeLayerPainter that can be set on a CompositeLayer that contains a CompositeFreezeLayer.
FillHandleCompositeFreezeLayerPainter(CompositeLayer compositeLayer, CompositeFreezeLayer compositeFreezeLayer, boolean inspectComposite)	Creates a FillHandleCompositeFreezeLayerPainter that can be set on a CompositeLayer that contains a CompositeFreezeLayer.

Method Summary

Modifier and Type	Method	Description
protected BorderStyle	getHandleBorderStyle(IConfigRegistry configRegistry)	Returns the border style that should be used to render the border of the fill handle.
protected org.eclipse.swt.graphics.Color	getHandleColor(IConfigRegistry configRegistry)	Returns the color that should be used to render the fill handle.
org.eclipse.swt.graphics.Rectangle	getSelectionHandleBounds()
protected void	paintFillHandle(org.eclipse.swt.graphics.GC gc, IConfigRegistry configRegistry)	Paint the fill handle.
void	paintLayer(ILayer natLayer, org.eclipse.swt.graphics.GC gc, int xOffset, int yOffset, org.eclipse.swt.graphics.Rectangle rectangle, IConfigRegistry configRegistry)
protected void	processLayerPainterInformation(ILayerPainter painter)	Process the information stored in a ILayerPainter of a composite region.

Methods inherited from class org.eclipse.nebula.widgets.nattable.painter.layer.CompositeFreezeLayerPainter

addNestedHorizontalLayer, addNestedVerticalLayer, getFreezeX, getFreezeY, getHeight, getWidth

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.CompositeLayer.CompositeLayerPainter

adjustCellBounds

Methods inherited from class java.lang.Object

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

Field Details

handleBounds

protected org.eclipse.swt.graphics.Rectangle handleBounds

The bounds of the current visible selection handle or null if no fill handle is currently rendered.

Constructor Details

FillHandleCompositeFreezeLayerPainter

public FillHandleCompositeFreezeLayerPainter(CompositeFreezeLayer compositeFreezeLayer)

Creates a FillHandleCompositeFreezeLayerPainter that can be set directly on a CompositeFreezeLayer. This way the freeze border will be rendered only inside the CompositeFreezeLayer.

Parameters:

compositeFreezeLayer - The CompositeFreezeLayer for rendering the freeze border.

FillHandleCompositeFreezeLayerPainter

public FillHandleCompositeFreezeLayerPainter(CompositeLayer compositeLayer,
 CompositeFreezeLayer compositeFreezeLayer)

Creates a FillHandleCompositeFreezeLayerPainter that can be set on a CompositeLayer that contains a CompositeFreezeLayer. This way the freeze border will be rendered also on the adjacent regions. For this typically the given CompositeFreezeLayerPainter.compositeLayer is inspected and the freeze border is moved by the width/height of the first layers on top and to the left, as we do not know the needed offset values on the higher level composition.

Parameters:

compositeLayer - The top level CompositeLayer, e.g. a GridLayer.

compositeFreezeLayer - The CompositeFreezeLayer for rendering the freeze border.

FillHandleCompositeFreezeLayerPainter

public FillHandleCompositeFreezeLayerPainter(CompositeLayer compositeLayer,
 CompositeFreezeLayer compositeFreezeLayer,
 boolean inspectComposite)

Creates a FillHandleCompositeFreezeLayerPainter that can be set on a CompositeLayer that contains a CompositeFreezeLayer. This way the freeze border will be rendered also on the adjacent regions. For this typically the given CompositeFreezeLayerPainter.compositeLayer is inspected and the freeze border is moved by the width/height of the first layers on top and to the left, as we do not know the needed offset values on the higher level composition.

Note: Via the inspectComposite parameter the behavior in more complex layer compositions with nested CompositeLayer can be adjusted.

Parameters:

compositeLayer - The top level CompositeLayer, e.g. a GridLayer.

compositeFreezeLayer - The CompositeFreezeLayer for rendering the freeze border.

inspectComposite - true if the given CompositeFreezeLayerPainter.compositeLayer should be inspected for the position of the freeze border, false if not. Default is true. Remember to add nested layers to manually configure the freeze border shift when setting this value to false.

See Also:

• CompositeFreezeLayerPainter.addNestedVerticalLayer(ILayer)
• CompositeFreezeLayerPainter.addNestedHorizontalLayer(ILayer)

Method Details

paintLayer

public void paintLayer(ILayer natLayer,
 org.eclipse.swt.graphics.GC gc,
 int xOffset,
 int yOffset,
 org.eclipse.swt.graphics.Rectangle rectangle,
 IConfigRegistry configRegistry)

Specified by:

paintLayer in interface ILayerPainter

Overrides:

paintLayer in class CompositeFreezeLayerPainter

Parameters:

natLayer - The layer to paint.

gc - GC used for painting

xOffset - x offset of the layer from the origin of the table

yOffset - y offset of the layer from the origin of the table

rectangle - area the layer can paint in

configRegistry - IConfigRegistry in use by NatTable. Useful for looking up associated painters.

processLayerPainterInformation

protected void processLayerPainterInformation(ILayerPainter painter)

Description copied from class: CompositeLayer.CompositeLayerPainter

Process the information stored in a ILayerPainter of a composite region. Needed to avoid that the information is lost if the same painter is used in all regions, e.g. the FillHandleLayerPainter.

Overrides:

processLayerPainterInformation in class CompositeLayer.CompositeLayerPainter

Parameters:

painter - The ILayerPainter of a composite region.

paintFillHandle

protected void paintFillHandle(org.eclipse.swt.graphics.GC gc,
 IConfigRegistry configRegistry)

Paint the fill handle.

Parameters:

gc - The GC used for painting.

configRegistry - The IConfigRegistry to retrieve fill handle configurations.

getHandleColor

protected org.eclipse.swt.graphics.Color getHandleColor(IConfigRegistry configRegistry)

Returns the color that should be used to render the fill handle. If the IConfigRegistry is null or does not contain configurations for the color of the fill handle, a default dark green color is used.

Parameters:

configRegistry - The IConfigRegistry needed to determine the configured fill handle color. Can be null which results in returning a default dark green color.

Returns:

the color that should be used

getHandleBorderStyle

protected BorderStyle getHandleBorderStyle(IConfigRegistry configRegistry)

Returns the border style that should be used to render the border of the fill handle. If the IConfigRegistry is null or does not contain configurations for styling the border of the fill handle, a default style is used.

Parameters:

configRegistry - The IConfigRegistry needed to determine the configured fill handle border style. Can be null which results in returning a default style.

Returns:

the border style that should be used

getSelectionHandleBounds

public org.eclipse.swt.graphics.Rectangle getSelectionHandleBounds()

Specified by:

getSelectionHandleBounds in interface FillHandleBoundsProvider

Returns:

The bounds of the current visible selection handle or null if no fill handle is currently rendered.