org.eclipse.nebula.widgets.ctree

Class CTreeItem

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Item

org.eclipse.nebula.widgets.ctree.CTreeItem

public class CTreeItem
extends org.eclipse.swt.widgets.Item

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
protected CTreeCell[]	cells The cells which belong to, or are contained by, this item.
(package private) int	computedHeight
protected CTree	ctree The container to which this item belongs.
protected boolean	enabled Whether or not this item is enabled.
(package private) boolean	painted Whether or not this item is actually painted to the screen.
protected boolean	visible Whether or not this item is visible.

Constructor Summary

Constructors

Constructor and Description
CTreeItem(CTree parent, int style)
CTreeItem(CTree parent, int style, int index)
CTreeItem(CTreeItem parent, int style)
CTreeItem(CTreeItem parent, int style, int index)

Method Summary

Modifier and Type	Method and Description
(package private) void	addItem(int index, CTreeItem item)
void	addListener(int eventType, org.eclipse.swt.widgets.Listener handler)
protected void	checkSubclass()
int	computeHeight() Computes the size of each cell using the widthHint and heightHint with the same index as the cell.
(package private) boolean	contains(org.eclipse.swt.widgets.Control control)
boolean	contains(int x, int y) The Cells of a CTreeItem are considered contiguous and unified, therefore the contains method is overridden
boolean	contains(org.eclipse.swt.graphics.Point pt) The Cells of a CTreeItem are considered contiguous and unified, therefore the contains method is overridden
protected void	createCell(int index, int style) Creates a cell of the default class, as determined by the implementation
void	createCell(int index, int style, java.lang.Class clazz)
protected void	createCells(java.lang.Object parent)
void	dispose()
boolean	getAutoHeight()
org.eclipse.swt.graphics.Color	getBackground()
org.eclipse.swt.graphics.Color	getBackground(int index)
(package private) int	getBottom()
org.eclipse.swt.graphics.Rectangle	getBounds()
org.eclipse.swt.graphics.Rectangle	getBounds(int index)
CTreeCell	getCell(int cell)
CTreeCell	getCell(int x, int y)
CTreeCell	getCell(org.eclipse.swt.graphics.Point pt)
(package private) org.eclipse.swt.graphics.Rectangle[]	getCellBounds()
CTreeColumn	getCellColumn(CTreeCell cell)
int	getCellIndex(CTreeCell cell)
CTreeCell[]	getCells()
(package private) org.eclipse.swt.graphics.Point[]	getCellSizes()
protected int	getCellStyle(int index)
CTreeCell	getCheckCell()
CTree	getContainer()
CTree	getCTree()
CTreeCell	getCTreeCell(int column)
boolean	getExpanded() Returns the Tree Cell expansion state
org.eclipse.swt.graphics.Font	getFont() Get the font being used by the first cell
org.eclipse.swt.graphics.Font	getFont(int index) Get the font being used by the specified cell
org.eclipse.swt.graphics.Color	getForeground()
org.eclipse.swt.graphics.Color	getForeground(int index)
(package private) int	getHeight()
org.eclipse.swt.graphics.Image	getImage() If this item has a tree column, this method will return the first image from that column
org.eclipse.swt.graphics.Image	getImage(int column)
org.eclipse.swt.graphics.Image[]	getImages(int column)
(package private) CTreeItem	getItem(boolean up)
CTreeItem	getItem(int index)
int	getItemCount()
CTreeItem[]	getItems()
CTree	getParent()
int	getParentIndent()
CTreeItem	getParentItem()
org.eclipse.swt.graphics.Point	getSize()
java.lang.String	getText() If this item has a tree column, this method will return the first image from that column
java.lang.String	getText(int column)
(package private) int	getTop()
CTreeCell	getTreeCell()
int	getTreeIndent()
boolean	getVisible() Returns whether or not this CContainerItem is requesting to be visible.
int	handleMouseEvent(org.eclipse.swt.widgets.Event event, boolean selectionActive) Give the Item a chance to handle the mouse event
(package private) boolean	hasCell(int index)
boolean	hasCheckCell()
boolean	hasItems()
(package private) boolean	hasNext()
boolean	hasParentItem()
(package private) boolean	hasPrevious()
boolean	hasTreeCell()
int	indexOf(CTreeItem item)
boolean	isOpen() This method returns true if ANY of the cells are open.
boolean	isOpen(int cell)
boolean	isOpen(int x, int y)
boolean	isSelected()
boolean	isToggle(int x, int y)
boolean	isTreeToggle(int x, int y)
boolean	isVisible() Returns true if the receiver is visible and all parents up to and including the root of its container are visible.
void	layout(int eventType)
(package private) CTreeItem	next()
(package private) CTreeItem	nextVisible()
void	paint(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
(package private) CTreeItem	previous()
(package private) CTreeItem	previousVisible()
void	redraw()
(package private) void	removeItem(CTreeItem item)
void	removeListener(int eventType, org.eclipse.swt.widgets.Listener handler)
void	setBackground(org.eclipse.swt.graphics.Color color)
void	setBackground(int index, org.eclipse.swt.graphics.Color color)
void	setEnabled(boolean enabled)
void	setExpanded(boolean expanded) Sets the Tree Expansion state of the Item
boolean	setFocus()
void	setFont(org.eclipse.swt.graphics.Font font)
void	setFont(int index, org.eclipse.swt.graphics.Font font)
void	setForeground(org.eclipse.swt.graphics.Color color)
void	setForeground(int index, org.eclipse.swt.graphics.Color color)
void	setGridLine(boolean gridLine)
(package private) void	setHeight(int height)
void	setImage(org.eclipse.swt.graphics.Image image)
void	setImage(int column, org.eclipse.swt.graphics.Image image)
void	setImages(org.eclipse.swt.graphics.Image[] images)
void	setImages(int column, org.eclipse.swt.graphics.Image[] images)
(package private) void	setNext(CTreeItem item)
void	setOpen(boolean open)
void	setOpen(int cell, boolean open)
void	setOpen(int x, int y, boolean open)
(package private) void	setPainted(boolean painted)
(package private) void	setPrevious(CTreeItem item)
void	setSelected(boolean selected)
void	setText(int column, java.lang.String string)
void	setText(java.lang.String string)
void	setText(java.lang.String[] strings)
(package private) void	setTop(int top)
void	setTreeIndent(int indent)
void	setVisible(boolean visible)
void	update()
protected void	updateColors()

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, checkWidget, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

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

Field Detail

ctree

protected CTree ctree

The container to which this item belongs.

cells

protected CTreeCell[] cells

The cells which belong to, or are contained by, this item.

enabled

protected boolean enabled

Whether or not this item is enabled.

visible

protected boolean visible

Whether or not this item is visible.

painted

boolean painted

Whether or not this item is actually painted to the screen.

computedHeight

int computedHeight

Constructor Detail

CTreeItem

public CTreeItem(CTree parent,
                 int style)

CTreeItem

public CTreeItem(CTree parent,
                 int style,
                 int index)

CTreeItem

public CTreeItem(CTreeItem parent,
                 int style)

CTreeItem

public CTreeItem(CTreeItem parent,
                 int style,
                 int index)

Method Detail

addItem

void addItem(int index,
             CTreeItem item)

addListener

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

Overrides:

addListener in class org.eclipse.swt.widgets.Widget

checkSubclass

protected void checkSubclass()

Overrides:

checkSubclass in class org.eclipse.swt.widgets.Item

computeHeight

public int computeHeight()

Computes the size of each cell using the widthHint and heightHint with the same index as the cell.

Returns:

int the computed height

contains

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

contains

public boolean contains(org.eclipse.swt.graphics.Point pt)

The Cells of a CTreeItem are considered contiguous and unified, therefore the contains method is overridden

contains

public boolean contains(int x,
                        int y)

The Cells of a CTreeItem are considered contiguous and unified, therefore the contains method is overridden

createCell

protected void createCell(int index,
                          int style)

Creates a cell of the default class, as determined by the implementation

Is used to auto-fill a cell when no specific cell class is provided for the given column

Parameters:

index - the index the new cell

createCell

public void createCell(int index,
                       int style,
                       java.lang.Class clazz)

createCells

protected void createCells(java.lang.Object parent)

dispose

public void dispose()

Overrides:

dispose in class org.eclipse.swt.widgets.Widget

getAutoHeight

public boolean getAutoHeight()

getBackground

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

getBackground

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

getBottom

int getBottom()

getBounds

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

getBounds

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

getCell

public CTreeCell getCell(int cell)

getCell

public CTreeCell getCell(org.eclipse.swt.graphics.Point pt)

getCell

public CTreeCell getCell(int x,
                         int y)

getCellBounds

org.eclipse.swt.graphics.Rectangle[] getCellBounds()

getCellColumn

public CTreeColumn getCellColumn(CTreeCell cell)

getCellIndex

public int getCellIndex(CTreeCell cell)

getCells

public CTreeCell[] getCells()

getCellSizes

org.eclipse.swt.graphics.Point[] getCellSizes()

getCellStyle

protected int getCellStyle(int index)

getCheckCell

public CTreeCell getCheckCell()

getContainer

public CTree getContainer()

getCTree

public CTree getCTree()

getCTreeCell

public CTreeCell getCTreeCell(int column)

getExpanded

public boolean getExpanded()

Returns the Tree Cell expansion state

If there is no Tree Cell, simply returns false

Returns:

See Also:

org.aspencloud.widgets.ccontainer#getExpanded(boolean)

getFont

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

Get the font being used by the first cell

Returns:

Font

getFont

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

Get the font being used by the specified cell

Parameters:

index - an int used to specify the cell by an index

Returns:

Font

getForeground

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

getForeground

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

getHeight

int getHeight()

getImage

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

If this item has a tree column, this method will return the first image from that column

Overrides:

getImage in class org.eclipse.swt.widgets.Item

Returns:

the image from the tree column, null if neither exist

getImage

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

Parameters:

column - the column from which to get the image

Returns:

the first image from the given column

getImages

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

Parameters:

column - the column from which to get the images

Returns:

the images from the given column

getItem

CTreeItem getItem(boolean up)

getItem

public CTreeItem getItem(int index)

getItemCount

public int getItemCount()

getItems

public CTreeItem[] getItems()

getParent

public CTree getParent()

getParentIndent

public int getParentIndent()

getParentItem

public CTreeItem getParentItem()

getSize

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

getText

public java.lang.String getText()

If this item has a tree column, this method will return the first image from that column

Overrides:

getText in class org.eclipse.swt.widgets.Item

Returns:

the image from the tree column, null if neither exist

getText

public java.lang.String getText(int column)

Parameters:

column - the column from which to get the image

Returns:

the first image from the given column

getTop

int getTop()

getTreeCell

public CTreeCell getTreeCell()

getTreeIndent

public int getTreeIndent()

getVisible

public boolean getVisible()

Returns whether or not this CContainerItem is requesting to be visible. In other words, if its internal visibility flag is set to true. There may exist other conditions which make this item actually not visible within its container.

Returns:

true if internally considered visible, false otherwise

See Also:

Control.getVisible(), isVisible()

handleMouseEvent

public int handleMouseEvent(org.eclipse.swt.widgets.Event event,
                            boolean selectionActive)

Give the Item a chance to handle the mouse event

Parameters:

event - the Event

Returns:

0: do nothing, 1: redraw, 2: layout

hasCell

boolean hasCell(int index)

hasCheckCell

public boolean hasCheckCell()

hasItems

public boolean hasItems()

hasNext

boolean hasNext()

hasParentItem

public boolean hasParentItem()

hasPrevious

boolean hasPrevious()

hasTreeCell

public boolean hasTreeCell()

indexOf

public int indexOf(CTreeItem item)

isOpen

public boolean isOpen()

This method returns true if ANY of the cells are open.

Returns:

See Also:

org.aspencloud.widgets.ccontainer#getExpanded()

isOpen

public boolean isOpen(int cell)

isOpen

public boolean isOpen(int x,
                      int y)

isSelected

public boolean isSelected()

isToggle

public boolean isToggle(int x,
                        int y)

isTreeToggle

public boolean isTreeToggle(int x,
                            int y)

isVisible

public boolean isVisible()

Returns true if the receiver is visible and all parents up to and including the root of its container are visible. Otherwise, false is returned.

Returns:

true if visible, false otherwise

See Also:

getVisible(), Control.isVisible()

next

CTreeItem next()

nextVisible

CTreeItem nextVisible()

paint

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

previous

CTreeItem previous()

previousVisible

CTreeItem previousVisible()

redraw

public void redraw()

removeItem

void removeItem(CTreeItem item)

removeListener

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

Overrides:

removeListener in class org.eclipse.swt.widgets.Widget

setBackground

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

setBackground

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

setEnabled

public void setEnabled(boolean enabled)

setExpanded

public void setExpanded(boolean expanded)

Sets the Tree Expansion state of the Item

Does not affect the expansion state of individual expandable cells

Parameters:

expanded -

layout

public void layout(int eventType)

setFocus

public boolean setFocus()

setFont

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

setFont

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

setForeground

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

setForeground

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

setGridLine

public void setGridLine(boolean gridLine)

setHeight

void setHeight(int height)

setImage

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

Overrides:

setImage in class org.eclipse.swt.widgets.Item

setImage

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

setImages

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

setImages

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

setNext

void setNext(CTreeItem item)

setOpen

public void setOpen(boolean open)

setOpen

public void setOpen(int cell,
                    boolean open)

setOpen

public void setOpen(int x,
                    int y,
                    boolean open)

setPainted

void setPainted(boolean painted)

setPrevious

void setPrevious(CTreeItem item)

setSelected

public void setSelected(boolean selected)

setText

public void setText(int column,
                    java.lang.String string)

setText

public void setText(java.lang.String string)

Overrides:

setText in class org.eclipse.swt.widgets.Item

setText

public void setText(java.lang.String[] strings)

setTop

void setTop(int top)

setTreeIndent

public void setTreeIndent(int indent)

setVisible

public void setVisible(boolean visible)

update

public void update()

updateColors

protected void updateColors()