org.eclipse.nebula.widgets.grid.internal

Class DefaultColumnGroupHeaderRenderer

java.lang.Object

org.eclipse.nebula.widgets.grid.AbstractRenderer

org.eclipse.nebula.widgets.grid.AbstractInternalWidget

org.eclipse.nebula.widgets.grid.GridHeaderRenderer

org.eclipse.nebula.widgets.grid.internal.DefaultColumnGroupHeaderRenderer

All Implemented Interfaces:

IInternalWidget, IRenderer

Direct Known Subclasses:

Win7ColumnGroupHeaderRenderer

public class DefaultColumnGroupHeaderRenderer
extends GridHeaderRenderer

The column group header renderer in Grid.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	bottomMargin
(package private) int	imageSpacing
(package private) int	leftMargin
(package private) int	rightMargin
(package private) int	topMargin

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

truncationStyle

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

LeftMouseButtonDown, MouseMove

Constructor Summary

Constructors

Constructor and Description
DefaultColumnGroupHeaderRenderer()

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(java.lang.Object value, boolean preferred) Returns the bounds of the text in the cell.
org.eclipse.swt.graphics.Rectangle	getToggleBounds() Returns the bounds of the toggle within the header (typically only group headers have toggles) or null.
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	setDisplay(org.eclipse.swt.widgets.Display display) Sets the display.

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

getControlBounds, getHorizontalAlignment, getTruncationStyle, isWordWrap, setHorizontalAlignment, setTruncationStyle, 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, 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, setExpanded, setFocus, setHover, setLocation, setLocation, setMouseDown, setSelected, setSize, setSize

Field Detail

leftMargin

int leftMargin

rightMargin

int rightMargin

topMargin

int topMargin

bottomMargin

int bottomMargin

imageSpacing

int imageSpacing

Constructor Detail

DefaultColumnGroupHeaderRenderer

public DefaultColumnGroupHeaderRenderer()

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.

getToggleBounds

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

Returns the bounds of the toggle within the header (typically only group headers have toggles) or null.

Overrides:

getToggleBounds in class GridHeaderRenderer

Returns:

toggle bounds or null if no toggle exists.

setDisplay

public void setDisplay(org.eclipse.swt.widgets.Display display)

Sets the display.

Specified by:

setDisplay in interface IRenderer

Overrides:

setDisplay in class AbstractRenderer

Parameters:

display - Display.

getTextBounds

public org.eclipse.swt.graphics.Rectangle getTextBounds(java.lang.Object value,
                                                        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 GridHeaderRenderer

Parameters:

value - the object being rendered.

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

Returns:

bounds of the text.