Package org.eclipse.nebula.widgets.nattable.hideshow.indicator

Class HierarchicalHideIndicatorOverlayPainter

java.lang.Object

org.eclipse.nebula.widgets.nattable.hideshow.indicator.HideIndicatorOverlayPainter

org.eclipse.nebula.widgets.nattable.hideshow.indicator.HierarchicalHideIndicatorOverlayPainter

All Implemented Interfaces:

IOverlayPainter, IOverlayPainter2

public class HierarchicalHideIndicatorOverlayPainter
extends HideIndicatorOverlayPainter

Specialization of the HideIndicatorOverlayPainter that renders the hide indicator in the level header columns of a HierarchicalTreeLayer. The identification of the level header columns is done via the cell label HierarchicalTreeLayer.LEVEL_HEADER_CELL.

Since:

1.6

Field Summary

Fields

Modifier and Type	Field	Description
protected HierarchicalTreeLayer	treeLayer

Fields inherited from class org.eclipse.nebula.widgets.nattable.hideshow.indicator.HideIndicatorOverlayPainter

columnHeaderLayer, configRegistry, rowHeaderLayer

Constructor Summary

Constructors

Constructor	Description
HierarchicalHideIndicatorOverlayPainter(ILayer columnHeaderLayer, HierarchicalTreeLayer treeLayer)	Creates a HierarchicalHideIndicatorOverlayPainter that renders the hide indicator in the given given column header layer and the HierarchicalTreeLayer level header columns.
HierarchicalHideIndicatorOverlayPainter(ILayer columnHeaderLayer, ILayer rowHeaderLayer, HierarchicalTreeLayer treeLayer)	Creates a HierarchicalHideIndicatorOverlayPainter that renders the hide indicator in the given header layers and the HierarchicalTreeLayer level header columns.

Method Summary

Modifier and Type	Method	Description
protected void	paintHiddenColumnIndicator(ILayer layer, org.eclipse.swt.graphics.GC gc, int xOffset, int yOffset, org.eclipse.swt.graphics.Rectangle rectangle)	Renders the indicator for hidden columns.
protected void	paintHiddenRowIndicator(ILayer layer, org.eclipse.swt.graphics.GC gc, int xOffset, int yOffset, org.eclipse.swt.graphics.Rectangle rectangle)	Renders the indicator for hidden rows.

Methods inherited from class org.eclipse.nebula.widgets.nattable.hideshow.indicator.HideIndicatorOverlayPainter

getIndicatorColor, getIndicatorLineWidth, paintOverlay, paintOverlay, setConfigRegistry, setIndicatorColor, setIndicatorLineWidth, setLayerOnTop, setLayerToLeft

Methods inherited from class java.lang.Object

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

Field Detail

treeLayer

protected HierarchicalTreeLayer treeLayer

Constructor Detail

HierarchicalHideIndicatorOverlayPainter

public HierarchicalHideIndicatorOverlayPainter(ILayer columnHeaderLayer,
                                               HierarchicalTreeLayer treeLayer)

Creates a HierarchicalHideIndicatorOverlayPainter that renders the hide indicator in the given given column header layer and the HierarchicalTreeLayer level header columns.

Parameters:

columnHeaderLayer - The layer in the column header that should be used to determine the height of the hidden column indicator. Should be the top most layer in the column header region, e.g. the FilterRowHeaderComposite in case filtering is included. Can be null to avoid rendering of hidden column indicators.

HierarchicalHideIndicatorOverlayPainter

public HierarchicalHideIndicatorOverlayPainter(ILayer columnHeaderLayer,
                                               ILayer rowHeaderLayer,
                                               HierarchicalTreeLayer treeLayer)

Creates a HierarchicalHideIndicatorOverlayPainter that renders the hide indicator in the given header layers and the HierarchicalTreeLayer level header columns.

Parameters:

columnHeaderLayer - The layer in the column header that should be used to determine the height of the hidden column indicator. Should be the top most layer in the column header region, e.g. the FilterRowHeaderComposite in case filtering is included. Can be null to avoid rendering of hidden column indicators.

rowHeaderLayer - The layer in the row header that should be used to determine the width of the hidden row indicator. Should be the top most layer in the row header region. Can be null to avoid rendering of hidden row indicators.

Method Detail

paintHiddenColumnIndicator

protected void paintHiddenColumnIndicator(ILayer layer,
                                          org.eclipse.swt.graphics.GC gc,
                                          int xOffset,
                                          int yOffset,
                                          org.eclipse.swt.graphics.Rectangle rectangle)

Description copied from class: HideIndicatorOverlayPainter

Renders the indicator for hidden columns. By default it renders only if a layer is provided as column header layer.

Overrides:

paintHiddenColumnIndicator in class HideIndicatorOverlayPainter

Parameters:

layer - The layer as base for the overlay rendering.

gc - The GC.

xOffset - The x offset.

yOffset - The y offset.

rectangle - The print bounds for the rendering action.

paintHiddenRowIndicator

protected void paintHiddenRowIndicator(ILayer layer,
                                       org.eclipse.swt.graphics.GC gc,
                                       int xOffset,
                                       int yOffset,
                                       org.eclipse.swt.graphics.Rectangle rectangle)

Description copied from class: HideIndicatorOverlayPainter

Renders the indicator for hidden rows. By default it renders only if a layer is provided as row header layer.

Overrides:

paintHiddenRowIndicator in class HideIndicatorOverlayPainter

Parameters:

layer - The layer as base for the overlay rendering.

gc - The GC.

xOffset - The x offset.

yOffset - The y offset.

rectangle - The print bounds for the rendering action.