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

Class BackgroundImagePainter

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.BackgroundImagePainter

All Implemented Interfaces:

ICellPainter

public class BackgroundImagePainter
extends CellPainterWrapper

Paints the cell background using an image. Image is repeated to cover the background. Similar to HTML table painting.

Field Summary

Fields

Modifier and Type	Field	Description
final org.eclipse.swt.graphics.Color	separatorColor

Constructor Summary

Constructors

Constructor	Description
BackgroundImagePainter(ICellPainter interiorPainter, org.eclipse.swt.graphics.Image bgImage)
BackgroundImagePainter(ICellPainter interiorPainter, org.eclipse.swt.graphics.Image bgImage, org.eclipse.swt.graphics.Color separatorColor)
BackgroundImagePainter(org.eclipse.swt.graphics.Image bgImage)
BackgroundImagePainter(org.eclipse.swt.graphics.Image bgImage, org.eclipse.swt.graphics.Color separatorColor)

Method Summary

Modifier and Type	Method	Description
org.eclipse.swt.graphics.Image	getBackgroundImage()
int	getPreferredHeight(ILayerCell cell, org.eclipse.swt.graphics.GC gc, IConfigRegistry configRegistry)	Get the preferred height of the cell when rendered by this painter.
int	getPreferredWidth(ILayerCell cell, org.eclipse.swt.graphics.GC gc, IConfigRegistry configRegistry)	Get the preferred width of the cell when rendered by this painter.
void	paintCell(ILayerCell cell, org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle rectangle, IConfigRegistry configRegistry)
void	setBackgroundImage(org.eclipse.swt.graphics.Image bgImage)

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

getCellPainterAt, getWrappedPainter, getWrappedPainterBounds, setWrappedPainter

Methods inherited from class java.lang.Object

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

Field Details

separatorColor

public final org.eclipse.swt.graphics.Color separatorColor

Constructor Details

BackgroundImagePainter

public BackgroundImagePainter(org.eclipse.swt.graphics.Image bgImage)

Parameters:

bgImage - to be used for painting the background

Since:

1.4

BackgroundImagePainter

public BackgroundImagePainter(ICellPainter interiorPainter,
 org.eclipse.swt.graphics.Image bgImage)

Parameters:

interiorPainter - used for painting the cell contents

bgImage - to be used for painting the background

BackgroundImagePainter

public BackgroundImagePainter(org.eclipse.swt.graphics.Image bgImage,
 org.eclipse.swt.graphics.Color separatorColor)

Parameters:

bgImage - to be used for painting the background

separatorColor - to be used for drawing left and right borders for the cell. Set to null if the borders are not required.

Since:

1.4

BackgroundImagePainter

public BackgroundImagePainter(ICellPainter interiorPainter,
 org.eclipse.swt.graphics.Image bgImage,
 org.eclipse.swt.graphics.Color separatorColor)

Parameters:

interiorPainter - used for painting the cell contents

bgImage - to be used for painting the background

separatorColor - to be used for drawing left and right borders for the cell. Set to null if the borders are not required.

Method Details

getPreferredWidth

public int getPreferredWidth(ILayerCell cell,
 org.eclipse.swt.graphics.GC gc,
 IConfigRegistry configRegistry)

Description copied from interface: ICellPainter

Get the preferred width of the cell when rendered by this painter. Used for auto-resize.

Specified by:

getPreferredWidth in interface ICellPainter

Overrides:

getPreferredWidth in class CellPainterWrapper

Parameters:

cell - The cell for which the preferred width is requested.

gc - The GC that is used for rendering.

configRegistry - The IConfigRegistry that contains the configuration used for rendering.

Returns:

The preferred width of the given cell when rendered by this painter.

getPreferredHeight

public int getPreferredHeight(ILayerCell cell,
 org.eclipse.swt.graphics.GC gc,
 IConfigRegistry configRegistry)

Description copied from interface: ICellPainter

Get the preferred height of the cell when rendered by this painter. Used for auto-resize.

Specified by:

getPreferredHeight in interface ICellPainter

Overrides:

getPreferredHeight in class CellPainterWrapper

Parameters:

cell - The cell for which the preferred height is requested.

gc - The GC that is used for rendering.

configRegistry - The IConfigRegistry that contains the configuration used for rendering.

Returns:

The preferred height of the given cell when rendered by this painter.

paintCell

public void paintCell(ILayerCell cell,
 org.eclipse.swt.graphics.GC gc,
 org.eclipse.swt.graphics.Rectangle rectangle,
 IConfigRegistry configRegistry)

Specified by:

paintCell in interface ICellPainter

Overrides:

paintCell in class CellPainterWrapper

getBackgroundImage

public org.eclipse.swt.graphics.Image getBackgroundImage()

Returns:

The Image that is used to render the background.

Since:

1.4

setBackgroundImage

public void setBackgroundImage(org.eclipse.swt.graphics.Image bgImage)

Parameters:

bgImage - The Image that should be used to render the background.

Since:

1.4