org.eclipse.nebula.widgets.grid.internal

Class DefaultColumnHeaderRenderer

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

All Implemented Interfaces:

IInternalWidget, IRenderer

Direct Known Subclasses:

Win7GridColumnHeaderRenderer

public class DefaultColumnHeaderRenderer
extends GridHeaderRenderer

The column header renderer.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	arrowMargin
(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
DefaultColumnHeaderRenderer()

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.
protected org.eclipse.swt.graphics.Rectangle	getControlBounds(java.lang.Object value, boolean preferred) Returns the bounds of the control to display
org.eclipse.swt.graphics.Rectangle	getTextBounds(java.lang.Object value, 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	setDisplay(org.eclipse.swt.widgets.Display display) Sets the display.

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

getHorizontalAlignment, getToggleBounds, 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

arrowMargin

int arrowMargin

imageSpacing

int imageSpacing

Constructor Detail

DefaultColumnHeaderRenderer

public DefaultColumnHeaderRenderer()

Method Detail

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

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

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.

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.

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.

getControlBounds

protected org.eclipse.swt.graphics.Rectangle getControlBounds(java.lang.Object value,
                                                              boolean preferred)

Description copied from class: GridHeaderRenderer

Returns the bounds of the control to display

Overrides:

getControlBounds in class GridHeaderRenderer

Parameters:

value - the control to display

preferred - if true, compute the preferred size

Returns:

the bounds for the control or null if no control is rendered

See Also:

GridHeaderRenderer.getControlBounds(java.lang.Object, boolean)