Package org.eclipse.nebula.widgets.nattable.filterrow

Class FilterIconPainter

java.lang.Object

org.eclipse.nebula.widgets.nattable.painter.cell.AbstractCellPainter

org.eclipse.nebula.widgets.nattable.painter.cell.CellPainterWrapper

org.eclipse.nebula.widgets.nattable.painter.cell.BackgroundPainter

org.eclipse.nebula.widgets.nattable.painter.cell.ImagePainter

org.eclipse.nebula.widgets.nattable.filterrow.FilterIconPainter

All Implemented Interfaces:

ICellPainter

public class FilterIconPainter
extends ImagePainter

ImagePainter that is responsible for painting the icon into the filter row cells. It will handle 3 different icons, where two of them are mandatory:

• removeFilterImage (mandatory) - Image that is rendered if a filter is applied for that cell.
• comboImage (mandatory) - Image that is rendered if no filter is applied for that cell, but the filter cell editor is of type ComboBoxCellEditor.
• filterImage (optional) - Image that is rendered if no filter is applied for that cell.

Field Summary

Fields inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.ImagePainter

calculateByHeight, calculateByWidth

Constructor Summary

Constructors

Constructor	Description
FilterIconPainter()	Creates a FilterIconPainter that uses the default images for removeFilter and combo box icons.
FilterIconPainter(org.eclipse.swt.graphics.Image filterImage)	Creates a FilterIconPainter that uses the default images for removeFilter and combo box icons.
FilterIconPainter(org.eclipse.swt.graphics.Image filterImage, org.eclipse.swt.graphics.Image removeFilterImage, org.eclipse.swt.graphics.Image comboImage)	Creates a FilterIconPainter that uses the given images for the icons in the filter row cells.

Method Summary

Modifier and Type	Method	Description
protected org.eclipse.swt.graphics.Image	getImage(ILayerCell cell, IConfigRegistry configRegistry)

Methods inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.ImagePainter

getCellPainterAt, getPreferredHeight, getPreferredWidth, isCalculateByHeight, isCalculateByWidth, paintCell, setCalculateByHeight, setCalculateByWidth

Methods inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.BackgroundPainter

getBackgroundColour

Methods inherited from class org.eclipse.nebula.widgets.nattable.painter.cell.CellPainterWrapper

getWrappedPainter, getWrappedPainterBounds, setWrappedPainter

Methods inherited from class java.lang.Object

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

Constructor Details

FilterIconPainter

public FilterIconPainter()

Creates a FilterIconPainter that uses the default images for removeFilter and combo box icons. No image for indicating the filter row will be applied.

FilterIconPainter

public FilterIconPainter(org.eclipse.swt.graphics.Image filterImage)

Creates a FilterIconPainter that uses the default images for removeFilter and combo box icons. Will apply the given image for indicating the filter row to a user.

Parameters:

filterImage - Icon that will be rendered if no filter is applied for a cell in a filter row.

FilterIconPainter

public FilterIconPainter(org.eclipse.swt.graphics.Image filterImage,
 org.eclipse.swt.graphics.Image removeFilterImage,
 org.eclipse.swt.graphics.Image comboImage)

Creates a FilterIconPainter that uses the given images for the icons in the filter row cells.

Parameters:

filterImage - Icon that will be rendered if no filter is applied for a cell in a filter row.

removeFilterImage - Icon that will be rendered if a filter is applied for a cell in a filter row.

comboImage - Icon that is rendered if no filter is applied for a cell in a filter row, and the configured cell editor for that cell is a ComboBoxCellEditor.

Method Details

getImage

protected org.eclipse.swt.graphics.Image getImage(ILayerCell cell,
 IConfigRegistry configRegistry)

Overrides:

getImage in class ImagePainter

Parameters:

cell - The ILayerCell for which this ImagePainter is called.

configRegistry - The current IConfigRegistry to retrieve the cell style information from.

Returns:

The Image that should be painted by this ImagePainter.