org.eclipse.nebula.widgets.grid

Class DefaultCellRenderer

java.lang.Object

org.eclipse.nebula.widgets.grid.AbstractRenderer

org.eclipse.nebula.widgets.grid.AbstractInternalWidget

org.eclipse.nebula.widgets.grid.GridCellRenderer

org.eclipse.nebula.widgets.grid.DefaultCellRenderer

All Implemented Interfaces:

IInternalWidget, IRenderer

public class DefaultCellRenderer
extends GridCellRenderer

The renderer for a cell in Grid.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	bottomMargin
(package private) int	leftMargin
(package private) int	rightMargin
(package private) int	textBottomMargin
(package private) int	textTopMargin
(package private) int	topMargin
(package private) int	treeIndent

Fields inherited from class org.eclipse.nebula.widgets.grid.GridCellRenderer

truncationStyle

Fields inherited from class org.eclipse.nebula.widgets.grid.AbstractInternalWidget

hoverDetail

Fields inherited from interface org.eclipse.nebula.widgets.grid.IInternalWidget

LeftMouseButtonDown, MouseMove

Constructor Summary

Constructors

Constructor and Description
DefaultCellRenderer()

Method Summary

Modifier and Type	Method and Description
org.eclipse.swt.graphics.Point	computeSize(org.eclipse.swt.graphics.GC gc, int wHint, int hHint, java.lang.Object value) Returns the size of the given value's visual representation.
org.eclipse.swt.graphics.Rectangle	getTextBounds(GridItem item, boolean preferred) Returns the bounds of the text in the cell.
boolean	notify(int event, org.eclipse.swt.graphics.Point point, java.lang.Object value) Mechanism used to notify the light weight widgets that an event occurred that it might be interested in.
void	paint(org.eclipse.swt.graphics.GC gc, java.lang.Object value) Paints the visual representation of the given value on the given GC.
void	setCheck(boolean check)
void	setTree(boolean tree)

Methods inherited from class org.eclipse.nebula.widgets.grid.GridCellRenderer

getAlignment, getColumn, getRow, getTruncationStyle, getVerticalAlignment, isCellFocus, isCellSelected, isCheck, isColumnHover, isDragging, isRowFocus, isRowHover, isTree, isWordWrap, setAlignment, setCellFocus, setCellSelected, setColumn, setColumnHover, setDragging, setRow, setRowFocus, setRowHover, setTruncationStyle, setVerticalAlignment, setWordWrap

Methods inherited from class org.eclipse.nebula.widgets.grid.AbstractInternalWidget

getHoverDetail, setHoverDetail

Methods inherited from class org.eclipse.nebula.widgets.grid.AbstractRenderer

getBounds, getDisplay, getSize, isExpanded, isFocus, isHover, isMouseDown, isSelected, setBounds, setBounds, setDisplay, setExpanded, setFocus, setHover, setLocation, setLocation, setMouseDown, setSelected, setSize, setSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.widgets.grid.IRenderer

setBounds, setBounds, setDisplay, setExpanded, setFocus, setHover, setLocation, setLocation, setMouseDown, setSelected, setSize, setSize

Field Detail

leftMargin

int leftMargin

rightMargin

int rightMargin

topMargin

int topMargin

bottomMargin

int bottomMargin

textTopMargin

int textTopMargin

textBottomMargin

int textBottomMargin

treeIndent

int treeIndent

Constructor Detail

DefaultCellRenderer

public DefaultCellRenderer()

Method Detail

paint

public void paint(org.eclipse.swt.graphics.GC gc,
                  java.lang.Object value)

Paints the visual representation of the given value on the given GC. The actual class of the value object is determined by the use of the implementing class.

Implementors need to respect the bounds values that may have been specified. The bounds values may affect the x and y values for all drawing operations as well as the width and heights. Implementors may use a Transform to translate the coordinates of all the drawing operations, otherwise they will need to offset each draw.

Parameters:

gc - GC to paint with

value - the value being painted

computeSize

public org.eclipse.swt.graphics.Point computeSize(org.eclipse.swt.graphics.GC gc,
                                                  int wHint,
                                                  int hHint,
                                                  java.lang.Object value)

Returns the size of the given value's visual representation.

Parameters:

gc - convenience GC for string and text extents

wHint - given width (or SWT.DEFAULT)

hHint - given height (or SWT.DEFAULT)

value - value to be sized

Returns:

the size

notify

public boolean notify(int event,
                      org.eclipse.swt.graphics.Point point,
                      java.lang.Object value)

Mechanism used to notify the light weight widgets that an event occurred that it might be interested in.

Parameters:

event - Event type.

point - Location of event.

value - New value.

Returns:

widget handled the event.

setTree

public void setTree(boolean tree)

Overrides:

setTree in class GridCellRenderer

Parameters:

tree - The tree to set.

setCheck

public void setCheck(boolean check)

Overrides:

setCheck in class GridCellRenderer

Parameters:

check - The check to set.

getTextBounds

public org.eclipse.swt.graphics.Rectangle getTextBounds(GridItem item,
                                                        boolean preferred)

Returns the bounds of the text in the cell. This is used when displaying in-place tooltips. If null is returned here, in-place tooltips will not be displayed. If the preferred argument is true then the returned bounds should be large enough to show the entire text. If preferred is false then the returned bounds should be be relative to the current bounds.

Overrides:

getTextBounds in class GridCellRenderer

Parameters:

item - item to calculate text bounds.

preferred - true if the preferred width of the text should be returned.

Returns:

bounds of the text.