org.eclipse.nebula.widgets.ctree

Class CTree

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.nebula.widgets.ctree.CTree

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable, org.eclipse.swt.widgets.Listener

public class CTree
extends org.eclipse.swt.widgets.Composite
implements org.eclipse.swt.widgets.Listener

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
(package private) java.util.List	addedItems
protected org.eclipse.swt.widgets.Canvas	body
static boolean	carbon true if the platform is detected as being "carbon"
(package private) java.lang.Class[]	cellClasses
protected SColors	colors
(package private) int[]	columnOrder
(package private) CTreeColumn[]	columns
boolean	drawViewportEast
boolean	drawViewportNorth
boolean	drawViewportSouth
boolean	drawViewportWest
protected java.lang.String	emptyMessage
(package private) boolean	fillerColumnSet
static boolean	gtk true if the platform is detected as being "gtk"
protected boolean	hasFocus
protected org.eclipse.swt.widgets.ScrollBar	hBar
protected org.eclipse.swt.widgets.Composite	header
(package private) int	heightOld
protected boolean	hLines
(package private) org.eclipse.swt.graphics.GC	internalGC
protected org.eclipse.swt.widgets.Table	internalTable
(package private) java.util.List	itemList
protected boolean	lastLine
protected CTreeLayout	layout
protected boolean	linesVisible
protected boolean	nativeGrid
(package private) boolean	nativeHeader
protected java.util.List	paintedItems A list of items that will actually be painted to the screen. Subclasses may override the order as the order of paintedItems represents the final drawing order of the items - the last item in this list is drawn to the screen last and is, therefore, drawn on top of any overlapping items.
boolean	paintGridAsBackground
(package private) java.util.List	removedItems
protected boolean	selectable Signifies whether or not the items of this container can be selected.
protected java.util.List	selection A list of the selected items.
protected boolean	selectOnToggle Signifies whether or not the items of this container are selected when their toggle is clicked on, as opposed to their body.
protected CTreeItem	shiftSel The first item selected with the SHIFT or CTRL key pressed.
(package private) CTreeColumn	sortColumn
(package private) int	sortDirection
protected int	style
(package private) int	topOld
(package private) boolean	updatePaintedList
protected org.eclipse.swt.widgets.ScrollBar	vBar
protected boolean	vLines
static boolean	win32 true if the platform is detected as being "win32"

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Constructor Summary

Constructors

Constructor and Description
CTree(org.eclipse.swt.widgets.Composite parent, int style)

Method Summary

Modifier and Type	Method and Description
(package private) void	addColumn(CTreeColumn column, int style)
(package private) void	addItem(CTreeItem item)
(package private) void	addItem(int index, CTreeItem item)
(package private) void	addItems()
void	addPaintedItemListener(org.eclipse.swt.widgets.Listener listener) Adds the listener to the collection of listeners who will be notified when the Paint Status of an item changes.
void	addSelectionListener(org.eclipse.swt.events.SelectionListener listener) An item may be considered visible, and will be returned with CTree#getVisibleItems(), even though it will not be painted on the screen.
void	addTreeListener(org.eclipse.swt.events.TreeListener listener)
void	clear(int index, boolean all)
void	clearAll(boolean all)
void	deselectAll()
(package private) void	firePaintedItemEvent(CTreeItem item, boolean isPainted)
protected void	fireSelectionEvent(boolean defaultSelection)
(package private) org.eclipse.swt.widgets.Composite	getBody()
int	getCheckColumn()
boolean	getCheckRoots()
SColors	getColors()
(package private) CTreeColumn	getColumn(int index)
int	getColumnCount()
int[]	getColumnOrder()
(package private) CTreeColumn[]	getColumns()
(package private) int[]	getColumnWidths()
protected org.eclipse.swt.graphics.Rectangle	getContentArea()
java.lang.String	getEmptyMessage() The Empty Message is the text message that will be displayed when there are no Items to be displayed (the CTable is empty).
int	getGridLineWidth()
(package private) org.eclipse.swt.widgets.Composite	getHeader()
int	getHeaderHeight()
boolean	getHeaderVisible()
(package private) org.eclipse.swt.widgets.Table	getInternalTable()
CTreeItem	getItem(int index)
(package private) CTreeItem	getItem(int x, int y)
int	getItemCount()
int	getItemHeight()
CTreeItem[]	getItems() Returns a (possibly empty) array of items contained in the receiver that are direct item children of the receiver.
(package private) java.util.List	getItems(CTreeItem item, boolean all) returns a deep list of items belonging to the given item
protected CTreeItem[]	getItems(org.eclipse.swt.graphics.Rectangle rect) Get a list of items within, or touching, the given rectangle.
boolean	getLastLineVisible()
boolean	getLinesVisible()
boolean	getNativeHeader()
protected java.util.List	getPaintedItems()
CTreeItem	getParentItem()
(package private) org.eclipse.swt.graphics.Point	getScrollPosition()
CTreeItem[]	getSelection()
int	getSelectionCount()
boolean	getSelectOnToggle()
boolean	getSelectOnTreeToggle()
protected CTreeColumn	getSortColumn() returns the sort column of this container as an CTreeColumn.
int	getSortDirection()
int	getStyle()
CTreeItem	getTopItem()
int	getTreeColumn()
int	getTreeIndent()
void	handleEvent(org.eclipse.swt.widgets.Event event)
protected void	handleMouseEvents(org.eclipse.swt.widgets.Event event)
boolean	hasTreeColumn() Convenience method indicating whether or not the treeColumn is set to an actual column, and thus the tree hierarchy will be displayed.
int	indexOf(CTreeColumn column)
int	indexOf(CTreeItem item)
boolean	isEmpty()
boolean	isVisible(CTreeItem item) Use this method to find out if an item is visible, and thus has the potential to be painted.
(package private) java.util.List	items(boolean all)
(package private) void	layout(int eventType, CTreeCell cell) Event types: SWT.Collapse SWT.Expand SWT.Resize
(package private) void	layout(int eventType, CTreeColumn column) Event types: SWT.Move SWT.Resize
(package private) void	layout(int eventType, CTreeItem item) Event types: SWT.Collapse SWT.Expand SWT.Hide SWT.Move SWT.Show
(package private) org.eclipse.swt.graphics.Rectangle	mapRectangle(int x, int y, int width, int height)
(package private) org.eclipse.swt.graphics.Rectangle	mapRectangle(org.eclipse.swt.graphics.Rectangle rect)
protected void	paintBackground(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
protected void	paintBody(org.eclipse.swt.widgets.Event e)
protected void	paintColumns(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
protected void	paintFocus(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
protected void	paintGridLines(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
protected void	paintItemBackgrounds(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
protected void	paintItems(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
protected void	paintSelectionIndicators(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
protected void	paintViewport(org.eclipse.swt.graphics.GC gc, org.eclipse.swt.graphics.Rectangle ebounds)
void	redraw(CTreeCell cell)
void	redraw(CTreeItem item)
void	removeAll()
(package private) void	removeColumn(CTreeColumn column)
(package private) void	removeItem(CTreeItem item)
void	removePaintedItemListener(org.eclipse.swt.widgets.Listener listener)
void	removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)
void	removeTreeListener(org.eclipse.swt.events.TreeListener listener)
(package private) void	scrollTo(org.eclipse.swt.graphics.Point pt)
(package private) void	scrollToX(int x)
(package private) void	scrollToY(int y)
void	selectAll()
void	setBackground(org.eclipse.swt.graphics.Color color) disabled: use the SColors class instead
void	setCellClass(java.lang.Class clazz)
void	setCellClasses(java.lang.Class[] classes)
void	setCheckColumn(int column, boolean roots)
void	setColumnOrder(int[] order)
void	setEmptyMessage(java.lang.String string) Sets the message that will be displayed when their are no Items to be displayed (the Container is empty).
boolean	setFocus()
void	setForeground(org.eclipse.swt.graphics.Color color) currently disabled: use the CTableColors class instead
void	setHeaderVisible(boolean show)
void	setHorizontalLinesVisible(boolean visible)
void	setInsertMark(CTreeItem item, boolean before)
void	setItemCount(int count)
void	setLayout(org.eclipse.swt.widgets.Layout layout) Sets the layout which is associated with the receiver to be the argument which may be null.
void	setLinesVisible(boolean visible)
void	setLinesVisible(boolean visible, boolean lastLine) If lastLine == false, then lines are only drawn in between items (if, of course, visible == true)
void	setNativeHeader(boolean nativeHeader)
(package private) void	setOrigin(int x, int y)
void	setRedraw(boolean redraw)
(package private) void	setScrollPosition(org.eclipse.swt.graphics.Point origin)
void	setSelectable(boolean selectable) Enables items in this Container to be selected
void	setSelection(CTreeItem item)
void	setSelection(CTreeItem[] items)
void	setSelection(CTreeItem from, CTreeItem to)
void	setSelectOnToggle(boolean select) If the the user clicks on the toggle of an item (treeCell or not) the corresponding item will become selected if, and only if, selectOnToggle is true
void	setSelectOnTreeToggle(boolean select) If the the user clicks on the toggle of the treeCell the corresponding item will become selected if, and only if, selectOnTreeToggle is true
void	setSortColumn(CTreeColumn column)
void	setSortDirection(int direction)
void	setTopItem(CTreeItem item)
void	setTreeColumn(int column) The Tree Column indicates which column should act as the tree by placing the expansion toggle in its cell.
void	setTreeIndent(int indent) Sets the amount to indent child items from their parent.
void	setVerticalLinesVisible(boolean visible)
void	showColumn(CTreeColumn column) TODO
void	showItem(CTreeItem item)
void	showSelection()
boolean	toggleSelection(CTreeItem item) toggle the selection state of the item
void	updateColors()
protected void	updatePaintedItems()

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

changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setLayoutDeferred, setTabList

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

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.swt.graphics.Drawable

isAutoScalable

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"

internalGC

org.eclipse.swt.graphics.GC internalGC

paintedItems

protected java.util.List paintedItems

A list of items that will actually be painted to the screen.
Subclasses may override the order as the order of paintedItems represents the final drawing order of the items - the last item in this list is drawn to the screen last and is, therefore, drawn on top of any overlapping items.

selection

protected java.util.List selection

A list of the selected items. Only items which are in the visibleItems list can be in this list.

shiftSel

protected CTreeItem shiftSel

The first item selected with the SHIFT or CTRL key pressed. Used to create the selection array when selecting multiple items.

selectable

protected boolean selectable

Signifies whether or not the items of this container can be selected.

selectOnToggle

protected boolean selectOnToggle

Signifies whether or not the items of this container are selected when their toggle is clicked on, as opposed to their body.

cellClasses

java.lang.Class[] cellClasses

style

protected int style

body

protected org.eclipse.swt.widgets.Canvas body

header

protected org.eclipse.swt.widgets.Composite header

internalTable

protected org.eclipse.swt.widgets.Table internalTable

columns

CTreeColumn[] columns

columnOrder

int[] columnOrder

fillerColumnSet

boolean fillerColumnSet

nativeHeader

boolean nativeHeader

sortColumn

CTreeColumn sortColumn

sortDirection

int sortDirection

hBar

protected org.eclipse.swt.widgets.ScrollBar hBar

vBar

protected org.eclipse.swt.widgets.ScrollBar vBar

hasFocus

protected boolean hasFocus

emptyMessage

protected java.lang.String emptyMessage

linesVisible

protected boolean linesVisible

lastLine

protected boolean lastLine

vLines

protected boolean vLines

hLines

protected boolean hLines

colors

protected SColors colors

nativeGrid

protected boolean nativeGrid

layout

protected CTreeLayout layout

drawViewportNorth

public boolean drawViewportNorth

drawViewportEast

public boolean drawViewportEast

drawViewportSouth

public boolean drawViewportSouth

drawViewportWest

public boolean drawViewportWest

paintGridAsBackground

public boolean paintGridAsBackground

addedItems

java.util.List addedItems

removedItems

java.util.List removedItems

topOld

int topOld

heightOld

int heightOld

updatePaintedList

boolean updatePaintedList

itemList

java.util.List itemList

Constructor Detail

CTree

public CTree(org.eclipse.swt.widgets.Composite parent,
             int style)

Method Detail

addColumn

void addColumn(CTreeColumn column,
               int style)

addItem

void addItem(CTreeItem item)

addItem

void addItem(int index,
             CTreeItem item)

addItems

void addItems()

addPaintedItemListener

public void addPaintedItemListener(org.eclipse.swt.widgets.Listener listener)

Adds the listener to the collection of listeners who will be notified when the Paint Status of an item changes.

An item may be considered visible, and will be returned with CTree#getVisibleItems(), even though it will not be painted on the screen. Paint status, on the other hand, refers to whether or not an item will actually be painted when the paintBody(Event) method is called.

The Event that is passed to this listener will have the item, whose Paint Status has changed, set as Event.item. The actual Paint Status is dertermined through the value of the Event's detail field: values > 0 mean the item will be painted, while values < 0 mean the item will not be painted.

Parameters:

listener - the listener which should be notified

See Also:

removePaintedItemListener(org.eclipse.swt.widgets.Listener), getPaintedItems()

addSelectionListener

public void addSelectionListener(org.eclipse.swt.events.SelectionListener listener)

An item may be considered visible, and will be returned with CTree#getVisibleItems(), even though it will not be painted on the screen. Paint status, on the other hand, refers to whether or not an item will actually be painted when the paintBody(Event) method is called.

See Also:

#getVisibleItems()

addTreeListener

public void addTreeListener(org.eclipse.swt.events.TreeListener listener)

clear

public void clear(int index,
                  boolean all)

clearAll

public void clearAll(boolean all)

deselectAll

public void deselectAll()

firePaintedItemEvent

void firePaintedItemEvent(CTreeItem item,
                          boolean isPainted)

fireSelectionEvent

protected void fireSelectionEvent(boolean defaultSelection)

getBody

org.eclipse.swt.widgets.Composite getBody()

getCheckColumn

public int getCheckColumn()

getCheckRoots

public boolean getCheckRoots()

getColors

public SColors getColors()

getColumnCount

public int getColumnCount()

getColumnOrder

public int[] getColumnOrder()

getColumnWidths

int[] getColumnWidths()

getContentArea

protected org.eclipse.swt.graphics.Rectangle getContentArea()

getEmptyMessage

public java.lang.String getEmptyMessage()

The Empty Message is the text message that will be displayed when there are no Items to be displayed (the CTable is empty).

Returns:

a String representing the Empty Message. Guaranteed to NOT be null.

See Also:

org.aspencloud.widgets.ccontainer#setEmptyMessage(java.lang.String)

getGridLineWidth

public int getGridLineWidth()

getHeader

org.eclipse.swt.widgets.Composite getHeader()

getHeaderHeight

public int getHeaderHeight()

getHeaderVisible

public boolean getHeaderVisible()

getInternalTable

org.eclipse.swt.widgets.Table getInternalTable()

getItem

public CTreeItem getItem(int index)

getItemCount

public int getItemCount()

getItemHeight

public int getItemHeight()

getItems

public CTreeItem[] getItems()

Returns a (possibly empty) array of items contained in the receiver that are direct item children of the receiver. These are the roots of the tree.

Note: This is not the actual structure used by the receiver to maintain its list of items, so modifying the array will not affect the receiver.

Returns:

the items

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getItems

java.util.List getItems(CTreeItem item,
                        boolean all)

returns a deep list of items belonging to the given item

getItems

protected CTreeItem[] getItems(org.eclipse.swt.graphics.Rectangle rect)

Get a list of items within, or touching, the given rectangle.

Parameters:

rect -

Returns:

getLastLineVisible

public boolean getLastLineVisible()

getLinesVisible

public boolean getLinesVisible()

getNativeHeader

public boolean getNativeHeader()

getPaintedItems

protected java.util.List getPaintedItems()

getParentItem

public CTreeItem getParentItem()

getScrollPosition

org.eclipse.swt.graphics.Point getScrollPosition()

getSelection

public CTreeItem[] getSelection()

getSelectionCount

public int getSelectionCount()

getSelectOnToggle

public boolean getSelectOnToggle()

Returns:

See Also:

setSelectOnToggle(boolean)

getSelectOnTreeToggle

public boolean getSelectOnTreeToggle()

Returns:

true if selection state is to changed when a toggle is clicked, false otherwise

See Also:

setSelectOnTreeToggle(boolean)

getSortDirection

public int getSortDirection()

getStyle

public int getStyle()

Overrides:

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

getTopItem

public CTreeItem getTopItem()

getTreeColumn

public int getTreeColumn()

getTreeIndent

public int getTreeIndent()

handleEvent

public void handleEvent(org.eclipse.swt.widgets.Event event)

Specified by:

handleEvent in interface org.eclipse.swt.widgets.Listener

handleMouseEvents

protected void handleMouseEvents(org.eclipse.swt.widgets.Event event)

hasTreeColumn

public boolean hasTreeColumn()

Convenience method indicating whether or not the treeColumn is set to an actual column, and thus the tree hierarchy will be displayed.

Note that if the hierarchy is not displayed, then certain methods are able to be optimized and will take advantage of this fact

Returns:

true if treeColumn is set to an existing column, false otherwise

indexOf

public int indexOf(CTreeColumn column)

indexOf

public int indexOf(CTreeItem item)

getColumn

CTreeColumn getColumn(int index)

getColumns

CTreeColumn[] getColumns()

getItem

CTreeItem getItem(int x,
                  int y)

getSortColumn

protected CTreeColumn getSortColumn()

returns the sort column of this container as an CTreeColumn. subclasses should override to provide an appropriate cast.

Returns:

the sort column

isEmpty

public boolean isEmpty()

isVisible

public boolean isVisible(CTreeItem item)

Use this method to find out if an item is visible, and thus has the potential to be painted.

An Item will be visible when every parent between it and the root of the tree is expanded

Parameters:

item - the item in question

Returns:

true if the item can be painted to the screen, false if it is hidden due to a parent item being collapsed

items

java.util.List items(boolean all)

layout

void layout(int eventType,
            CTreeCell cell)

Event types:

• SWT.Collapse
• SWT.Expand
• SWT.Resize

Parameters:

eventType -

cell -

layout

void layout(int eventType,
            CTreeColumn column)

Event types:

• SWT.Move
• SWT.Resize

Parameters:

eventType -

column -

layout

void layout(int eventType,
            CTreeItem item)

Event types:

• SWT.Collapse
• SWT.Expand
• SWT.Hide
• SWT.Move
• SWT.Show

Parameters:

eventType -

item -

mapRectangle

org.eclipse.swt.graphics.Rectangle mapRectangle(int x,
                                                int y,
                                                int width,
                                                int height)

mapRectangle

org.eclipse.swt.graphics.Rectangle mapRectangle(org.eclipse.swt.graphics.Rectangle rect)

paintBackground

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

paintBody

protected void paintBody(org.eclipse.swt.widgets.Event e)

paintColumns

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

paintFocus

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

paintGridLines

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

paintItemBackgrounds

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

paintItems

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

paintSelectionIndicators

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

paintViewport

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

redraw

public void redraw(CTreeCell cell)

redraw

public void redraw(CTreeItem item)

removeAll

public void removeAll()

removeColumn

void removeColumn(CTreeColumn column)

removeItem

void removeItem(CTreeItem item)

removePaintedItemListener

public void removePaintedItemListener(org.eclipse.swt.widgets.Listener listener)

removeSelectionListener

public void removeSelectionListener(org.eclipse.swt.events.SelectionListener listener)

removeTreeListener

public void removeTreeListener(org.eclipse.swt.events.TreeListener listener)

scrollTo

void scrollTo(org.eclipse.swt.graphics.Point pt)

scrollToX

void scrollToX(int x)

scrollToY

void scrollToY(int y)

selectAll

public void selectAll()

setBackground

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

disabled: use the SColors class instead

Overrides:

setBackground in class org.eclipse.swt.widgets.Control

setCellClass

public void setCellClass(java.lang.Class clazz)

setCellClasses

public void setCellClasses(java.lang.Class[] classes)

setCheckColumn

public void setCheckColumn(int column,
                           boolean roots)

setColumnOrder

public void setColumnOrder(int[] order)

setEmptyMessage

public void setEmptyMessage(java.lang.String string)

Sets the message that will be displayed when their are no Items to be displayed (the Container is empty). The message will span all rows and be aligned to the Top and Center of the CTable. Setting string to null will disable the Empty Message Display feature.

Parameters:

string - the message to be displayed

setFocus

public boolean setFocus()

Overrides:

setFocus in class org.eclipse.swt.widgets.Composite

setForeground

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

currently disabled: use the CTableColors class instead

post a feature request if you need it enabled

Overrides:

setForeground in class org.eclipse.swt.widgets.Control

setHeaderVisible

public void setHeaderVisible(boolean show)

setHorizontalLinesVisible

public void setHorizontalLinesVisible(boolean visible)

setInsertMark

public void setInsertMark(CTreeItem item,
                          boolean before)

setItemCount

public void setItemCount(int count)

setLayout

public void setLayout(org.eclipse.swt.widgets.Layout layout)

Sets the layout which is associated with the receiver to be the argument which may be null. If the argument is non-null then it must be a subclass of CContainerLayout or this method will simply return.

Overrides:

setLayout in class org.eclipse.swt.widgets.Composite

Parameters:

layout - the receiver's new layout or null

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

setLinesVisible

public void setLinesVisible(boolean visible)

setLinesVisible

public void setLinesVisible(boolean visible,
                            boolean lastLine)

If lastLine == false, then lines are only drawn in between items (if, of course, visible == true)

Parameters:

visible -

lastLine - whether or not the last line is set visible

See Also:

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

setNativeHeader

public void setNativeHeader(boolean nativeHeader)

setOrigin

void setOrigin(int x,
               int y)

setRedraw

public void setRedraw(boolean redraw)

Overrides:

setRedraw in class org.eclipse.swt.widgets.Control

setScrollPosition

void setScrollPosition(org.eclipse.swt.graphics.Point origin)

setSelectable

public void setSelectable(boolean selectable)

Enables items in this Container to be selected

Parameters:

selectable -

setSelection

public void setSelection(CTreeItem item)

setSelection

public void setSelection(CTreeItem from,
                         CTreeItem to)

setSelection

public void setSelection(CTreeItem[] items)

setSelectOnToggle

public void setSelectOnToggle(boolean select)

If the the user clicks on the toggle of an item (treeCell or not) the corresponding item will become selected if, and only if, selectOnToggle is true

Parameters:

select - the new state of selectOnToggle

setSelectOnTreeToggle

public void setSelectOnTreeToggle(boolean select)

If the the user clicks on the toggle of the treeCell the corresponding item will become selected if, and only if, selectOnTreeToggle is true

Parameters:

select - the new state of selectOnTreeToggle

setSortColumn

public void setSortColumn(CTreeColumn column)

setSortDirection

public void setSortDirection(int direction)

setTopItem

public void setTopItem(CTreeItem item)

setTreeColumn

public void setTreeColumn(int column)

The Tree Column indicates which column should act as the tree by placing the expansion toggle in its cell.

If column is greater than the number of columns, or is less than zero then no column will have an expansion toggle (or room for one).

Parameters:

column - the column to use for the tree

setTreeIndent

public void setTreeIndent(int indent)

Sets the amount to indent child items from their parent.

Suitable defaults are set according to SWT.Platform, but the option to customize is still exposed through this metho

Note that only the Tree Column will be indented; if there is no Tree Column then this setting will have no affect. If you need the entire Item and all of its columns to be indented, please file a feature request at sourceforge.net/projects/calypsorcp

Parameters:

indent -

setVerticalLinesVisible

public void setVerticalLinesVisible(boolean visible)

showColumn

public void showColumn(CTreeColumn column)

TODO

Parameters:

column -

showItem

public void showItem(CTreeItem item)

showSelection

public void showSelection()

toggleSelection

public boolean toggleSelection(CTreeItem item)

toggle the selection state of the item

Parameters:

item - the item whose selection state is to be toggled

Returns:

true if the item's selection state was toggled on, false otherwise

updateColors

public void updateColors()

updatePaintedItems

protected void updatePaintedItems()