org.eclipse.nebula.widgets.ctree

Class CTreeCell

java.lang.Object

org.eclipse.nebula.widgets.ctree.CTreeCell

public class CTreeCell
extends java.lang.Object

NOTE: THIS WIDGET AND ITS API ARE STILL UNDER DEVELOPMENT. THIS IS A PRE-RELEASE ALPHA VERSION. USERS SHOULD EXPECT API CHANGES IN FUTURE VERSIONS.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	carbon true if the platform is detected as being "carbon"
protected boolean	childVisible indicates whether or not this cell's child area is visible
protected CTree	ctree the container to which this cell's item belongs
protected boolean	ghostToggle If true, the toggle will not be drawn, but will take up space
static boolean	gtk true if the platform is detected as being "gtk"
(package private) int	hAlign the horizontal alignment to use when positioning the control in the client area, if it was created
protected boolean	holdControl
protected int	indent the amount by which the toggle, and thus the rest of the cell, is to be indented
protected boolean	isGridLine indicates whether or not this cell is to be drawn as though it were a gridline.
protected CTreeItem	item the item to which this cell belongs
int	marginBottom An amount of margin to be applied to the bottom of the cell.
int	marginHeight An amount of margin to be applied to both the top and bottom of the cell.
int	marginLeft An amount of margin to be applied to the left side of the cell.
int	marginRight An amount of margin to be applied to the right side of the cell.
int	marginTop An amount of margin to be applied to the top of the cell.
int	marginWidth An amount of margin to be applied to both the left and right sides of the cell.
protected boolean	mouseDown indicates whether or not the primary mouse button is down, whether or not it is over this cell.
protected boolean	mouseOver indicates whether or not the mouse is over this cell.
protected boolean	mouseOverToggle indicates whether or not the mouse is over this cell's toggle.
protected boolean	open indicates whether or not this cell is considered 'open' or 'closed'.
protected boolean	selected indicates whether or not this cell is selected, and thereby included in the container's current selection list.
protected int	style the style settings for this cell
protected boolean	toggleVisible indicates whether or not this cell's toggle is visible
int	toggleWidth sets the width of the toggle
(package private) int	vAlign the vertical alignment to use when positioning the control in the client area, if it was created
protected boolean	visible indicates whether or not this cell is visible and should be considered for painting by the container.
static boolean	win32 true if the platform is detected as being "win32"

Constructor Summary

Constructors

Constructor and Description
CTreeCell(CTreeItem item, int style)

Method Summary

Modifier and Type	Method and Description
void	addListener(int eventType, org.eclipse.swt.widgets.Listener handler)
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	clear()
(package private) org.eclipse.swt.graphics.Point	computeChildSize(int wHint, int hHint)
org.eclipse.swt.graphics.Point	computeClientSize(int wHint, int hHint) compute the size of this cell's client area; that is, compute the size of the area which is not covered by margins, toggles, or checks.
(package private) org.eclipse.swt.graphics.Point	computeControlSize(int wHint, int hHint)
org.eclipse.swt.graphics.Point	computeSize(int wHint, int hHint) Compute the preferred size of the cell for its current state (open or closed, if applicable) just the way it would be done in a regular SWT layout.
protected org.eclipse.swt.graphics.Point	computeTextSize(int wHint, int hHint)
(package private) boolean	contains(org.eclipse.swt.widgets.Control control)
protected org.eclipse.swt.widgets.Control	createChildControl(org.eclipse.swt.widgets.Composite parent) Create the contents of your custom cell's Child Area here.
protected org.eclipse.swt.widgets.Control	createControl(org.eclipse.swt.widgets.Composite parent) Create the contents of your custom cell here
(package private) void	dispose()
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
org.eclipse.swt.graphics.Color	getBackground() Returns the active background color.
org.eclipse.swt.graphics.Rectangle	getBounds() Returns the bounds of this cell, relative to the container's body.
org.eclipse.swt.graphics.Color	getCellBackground() Returns the stored background color.
org.eclipse.swt.graphics.Color	getCellForeground() Returns the stored foreground color.
boolean	getChecked() Returns whether or not this cell is checked.
int[]	getChildSpan() Get information on if and how the child area of this CTableTree will span the columns.
org.eclipse.swt.graphics.Rectangle	getClientArea() Get the client area of this cell.
protected java.util.List	getColorManagedControls() Get a list containing all of the controls whose colors (foreground and background) are managed by this cell.
CTreeColumn	getColumn()
protected org.eclipse.swt.widgets.Display	getDisplay()
protected java.util.List	getEventManagedControls() Get a list containing all of the controls whose events (such as mouse and keyboard) are managed by this cell.
org.eclipse.swt.graphics.Font	getFont() Get the font in use by this cell.
org.eclipse.swt.graphics.Color	getForeground() Returns the active foreground color.
int	getHeight()
org.eclipse.swt.graphics.Image	getImage()
org.eclipse.swt.graphics.Image[]	getImages()
int	getIndent()
int	getIndex()
org.eclipse.swt.graphics.Point	getLocation()
boolean	getPainted()
org.eclipse.swt.graphics.Point	getSize()
int	getStyle()
java.lang.String	getText()
(package private) boolean	getToggleVisible()
int	getWidth()
protected void	handleMouseEvent(org.eclipse.swt.widgets.Event event, boolean selectionActive) Give the Item a chance to handle the mouse event
(package private) void	initialize()
protected org.eclipse.swt.graphics.GC	internalGC()
boolean	isCheckCell()
boolean	isOpen()
boolean	isSelected()
(package private) boolean	isToggle(int x, int y)
boolean	isTreeCell()
protected void	layout()
protected void	layout(org.eclipse.swt.widgets.Control control)
protected void	layoutChild()
protected void	layoutChild(org.eclipse.swt.widgets.Control childControl)
protected void	locate(org.eclipse.swt.widgets.Control control)
protected void	locateChild()
(package private) void	paint(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
(package private) void	paintCell(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Point offset)
boolean	paintClientArea(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle area)
void	redraw()
void	removeListener(int eventType, org.eclipse.swt.widgets.Listener handler)
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
protected void	restoreState(java.util.Map memento)
protected java.util.Map	saveState()
void	setBackground(org.eclipse.swt.graphics.Color color)
void	setCheck(boolean check)
void	setChecked(boolean checked)
void	setChildSpan(int start, int len) Set which columns the Child Area of this CTableTreeCell will span. The default setting is: start == -1 and len == 1.
void	setChildVisible(boolean visible)
protected void	setControlLayoutData(int horizontalAlignment, int verticalAlignment)
protected void	setCursor(int id)
protected void	setExclusions(org.eclipse.swt.widgets.Control exclude)
protected void	setExclusions(java.util.List colors, java.util.List events)
boolean	setFocus()
void	setFont(org.eclipse.swt.graphics.Font font)
void	setForeground(org.eclipse.swt.graphics.Color color)
void	setGridLine(boolean isGridLine)
void	setImage(org.eclipse.swt.graphics.Image image)
void	setImages(org.eclipse.swt.graphics.Image[] images)
void	setIndent(int indent)
void	setOpen(boolean open) Requests the cell to either open or close
(package private) void	setPainted(boolean painted)
(package private) void	setSelected(boolean selected) Set the selection state of this cell.
void	setText(java.lang.String string)
void	setToggleVisible(boolean visible) Sets the visibility of the cell's Toggle
void	setToggleVisible(boolean visible, boolean ghost) Sets the visibility of the cell's Toggle
void	setVisible(boolean visible) Sets the visibility of the cell
protected void	snap(org.eclipse.swt.graphics.Rectangle bounds) Called during setBounds.
boolean	update() Updates this cell with its item's data object, as returned by item.getData().
boolean	update(java.lang.Object element, java.lang.String[] properties) Updates the given properties of this CTableCell with the given element
protected void	updateColors() Update the background and foreground colors for the cell and any contained controls.

Methods inherited from class java.lang.Object

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

Field Detail

carbon

public static final boolean carbon

true if the platform is detected as being "carbon"

gtk

public static final boolean gtk

true if the platform is detected as being "gtk"

win32

public static final boolean win32

true if the platform is detected as being "win32"

ctree

protected CTree ctree

the container to which this cell's item belongs

item

protected CTreeItem item

the item to which this cell belongs

style

protected int style

the style settings for this cell

hAlign

int hAlign

the horizontal alignment to use when positioning the control in the client area, if it was created

vAlign

int vAlign

the vertical alignment to use when positioning the control in the client area, if it was created

open

protected boolean open

indicates whether or not this cell is considered 'open' or 'closed'. the actual meaning may vary between concrete implementations.

selected

protected boolean selected

indicates whether or not this cell is selected, and thereby included in the container's current selection list.

visible

protected boolean visible

indicates whether or not this cell is visible and should be considered for painting by the container.

childVisible

protected boolean childVisible

indicates whether or not this cell's child area is visible

toggleVisible

protected boolean toggleVisible

indicates whether or not this cell's toggle is visible

ghostToggle

protected boolean ghostToggle

If true, the toggle will not be drawn, but will take up space

mouseDown

protected boolean mouseDown

indicates whether or not the primary mouse button is down, whether or not it is over this cell.

mouseOver

protected boolean mouseOver

indicates whether or not the mouse is over this cell.

mouseOverToggle

protected boolean mouseOverToggle

indicates whether or not the mouse is over this cell's toggle.

marginLeft

public int marginLeft

An amount of margin to be applied to the left side of the cell.

marginWidth

public int marginWidth

An amount of margin to be applied to both the left and right sides of the cell.

marginRight

public int marginRight

An amount of margin to be applied to the right side of the cell.

marginTop

public int marginTop

An amount of margin to be applied to the top of the cell.

marginHeight

public int marginHeight

An amount of margin to be applied to both the top and bottom of the cell.

marginBottom

public int marginBottom

An amount of margin to be applied to the bottom of the cell.

toggleWidth

public int toggleWidth

sets the width of the toggle

indent

protected int indent

the amount by which the toggle, and thus the rest of the cell, is to be indented

isGridLine

protected boolean isGridLine

indicates whether or not this cell is to be drawn as though it were a gridline. typically only relevant to GTK.

holdControl

protected boolean holdControl

Constructor Detail

CTreeCell

public CTreeCell(CTreeItem item,
                 int style)

Method Detail

addListener

public void addListener(int eventType,
                        org.eclipse.swt.widgets.Listener handler)

Parameters:

eventType -

handler -

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Parameters:

listener -

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

Parameters:

propertyName -

listener -

clear

public void clear()

computeChildSize

org.eclipse.swt.graphics.Point computeChildSize(int wHint,
                                                int hHint)

computeClientSize

public org.eclipse.swt.graphics.Point computeClientSize(int wHint,
                                                        int hHint)

compute the size of this cell's client area; that is, compute the size of the area which is not covered by margins, toggles, or checks.

Parameters:

wHint -

hHint -

Returns:

a Point representing the computed size

computeControlSize

org.eclipse.swt.graphics.Point computeControlSize(int wHint,
                                                  int hHint)

computeSize

public org.eclipse.swt.graphics.Point computeSize(int wHint,
                                                  int hHint)

Compute the preferred size of the cell for its current state (open or closed, if applicable) just the way it would be done in a regular SWT layout.

Parameters:

wHint -

hHint -

Returns:

a Point representing the preferred size of the cell

computeTextSize

protected org.eclipse.swt.graphics.Point computeTextSize(int wHint,
                                                         int hHint)

contains

boolean contains(org.eclipse.swt.widgets.Control control)

Parameters:

control -

Returns:

true if the control is part of this cell, false otherwise

createChildControl

protected org.eclipse.swt.widgets.Control createChildControl(org.eclipse.swt.widgets.Composite parent)

Create the contents of your custom cell's Child Area here.

Parameters:

parent - the parent composite of your new control

Returns:

the newly created control (for multiple controls, create them inside a composite, and return the composite here)

createControl

protected org.eclipse.swt.widgets.Control createControl(org.eclipse.swt.widgets.Composite parent)

Create the contents of your custom cell here

Parameters:

parent - the parent composite of your new control

Returns:

the newly created control (for multiple controls, create them inside a composite, and return the composite here)

dispose

void dispose()

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

Parameters:

propertyName -

oldValue -

newValue -

getBackground

public org.eclipse.swt.graphics.Color getBackground()

Returns the active background color.

Returns:

Color

See Also:

activeBackground, getForeground(), setBackground(Color)

getBounds

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

Returns the bounds of this cell, relative to the container's body.

Returns:

Rectangle

getCellBackground

public org.eclipse.swt.graphics.Color getCellBackground()

Returns the stored background color.

Returns:

Color

See Also:

storedBackground

getCellForeground

public org.eclipse.swt.graphics.Color getCellForeground()

Returns the stored foreground color.

Returns:

Color

See Also:

storedForeground

getChecked

public boolean getChecked()

Returns whether or not this cell is checked. If the cell is not of style SWT.CHECK, false is returned.

Returns:

boolean representing the check state of the cell.

getChildSpan

public int[] getChildSpan()

Get information on if and how the child area of this CTableTree will span the columns.

Returns:

an int[] with a length of 2: int[0] represents the starting column, and int[1] represents the number of columns, from the start, to span.

See Also:

setChildSpan(int, int)

getClientArea

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

Get the client area of this cell. This is the area where controls can be placed and painting can occur by subclasses. ONLY VALID WHEN bounds IS VALID

Returns:

Rectangle

getColorManagedControls

protected java.util.List getColorManagedControls()

Get a list containing all of the controls whose colors (foreground and background) are managed by this cell.

Returns:

List

getEventManagedControls

protected java.util.List getEventManagedControls()

Get a list containing all of the controls whose events (such as mouse and keyboard) are managed by this cell.

Returns:

List

getFont

public org.eclipse.swt.graphics.Font getFont()

Get the font in use by this cell.

Returns:

Font

getForeground

public org.eclipse.swt.graphics.Color getForeground()

Returns the active foreground color.

Returns:

Color

See Also:

activeForeground, getBackground(), setForeground(Color)

getImage

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

getImages

public org.eclipse.swt.graphics.Image[] getImages()

getIndent

public int getIndent()

getLocation

public org.eclipse.swt.graphics.Point getLocation()

getPainted

public boolean getPainted()

getSize

public org.eclipse.swt.graphics.Point getSize()

getIndex

public int getIndex()

getHeight

public int getHeight()

getWidth

public int getWidth()

getColumn

public CTreeColumn getColumn()

getStyle

public int getStyle()

getText

public java.lang.String getText()

isToggle

boolean isToggle(int x,
                 int y)

getToggleVisible

boolean getToggleVisible()

handleMouseEvent

protected void handleMouseEvent(org.eclipse.swt.widgets.Event event,
                                boolean selectionActive)

Give the Item a chance to handle the mouse event

Parameters:

event - the Event

selectionActive -

initialize

void initialize()

internalGC

protected org.eclipse.swt.graphics.GC internalGC()

isCheckCell

public boolean isCheckCell()

isOpen

public boolean isOpen()

isSelected

public boolean isSelected()

isTreeCell

public boolean isTreeCell()

layout

protected void layout()

layout

protected void layout(org.eclipse.swt.widgets.Control control)

layoutChild

protected void layoutChild()

layoutChild

protected void layoutChild(org.eclipse.swt.widgets.Control childControl)

locate

protected void locate(org.eclipse.swt.widgets.Control control)

locateChild

protected void locateChild()

paint

void paint(org.eclipse.swt.graphics.GC gc,
           org.eclipse.swt.graphics.Rectangle ebounds)

Parameters:

gc - the GC upon which the cell will be painted

ebounds - the bounding rectangle of the Container's paint event

paintCell

void paintCell(org.eclipse.swt.graphics.GC gc,
               org.eclipse.swt.graphics.Point offset)

paintClientArea

public boolean paintClientArea(org.eclipse.swt.graphics.GC gc,
                               org.eclipse.swt.graphics.Rectangle area)

getDisplay

protected org.eclipse.swt.widgets.Display getDisplay()

redraw

public void redraw()

removeListener

public void removeListener(int eventType,
                           org.eclipse.swt.widgets.Listener handler)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

restoreState

protected void restoreState(java.util.Map memento)

saveState

protected java.util.Map saveState()

setBackground

public void setBackground(org.eclipse.swt.graphics.Color color)

setCheck

public void setCheck(boolean check)

setChecked

public void setChecked(boolean checked)

setChildSpan

public void setChildSpan(int start,
                         int len)

Set which columns the Child Area of this CTableTreeCell will span.
The default setting is: start == -1 and len == 1. To span the entire CTableTree (all columns), then use setChildSpan(0, -1).

Parameters:

start - the column in which the child area will begin. A value of -1 indicates that the child area should begin in the same column as its title area (same cell).

len - how many columns, starting with the one specified by 'start', the child area will span. A value of '-1' indicates that the child area should span all the way to the end of the last column.

See Also:

getChildSpan()

setChildVisible

public void setChildVisible(boolean visible)

setControlLayoutData

protected void setControlLayoutData(int horizontalAlignment,
                                    int verticalAlignment)

setCursor

protected void setCursor(int id)

setExclusions

protected void setExclusions(org.eclipse.swt.widgets.Control exclude)

setExclusions

protected void setExclusions(java.util.List colors,
                             java.util.List events)

setFocus

public boolean setFocus()

setFont

public void setFont(org.eclipse.swt.graphics.Font font)

setForeground

public void setForeground(org.eclipse.swt.graphics.Color color)

setGridLine

public void setGridLine(boolean isGridLine)

setImage

public void setImage(org.eclipse.swt.graphics.Image image)

setImages

public void setImages(org.eclipse.swt.graphics.Image[] images)

setIndent

public void setIndent(int indent)

setOpen

public void setOpen(boolean open)

Requests the cell to either open or close

The base implementation creates the Child Area the first time setOpen(true) is called (if, of course, the cell was created with the SWT.DROP_DOWN style).

What exactly open refers to can be overridden by subclasses

Parameters:

open - if true, the cell will open, otherwise it will close

setPainted

void setPainted(boolean painted)

setSelected

void setSelected(boolean selected)

Set the selection state of this cell.

Parameters:

selected - true if selected, false otherwise

setText

public void setText(java.lang.String string)

setToggleVisible

public void setToggleVisible(boolean visible)

Sets the visibility of the cell's Toggle

Parameters:

visible -

setToggleVisible

public void setToggleVisible(boolean visible,
                             boolean ghost)

Sets the visibility of the cell's Toggle

If ghost is true, then the toggle will occupy space even when not visible - this is especially usefull for building trees

Parameters:

visible -

ghost -

setVisible

public void setVisible(boolean visible)

Sets the visibility of the cell

Parameters:

visible -

snap

protected void snap(org.eclipse.swt.graphics.Rectangle bounds)

Called during setBounds. To be implemented in sub-classes

Parameters:

bounds -

update

public boolean update()

Updates this cell with its item's data object, as returned by item.getData(). If getData() returns null, then this method simply returns false.

Returns:

true if this cell (and thus maybe the container) needs its layout updated

See Also:

update(Object, String[])

update

public boolean update(java.lang.Object element,
                      java.lang.String[] properties)

Updates the given properties of this CTableCell with the given element

Functionality is only provided for a basic cell, subclasses should override

Parameters:

element - the data to use in updating the cell

properties - the properties of the cell to be updated

Returns:

true if this cell (and thus maybe its container) needs its layout updated, actually calling layout on the cell and/or the CContainer is left up to the caller so that performance improvements can be made - for instance, if several cells are updated, the CContainer need only be updated once.

updateColors

protected void updateColors()

Update the background and foreground colors for the cell and any contained controls. This method should be called whenever something may change the color of the cell, such as a change in selection state.