org.eclipse.swt.widgets

Class Table

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.swt.widgets.Table

All Implemented Interfaces:

Drawable

public class Table
extends Composite

Instances of this class implement a selectable user interface object that displays a list of images and strings and issues notification when selected.

The item children that may be added to instances of this class must be of type TableItem.

Style VIRTUAL is used to create a Table whose TableItems are to be populated by the client on an on-demand basis instead of up-front. This can provide significant performance improvements for tables that are very large or for which TableItem population is expensive (for example, retrieving values from an external source).

Here is an example of using a Table with style VIRTUAL:

  final Table table = new Table (parent, SWT.VIRTUAL | SWT.BORDER);
  table.setItemCount (1000000);
  table.addListener (SWT.SetData, new Listener () {
      public void handleEvent (Event event) {
          TableItem item = (TableItem) event.item;
          int index = table.indexOf (item);
          item.setText ("Item " + index);
          System.out.println (item.getText ());
      }
  }); 
 

Note that although this class is a subclass of Composite, it does not normally make sense to add Control children to it, or set a layout on it, unless implementing something like a cell editor.

Styles:

SINGLE, MULTI, CHECK, FULL_SELECTION, HIDE_SELECTION, VIRTUAL, NO_SCROLL

Events:

Selection, DefaultSelection, SetData, MeasureItem, EraseItem, PaintItem

Note: Only one of the styles SINGLE, and MULTI may be specified.

IMPORTANT: This class is not intended to be subclassed.

See Also:

Table, TableItem, TableColumn snippets, SWT Example: ControlExample, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	columnCount
(package private) TableColumn[]	columns
(package private) static boolean	COMPRESS_ITEMS
(package private) TableItem	currentItem
(package private) int	customCount
(package private) boolean	customDraw
(package private) static int	DRAG_IMAGE_SIZE
(package private) boolean	dragStarted
(package private) static int	EXPLORER_EXTRA
(package private) static boolean	EXPLORER_THEME
(package private) boolean	explorerTheme
(package private) boolean	firstColumnImage
(package private) boolean	fixScrollWidth
(package private) RECT	focusRect
(package private) boolean	fullRowSelect
(package private) static int	GRID_WIDTH
(package private) static int	H_SCROLL_LIMIT
(package private) static int	HEADER_EXTRA
(package private) static int	HEADER_MARGIN
(package private) ImageList	headerImageList
(package private) static int	HeaderProc
(package private) int	headerToolTipHandle
(package private) int	hotIndex
(package private) boolean	ignoreActivate
(package private) boolean	ignoreColumnMove
(package private) boolean	ignoreColumnResize
(package private) boolean	ignoreCustomDraw
(package private) boolean	ignoreDrawBackground
(package private) boolean	ignoreDrawFocus
(package private) boolean	ignoreDrawForeground
(package private) boolean	ignoreDrawHot
(package private) boolean	ignoreDrawSelection
(package private) boolean	ignoreResize
(package private) boolean	ignoreSelect
(package private) boolean	ignoreShrink
(package private) ImageList	imageList
(package private) static int	INSET
(package private) int	itemHeight
(package private) TableItem[]	items
(package private) int	keyCount
(package private) int[]	keys
(package private) int	lastIndexOf
(package private) int	lastWidth
(package private) boolean	painted
(package private) int	resizeCount
(package private) int	selectionForeground
(package private) static int	SORT_WIDTH
(package private) TableColumn	sortColumn
(package private) int	sortDirection
(package private) static TCHAR	TableClass
(package private) static int	TableProc
(package private) boolean	tipRequested
(package private) static int	V_SCROLL_LIMIT
(package private) static int	VISTA_EXTRA
(package private) boolean	wasResized
(package private) boolean	wasSelected

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

backgroundMode, layout, layoutCount, lpwp, tabList

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

horizontalBar, verticalBar

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

accessible, background, backgroundImage, cursor, drawCount, font, foreground, handle, layoutData, menu, parent, region, toolTipText

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

CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE

Constructor Summary

Constructors

Constructor and Description
Table(Composite parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	_addListener(int eventType, Listener listener)
(package private) boolean	_checkGrow(int count)
(package private) void	_checkShrink()
(package private) void	_clearItems()
(package private) TableItem	_getItem(int index)
(package private) TableItem	_getItem(int index, boolean create)
(package private) TableItem	_getItem(int index, boolean create, int count)
(package private) void	_getItems(TableItem[] result, int count)
(package private) boolean	_hasItems()
(package private) void	_initItems()
(package private) void	_insertItem(int index, TableItem item, int count)
(package private) void	_removeItem(int index, int count)
(package private) void	_removeItems(int start, int index, int count)
(package private) void	_setItemCount(int count, int itemCount)
void	addSelectionListener(SelectionListener listener) Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the SelectionListener interface.
(package private) int	callWindowProc(int hwnd, int msg, int wParam, int lParam)
(package private) int	callWindowProc(int hwnd, int msg, int wParam, int lParam, boolean forceSelect)
(package private) LRESULT	CDDS_ITEMPOSTPAINT(NMLVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) LRESULT	CDDS_ITEMPREPAINT(NMLVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) LRESULT	CDDS_POSTPAINT(NMLVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) LRESULT	CDDS_PREPAINT(NMLVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) LRESULT	CDDS_SUBITEMPOSTPAINT(NMLVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) LRESULT	CDDS_SUBITEMPREPAINT(NMLVCUSTOMDRAW nmcd, int wParam, int lParam)
(package private) void	checkBuffered()
(package private) boolean	checkData(TableItem item, boolean redraw)
(package private) boolean	checkData(TableItem item, int index, boolean redraw)
(package private) boolean	checkHandle(int hwnd)
(package private) static int	checkStyle(int style)
protected void	checkSubclass() Checks that this class can be subclassed.
void	clear(int index) Clears the item at the given zero-relative index in the receiver.
void	clear(int[] indices) Clears the items at the given zero-relative indices in the receiver.
void	clear(int start, int end) Removes the items from the receiver which are between the given zero-relative start and end indices (inclusive).
void	clearAll() Clears all the items in the receiver.
Point	computeSize(int wHint, int hHint, boolean changed) Returns the preferred size of the receiver.
(package private) void	createHandle()
(package private) void	createHeaderToolTips()
(package private) void	createItem(TableColumn column, int index)
(package private) void	createItem(TableItem item, int index)
(package private) void	createWidget()
(package private) int	defaultBackground()
(package private) void	deregister()
void	deselect(int index) Deselects the item at the given zero-relative index in the receiver.
void	deselect(int[] indices) Deselects the items at the given zero-relative indices in the receiver.
void	deselect(int start, int end) Deselects the items at the given zero-relative indices in the receiver.
void	deselectAll() Deselects all selected items in the receiver.
(package private) void	destroyItem(TableColumn column)
(package private) void	destroyItem(TableItem item)
(package private) void	fixCheckboxImageList(boolean fixScroll)
(package private) void	fixCheckboxImageListColor(boolean fixScroll)
(package private) void	fixItemHeight(boolean fixScroll)
TableColumn	getColumn(int index) Returns the column at the given, zero-relative index in the receiver.
int	getColumnCount() Returns the number of columns contained in the receiver.
int[]	getColumnOrder() Returns an array of zero-relative integers that map the creation order of the receiver's items to the order in which they are currently being displayed.
TableColumn[]	getColumns() Returns an array of TableColumns which are the columns in the receiver.
(package private) int	getFocusIndex()
int	getGridLineWidth() Returns the width in pixels of a grid line.
int	getHeaderHeight() Returns the height of the receiver's header
boolean	getHeaderVisible() Returns true if the receiver's header is visible, and false otherwise.
TableItem	getItem(int index) Returns the item at the given, zero-relative index in the receiver.
TableItem	getItem(Point point) Returns the item at the given point in the receiver or null if no such item exists.
int	getItemCount() Returns the number of items contained in the receiver.
int	getItemHeight() Returns the height of the area which would be used to display one of the items in the receiver.
TableItem[]	getItems() Returns a (possibly empty) array of TableItems which are the items in the receiver.
boolean	getLinesVisible() Returns true if the receiver's lines are visible, and false otherwise.
TableItem[]	getSelection() Returns an array of TableItems that are currently selected in the receiver.
int	getSelectionCount() Returns the number of selected items contained in the receiver.
int	getSelectionIndex() Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected.
int[]	getSelectionIndices() Returns the zero-relative indices of the items which are currently selected in the receiver.
TableColumn	getSortColumn() Returns the column which shows the sort indicator for the receiver.
(package private) int	getSortColumnPixel()
int	getSortDirection() Returns the direction of the sort indicator for the receiver.
int	getTopIndex() Returns the zero-relative index of the item which is currently at the top of the receiver.
(package private) boolean	hasChildren()
(package private) boolean	hitTestSelection(int index, int x, int y)
(package private) int	imageIndex(Image image, int column)
(package private) int	imageIndexHeader(Image image)
int	indexOf(TableColumn column) Searches the receiver's list starting at the first column (index 0) until a column is found that is equal to the argument, and returns the index of that column.
int	indexOf(TableItem item) Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item.
(package private) boolean	isCustomToolTip()
(package private) boolean	isOptimizedRedraw()
boolean	isSelected(int index) Returns true if the item is selected, and false otherwise.
(package private) void	register()
(package private) void	releaseChildren(boolean destroy)
(package private) void	releaseWidget()
void	remove(int index) Removes the item from the receiver at the given zero-relative index.
void	remove(int[] indices) Removes the items from the receiver's list at the given zero-relative indices.
void	remove(int start, int end) Removes the items from the receiver which are between the given zero-relative start and end indices (inclusive).
void	removeAll() Removes all of the items from the receiver.
void	removeSelectionListener(SelectionListener listener) Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.
(package private) void	reskinChildren(int flags)
void	select(int index) Selects the item at the given zero-relative index in the receiver.
void	select(int[] indices) Selects the items at the given zero-relative indices in the receiver.
void	select(int start, int end) Selects the items in the range specified by the given zero-relative indices in the receiver.
void	selectAll() Selects all of the items in the receiver.
(package private) void	sendEraseItemEvent(TableItem item, NMLVCUSTOMDRAW nmcd, int lParam, Event measureEvent)
(package private) Event	sendEraseItemEvent(TableItem item, NMTTCUSTOMDRAW nmcd, int column, RECT cellRect)
(package private) Event	sendMeasureItemEvent(TableItem item, int row, int column, int hDC)
(package private) LRESULT	sendMouseDownEvent(int type, int button, int msg, int wParam, int lParam)
(package private) void	sendPaintItemEvent(TableItem item, NMLVCUSTOMDRAW nmcd)
(package private) Event	sendPaintItemEvent(TableItem item, NMTTCUSTOMDRAW nmcd, int column, RECT itemRect)
(package private) void	setBackgroundImage(int hBitmap)
(package private) void	setBackgroundPixel(int newPixel)
(package private) void	setBackgroundTransparent(boolean transparent)
(package private) void	setBounds(int x, int y, int width, int height, int flags, boolean defer)
(package private) void	setCheckboxImageList(int width, int height, boolean fixScroll)
void	setColumnOrder(int[] order) Sets the order that the items in the receiver should be displayed in to the given argument which is described in terms of the zero-relative ordering of when the items were added.
(package private) void	setCustomDraw(boolean customDraw)
(package private) void	setDeferResize(boolean defer)
(package private) void	setFocusIndex(int index)
void	setFont(Font font) Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.
(package private) void	setForegroundPixel(int pixel)
void	setHeaderVisible(boolean show) Marks the receiver's header as visible if the argument is true, and marks it invisible otherwise.
void	setItemCount(int count) Sets the number of items contained in the receiver.
(package private) void	setItemHeight(boolean fixScroll)
(package private) void	setItemHeight(int itemHeight) Sets the height of the area which would be used to display one of the items in the table.
void	setLinesVisible(boolean show) Marks the receiver's lines as visible if the argument is true, and marks it invisible otherwise.
void	setRedraw(boolean redraw) If the argument is false, causes subsequent drawing operations in the receiver to be ignored.
(package private) void	setScrollWidth(int width)
(package private) boolean	setScrollWidth(TableItem item, boolean force)
void	setSelection(int index) Selects the item at the given zero-relative index in the receiver.
void	setSelection(int[] indices) Selects the items at the given zero-relative indices in the receiver.
void	setSelection(int start, int end) Selects the items in the range specified by the given zero-relative indices in the receiver.
void	setSelection(TableItem item) Sets the receiver's selection to the given item.
void	setSelection(TableItem[] items) Sets the receiver's selection to be the given array of items.
void	setSortColumn(TableColumn column) Sets the column used by the sort indicator for the receiver.
void	setSortDirection(int direction) Sets the direction of the sort indicator for the receiver.
(package private) void	setSubImagesVisible(boolean visible)
(package private) void	setTableEmpty()
void	setTopIndex(int index) Sets the zero-relative index of the item which is currently at the top of the receiver.
void	showColumn(TableColumn column) Shows the column.
(package private) void	showItem(int index)
void	showItem(TableItem item) Shows the item.
void	showSelection() Shows the selection.
(package private) void	sort()
(package private) void	subclass()
(package private) RECT	toolTipInset(RECT rect)
(package private) RECT	toolTipRect(RECT rect)
(package private) java.lang.String	toolTipText(NMTTDISPINFO hdr)
(package private) void	unsubclass()
(package private) void	update(boolean all)
(package private) void	updateHeaderToolTips()
(package private) void	updateImages()
(package private) void	updateMenuLocation(Event event)
(package private) void	updateMoveable()
(package private) void	updateOrientation()
(package private) int	widgetStyle()
(package private) TCHAR	windowClass()
(package private) int	windowProc()
(package private) int	windowProc(int hwnd, int msg, int wParam, int lParam)
(package private) LRESULT	WM_CHAR(int wParam, int lParam)
(package private) LRESULT	WM_CONTEXTMENU(int wParam, int lParam)
(package private) LRESULT	WM_ERASEBKGND(int wParam, int lParam)
(package private) LRESULT	WM_GETOBJECT(int wParam, int lParam)
(package private) LRESULT	WM_HSCROLL(int wParam, int lParam)
(package private) LRESULT	WM_KEYDOWN(int wParam, int lParam)
(package private) LRESULT	WM_KILLFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONDBLCLK(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONDOWN(int wParam, int lParam)
(package private) LRESULT	WM_MOUSEHOVER(int wParam, int lParam)
(package private) LRESULT	WM_PAINT(int wParam, int lParam)
(package private) LRESULT	WM_RBUTTONDBLCLK(int wParam, int lParam)
(package private) LRESULT	WM_RBUTTONDOWN(int wParam, int lParam)
(package private) LRESULT	WM_SETFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_SETFONT(int wParam, int lParam)
(package private) LRESULT	WM_SETREDRAW(int wParam, int lParam)
(package private) LRESULT	WM_SIZE(int wParam, int lParam)
(package private) LRESULT	WM_SYSCOLORCHANGE(int wParam, int lParam)
(package private) LRESULT	WM_VSCROLL(int wParam, int lParam)
(package private) LRESULT	wmMeasureChild(int wParam, int lParam)
(package private) LRESULT	wmNotify(NMHDR hdr, int wParam, int lParam)
(package private) LRESULT	wmNotifyChild(NMHDR hdr, int wParam, int lParam)
(package private) LRESULT	wmNotifyHeader(NMHDR hdr, int wParam, int lParam)
(package private) LRESULT	wmNotifyToolTip(NMHDR hdr, int wParam, int lParam)
(package private) LRESULT	wmNotifyToolTip(NMTTCUSTOMDRAW nmcd, int lParam)

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

_getChildren, _getTabList, changed, checkComposited, computeTabList, copyArea, drawBackground, findDeferredControl, findMenus, fixChildren, fixTabList, getBackgroundMode, getChildren, getChildrenCount, getLayout, getLayoutDeferred, getTabList, hooksKeys, isLayoutDeferred, layout, layout, layout, layout, layout, markLayout, minimumSize, redrawChildren, releaseParent, removeControl, resizeChildren, resizeChildren, resizeEmbeddedHandle, sendResize, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setResizeChildren, setTabGroupFocus, setTabList, translateMnemonic, translateTraversal, updateBackgroundColor, updateBackgroundImage, updateBackgroundMode, updateFont, updateLayout, updateLayout, updateUIState, WM_GETDLGCODE, WM_GETFONT, WM_NCHITTEST, WM_PARENTNOTIFY, WM_PRINTCLIENT, WM_SYSCOMMAND, WM_UPDATEUISTATE, wmNCPaint

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

computeTrim, createScrollBar, destroyScrollBar, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar, scrolledHandle, widgetExtStyle, WM_MOUSEWHEEL, wmScroll, wmScrollWheel

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

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, binarySearch, borderHandle, checkBackground, checkBorder, checkGesture, checkMirrored, computeSize, computeTabGroup, computeTabRoot, defaultFont, defaultForeground, destroyWidget, dragDetect, dragDetect, dragDetect, drawBackground, drawBackground, drawBackground, drawImageBackground, drawThemeBackground, enableDrag, enableWidget, fillBackground, fillImageBackground, fillThemeBackground, findBackgroundControl, findBrush, findCursor, findImageControl, findMnemonic, findThemeControl, fixFocus, forceFocus, forceResize, getAccessible, getBackground, getBackgroundImage, getBackgroundPixel, getBorderWidth, getBounds, getClipboardText, getCodePage, getCursor, getDragDetect, getDrawing, getEnabled, getFont, getForeground, getForegroundPixel, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getPath, getRegion, getShell, getSize, getToolTipText, getTouchEnabled, getVisible, hasCursor, hasFocus, internal_dispose_GC, internal_new_GC, isActive, isEnabled, isFocusAncestor, isFocusControl, isReparentable, isShowing, isTabGroup, isTabItem, isVisible, mapEvent, menuShell, mnemonicHit, mnemonicMatch, moveAbove, moveBelow, new_Accessible, new_GC, pack, pack, print, printWidget, redraw, redraw, redraw, releaseHandle, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, sendFocusEvent, sendGestureEvent, sendMove, sendTouchEvent, setBackground, setBackground, setBackgroundImage, setBounds, setBounds, setBounds, setCapture, setCursor, setCursor, setDefaultFont, setDragDetect, setEnabled, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRadioFocus, setRadioSelection, setRegion, setSavedFocus, setSize, setSize, setTabItemFocus, setToolTipText, setToolTipText, setTouchEnabled, setVisible, showWidget, sort, toControl, toControl, toDisplay, toDisplay, topHandle, translateAccelerator, translateMnemonic, traverse, traverse, traverse, traverse, traverse, traverseEscape, traverseGroup, traverseItem, traverseMnemonic, traversePage, traverseReturn, update, widgetCreateStruct, widgetParent, WM_ACTIVATE, WM_CAPTURECHANGED, WM_CHANGEUISTATE, WM_CLEAR, WM_CLOSE, WM_COMMAND, WM_CTLCOLOR, WM_CUT, WM_DESTROY, WM_DRAWITEM, WM_ENDSESSION, WM_ENTERIDLE, WM_GESTURE, WM_GETMINMAXINFO, WM_HELP, WM_HOTKEY, WM_IME_CHAR, WM_IME_COMPOSITION_START, WM_IME_COMPOSITION, WM_IME_ENDCOMPOSITION, WM_INITMENUPOPUP, WM_INPUTLANGCHANGE, WM_KEYUP, WM_LBUTTONUP, WM_MBUTTONDBLCLK, WM_MBUTTONDOWN, WM_MBUTTONUP, WM_MEASUREITEM, WM_MENUCHAR, WM_MENUSELECT, WM_MOUSEACTIVATE, WM_MOUSEHWHEEL, WM_MOUSELEAVE, WM_MOUSEMOVE, WM_MOVE, WM_NCACTIVATE, WM_NCCALCSIZE, WM_NCLBUTTONDOWN, WM_NCPAINT, WM_NOTIFY, WM_PALETTECHANGED, WM_PASTE, WM_PRINT, WM_QUERYENDSESSION, WM_QUERYNEWPALETTE, WM_QUERYOPEN, WM_RBUTTONUP, WM_SETCURSOR, WM_SETTINGCHANGE, WM_SHOWWINDOW, WM_SYSCHAR, WM_SYSKEYDOWN, WM_SYSKEYUP, WM_TABLET_FLICK, WM_TIMER, WM_TOUCH, WM_UNDO, WM_UNINITMENUPOPUP, WM_WINDOWPOSCHANGED, WM_WINDOWPOSCHANGING, WM_XBUTTONDBLCLK, WM_XBUTTONDOWN, WM_XBUTTONUP, wmColorChild, wmCommandChild, wmDrawChild, wmScrollChild

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

addDisposeListener, addListener, checkBits, checkOpened, checkOrientation, checkParent, checkWidget, DeferWindowPos, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getName, getNameText, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, notifyListeners, postEvent, postEvent, release, removeDisposeListener, removeListener, removeListener, reskin, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, SetWindowPos, showMenu, showMenu, toString, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyDown, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp

Methods inherited from class java.lang.Object

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

Field Detail

items

TableItem[] items

keys

int[] keys

columns

TableColumn[] columns

columnCount

int columnCount

customCount

int customCount

keyCount

int keyCount

imageList

ImageList imageList

headerImageList

ImageList headerImageList

currentItem

TableItem currentItem

sortColumn

TableColumn sortColumn

focusRect

RECT focusRect

headerToolTipHandle

int headerToolTipHandle

ignoreCustomDraw

boolean ignoreCustomDraw

ignoreDrawForeground

boolean ignoreDrawForeground

ignoreDrawBackground

boolean ignoreDrawBackground

ignoreDrawFocus

boolean ignoreDrawFocus

ignoreDrawSelection

boolean ignoreDrawSelection

ignoreDrawHot

boolean ignoreDrawHot

customDraw

boolean customDraw

dragStarted

boolean dragStarted

explorerTheme

boolean explorerTheme

firstColumnImage

boolean firstColumnImage

fixScrollWidth

boolean fixScrollWidth

tipRequested

boolean tipRequested

wasSelected

boolean wasSelected

wasResized

boolean wasResized

painted

boolean painted

ignoreActivate

boolean ignoreActivate

ignoreSelect

boolean ignoreSelect

ignoreShrink

boolean ignoreShrink

ignoreResize

boolean ignoreResize

ignoreColumnMove

boolean ignoreColumnMove

ignoreColumnResize

boolean ignoreColumnResize

fullRowSelect

boolean fullRowSelect

itemHeight

int itemHeight

lastIndexOf

int lastIndexOf

lastWidth

int lastWidth

sortDirection

int sortDirection

resizeCount

int resizeCount

selectionForeground

int selectionForeground

hotIndex

int hotIndex

HeaderProc

static int HeaderProc

INSET

static final int INSET

See Also:

Constant Field Values

GRID_WIDTH

static final int GRID_WIDTH

See Also:

Constant Field Values

SORT_WIDTH

static final int SORT_WIDTH

See Also:

Constant Field Values

HEADER_MARGIN

static final int HEADER_MARGIN

See Also:

Constant Field Values

HEADER_EXTRA

static final int HEADER_EXTRA

See Also:

Constant Field Values

VISTA_EXTRA

static final int VISTA_EXTRA

See Also:

Constant Field Values

EXPLORER_EXTRA

static final int EXPLORER_EXTRA

See Also:

Constant Field Values

H_SCROLL_LIMIT

static final int H_SCROLL_LIMIT

See Also:

Constant Field Values

V_SCROLL_LIMIT

static final int V_SCROLL_LIMIT

See Also:

Constant Field Values

DRAG_IMAGE_SIZE

static final int DRAG_IMAGE_SIZE

See Also:

Constant Field Values

EXPLORER_THEME

static final boolean EXPLORER_THEME

See Also:

Constant Field Values

COMPRESS_ITEMS

static boolean COMPRESS_ITEMS

TableProc

static final int TableProc

TableClass

static final TCHAR TableClass

Constructor Detail

Table

public Table(Composite parent,
     int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

SWT.SINGLE, SWT.MULTI, SWT.CHECK, SWT.FULL_SELECTION, SWT.HIDE_SELECTION, SWT.VIRTUAL, SWT.NO_SCROLL, Widget.checkSubclass(), Widget.getStyle()

Method Detail

_addListener

void _addListener(int eventType,
                Listener listener)

Overrides:

_addListener in class Widget

_checkGrow

boolean _checkGrow(int count)

_checkShrink

void _checkShrink()

_clearItems

void _clearItems()

_getItem

TableItem _getItem(int index)

_getItem

TableItem _getItem(int index,
                 boolean create)

_getItem

TableItem _getItem(int index,
                 boolean create,
                 int count)

_getItems

void _getItems(TableItem[] result,
             int count)

_hasItems

boolean _hasItems()

_initItems

void _initItems()

_insertItem

void _insertItem(int index,
               TableItem item,
               int count)

_removeItem

void _removeItem(int index,
               int count)

_removeItems

void _removeItems(int start,
                int index,
                int count)

_setItemCount

void _setItemCount(int count,
                 int itemCount)

addSelectionListener

public void addSelectionListener(SelectionListener listener)

Adds the listener to the collection of listeners who will be notified when the user changes the receiver's selection, by sending it one of the messages defined in the SelectionListener interface.

When widgetSelected is called, the item field of the event object is valid. If the receiver has the SWT.CHECK style and the check selection changes, the event object detail field contains the value SWT.CHECK. widgetDefaultSelected is typically called when an item is double-clicked. The item field of the event object is valid for default selection, but the detail field is not used.

Parameters:

listener - the listener which should be notified when the user changes the receiver's selection

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

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

See Also:

SelectionListener, removeSelectionListener(org.eclipse.swt.events.SelectionListener), SelectionEvent

callWindowProc

int callWindowProc(int hwnd,
                 int msg,
                 int wParam,
                 int lParam)

Overrides:

callWindowProc in class Scrollable

callWindowProc

int callWindowProc(int hwnd,
                 int msg,
                 int wParam,
                 int lParam,
                 boolean forceSelect)

checkStyle

static int checkStyle(int style)

CDDS_ITEMPOSTPAINT

LRESULT CDDS_ITEMPOSTPAINT(NMLVCUSTOMDRAW nmcd,
                         int wParam,
                         int lParam)

CDDS_ITEMPREPAINT

LRESULT CDDS_ITEMPREPAINT(NMLVCUSTOMDRAW nmcd,
                        int wParam,
                        int lParam)

CDDS_POSTPAINT

LRESULT CDDS_POSTPAINT(NMLVCUSTOMDRAW nmcd,
                     int wParam,
                     int lParam)

CDDS_PREPAINT

LRESULT CDDS_PREPAINT(NMLVCUSTOMDRAW nmcd,
                    int wParam,
                    int lParam)

CDDS_SUBITEMPOSTPAINT

LRESULT CDDS_SUBITEMPOSTPAINT(NMLVCUSTOMDRAW nmcd,
                            int wParam,
                            int lParam)

CDDS_SUBITEMPREPAINT

LRESULT CDDS_SUBITEMPREPAINT(NMLVCUSTOMDRAW nmcd,
                           int wParam,
                           int lParam)

checkBuffered

void checkBuffered()

Overrides:

checkBuffered in class Composite

checkData

boolean checkData(TableItem item,
                boolean redraw)

checkData

boolean checkData(TableItem item,
                int index,
                boolean redraw)

checkHandle

boolean checkHandle(int hwnd)

Overrides:

checkHandle in class Control

checkSubclass

protected void checkSubclass()

Description copied from class: Widget

Checks that this class can be subclassed.

The SWT class library is intended to be subclassed only at specific, controlled points (most notably, Composite and Canvas when implementing new widgets). This method enforces this rule unless it is overridden.

IMPORTANT: By providing an implementation of this method that allows a subclass of a class which does not normally allow subclassing to be created, the implementer agrees to be fully responsible for the fact that any such subclass will likely fail between SWT releases and will be strongly platform specific. No support is provided for user-written classes which are implemented in this fashion.

The ability to subclass outside of the allowed SWT classes is intended purely to enable those not on the SWT development team to implement patches in order to get around specific limitations in advance of when those limitations can be addressed by the team. Subclassing should not be attempted without an intimate and detailed understanding of the hierarchy.

Overrides:

checkSubclass in class Composite

clear

public void clear(int index)

Clears the item at the given zero-relative index in the receiver. The text, icon and other attributes of the item are set to the default value. If the table was created with the SWT.VIRTUAL style, these attributes are requested again as needed.

Parameters:

index - the index of the item to clear

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

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

Since:

3.0

See Also:

SWT.VIRTUAL, SWT.SetData

clear

public void clear(int start,
         int end)

Removes the items from the receiver which are between the given zero-relative start and end indices (inclusive). The text, icon and other attributes of the items are set to their default values. If the table was created with the SWT.VIRTUAL style, these attributes are requested again as needed.

Parameters:

start - the start index of the item to clear

end - the end index of the item to clear

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if either the start or end are not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

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

Since:

3.0

See Also:

SWT.VIRTUAL, SWT.SetData

clear

public void clear(int[] indices)

Clears the items at the given zero-relative indices in the receiver. The text, icon and other attributes of the items are set to their default values. If the table was created with the SWT.VIRTUAL style, these attributes are requested again as needed.

Parameters:

indices - the array of indices of the items

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
• ERROR_NULL_ARGUMENT - if the indices array is null

SWTException -

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

Since:

3.0

See Also:

SWT.VIRTUAL, SWT.SetData

clearAll

public void clearAll()

Clears all the items in the receiver. The text, icon and other attributes of the items are set to their default values. If the table was created with the SWT.VIRTUAL style, these attributes are requested again as needed.

Throws:

SWTException -

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

Since:

3.0

See Also:

SWT.VIRTUAL, SWT.SetData

computeSize

public Point computeSize(int wHint,
                int hHint,
                boolean changed)

Description copied from class: Control

Returns the preferred size of the receiver.

The preferred size of a control is the size that it would best be displayed at. The width hint and height hint arguments allow the caller to ask a control questions such as "Given a particular width, how high does the control need to be to show all of the contents?" To indicate that the caller does not wish to constrain a particular dimension, the constant SWT.DEFAULT is passed for the hint.

If the changed flag is true, it indicates that the receiver's contents have changed, therefore any caches that a layout manager containing the control may have been keeping need to be flushed. When the control is resized, the changed flag will be false, so layout manager caches can be retained.

Overrides:

computeSize in class Composite

Parameters:

wHint - the width hint (can be SWT.DEFAULT)

hHint - the height hint (can be SWT.DEFAULT)

changed - true if the control's contents have changed, and false otherwise

Returns:

the preferred size of the control.

See Also:

Layout, Control.getBorderWidth(), Control.getBounds(), Control.getSize(), Control.pack(boolean), "computeTrim, getClientArea for controls that implement them"

createHandle

void createHandle()

Overrides:

createHandle in class Composite

createHeaderToolTips

void createHeaderToolTips()

createItem

void createItem(TableColumn column,
              int index)

createItem

void createItem(TableItem item,
              int index)

createWidget

void createWidget()

Overrides:

createWidget in class Scrollable

defaultBackground

int defaultBackground()

Overrides:

defaultBackground in class Control

deregister

void deregister()

Overrides:

deregister in class Control

deselect

public void deselect(int[] indices)

Deselects the items at the given zero-relative indices in the receiver. If the item at the given zero-relative index in the receiver is selected, it is deselected. If the item at the index was not selected, it remains deselected. Indices that are out of range and duplicate indices are ignored.

Parameters:

indices - the array of indices for the items to deselect

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the set of indices is null

SWTException -

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

deselect

public void deselect(int index)

Deselects the item at the given zero-relative index in the receiver. If the item at the index was already deselected, it remains deselected. Indices that are out of range are ignored.

Parameters:

index - the index of the item to deselect

Throws:

SWTException -

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

deselect

public void deselect(int start,
            int end)

Deselects the items at the given zero-relative indices in the receiver. If the item at the given zero-relative index in the receiver is selected, it is deselected. If the item at the index was not selected, it remains deselected. The range of the indices is inclusive. Indices that are out of range are ignored.

Parameters:

start - the start index of the items to deselect

end - the end index of the items to deselect

Throws:

SWTException -

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

deselectAll

public void deselectAll()

Deselects all selected items in the receiver.

Throws:

SWTException -

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

destroyItem

void destroyItem(TableColumn column)

destroyItem

void destroyItem(TableItem item)

fixCheckboxImageList

void fixCheckboxImageList(boolean fixScroll)

fixCheckboxImageListColor

void fixCheckboxImageListColor(boolean fixScroll)

fixItemHeight

void fixItemHeight(boolean fixScroll)

getColumn

public TableColumn getColumn(int index)

Returns the column at the given, zero-relative index in the receiver. Throws an exception if the index is out of range. Columns are returned in the order that they were created. If no TableColumns were created by the programmer, this method will throw ERROR_INVALID_RANGE despite the fact that a single column of data may be visible in the table. This occurs when the programmer uses the table like a list, adding items but never creating a column.

Parameters:

index - the index of the column to return

Returns:

the column at the given index

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

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

See Also:

getColumnOrder(), setColumnOrder(int[]), TableColumn.getMoveable(), TableColumn.setMoveable(boolean), SWT.Move

getColumnCount

public int getColumnCount()

Returns the number of columns contained in the receiver. If no TableColumns were created by the programmer, this value is zero, despite the fact that visually, one column of items may be visible. This occurs when the programmer uses the table like a list, adding items but never creating a column.

Returns:

the number of columns

Throws:

SWTException -

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

getColumnOrder

public int[] getColumnOrder()

Returns an array of zero-relative integers that map the creation order of the receiver's items to the order in which they are currently being displayed.

Specifically, the indices of the returned array represent the current visual order of the items, and the contents of the array represent the creation order of the items.

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 current visual order of the receiver's items

Throws:

SWTException -

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

Since:

3.1

See Also:

setColumnOrder(int[]), TableColumn.getMoveable(), TableColumn.setMoveable(boolean), SWT.Move

getColumns

public TableColumn[] getColumns()

Returns an array of TableColumns which are the columns in the receiver. Columns are returned in the order that they were created. If no TableColumns were created by the programmer, the array is empty, despite the fact that visually, one column of items may be visible. This occurs when the programmer uses the table like a list, adding items but never creating a column.

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 in the receiver

Throws:

SWTException -

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

See Also:

getColumnOrder(), setColumnOrder(int[]), TableColumn.getMoveable(), TableColumn.setMoveable(boolean), SWT.Move

getFocusIndex

int getFocusIndex()

getGridLineWidth

public int getGridLineWidth()

Returns the width in pixels of a grid line.

Returns:

the width of a grid line in pixels

Throws:

SWTException -

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

getHeaderHeight

public int getHeaderHeight()

Returns the height of the receiver's header

Returns:

the height of the header or zero if the header is not visible

Throws:

SWTException -

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

Since:

2.0

getHeaderVisible

public boolean getHeaderVisible()

Returns true if the receiver's header is visible, and false otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Returns:

the receiver's header's visibility state

Throws:

SWTException -

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

getItem

public TableItem getItem(int index)

Returns the item at the given, zero-relative index in the receiver. Throws an exception if the index is out of range.

Parameters:

index - the index of the item to return

Returns:

the item at the given index

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

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

getItem

public TableItem getItem(Point point)

Returns the item at the given point in the receiver or null if no such item exists. The point is in the coordinate system of the receiver.

The item that is returned represents an item that could be selected by the user. For example, if selection only occurs in items in the first column, then null is returned if the point is outside of the item. Note that the SWT.FULL_SELECTION style hint, which specifies the selection policy, determines the extent of the selection.

Parameters:

point - the point used to locate the item

Returns:

the item at the given point, or null if the point is not in a selectable item

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the point is null

SWTException -

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

getItemCount

public int getItemCount()

Returns the number of items contained in the receiver.

Returns:

the number of items

Throws:

SWTException -

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

getItemHeight

public int getItemHeight()

Returns the height of the area which would be used to display one of the items in the receiver.

Returns:

the height of one item

Throws:

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

public TableItem[] getItems()

Returns a (possibly empty) array of TableItems which are the items in the receiver.

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 in the receiver

Throws:

SWTException -

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

getLinesVisible

public boolean getLinesVisible()

Returns true if the receiver's lines are visible, and false otherwise. Note that some platforms draw grid lines while others may draw alternating row colors.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Returns:

the visibility state of the lines

Throws:

SWTException -

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

getSelection

public TableItem[] getSelection()

Returns an array of TableItems that are currently selected in the receiver. The order of the items is unspecified. An empty array indicates that no items are selected.

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

Returns:

an array representing the selection

Throws:

SWTException -

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

getSelectionCount

public int getSelectionCount()

Returns the number of selected items contained in the receiver.

Returns:

the number of selected items

Throws:

SWTException -

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

getSelectionIndex

public int getSelectionIndex()

Returns the zero-relative index of the item which is currently selected in the receiver, or -1 if no item is selected.

Returns:

the index of the selected item

Throws:

SWTException -

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

getSelectionIndices

public int[] getSelectionIndices()

Returns the zero-relative indices of the items which are currently selected in the receiver. The order of the indices is unspecified. The array is empty if no items are selected.

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

Returns:

the array of indices of the selected items

Throws:

SWTException -

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

getSortColumn

public TableColumn getSortColumn()

Returns the column which shows the sort indicator for the receiver. The value may be null if no column shows the sort indicator.

Returns:

the sort indicator

Throws:

SWTException -

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

Since:

3.2

See Also:

setSortColumn(TableColumn)

getSortColumnPixel

int getSortColumnPixel()

getSortDirection

public int getSortDirection()

Returns the direction of the sort indicator for the receiver. The value will be one of UP, DOWN or NONE.

Returns:

the sort direction

Throws:

SWTException -

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

Since:

3.2

See Also:

setSortDirection(int)

getTopIndex

public int getTopIndex()

Returns the zero-relative index of the item which is currently at the top of the receiver. This index can change when items are scrolled or new items are added or removed.

Returns:

the index of the top item

Throws:

SWTException -

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

hasChildren

boolean hasChildren()

hitTestSelection

boolean hitTestSelection(int index,
                       int x,
                       int y)

imageIndex

int imageIndex(Image image,
             int column)

imageIndexHeader

int imageIndexHeader(Image image)

indexOf

public int indexOf(TableColumn column)

Searches the receiver's list starting at the first column (index 0) until a column is found that is equal to the argument, and returns the index of that column. If no column is found, returns -1.

Parameters:

column - the search column

Returns:

the index of the column

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the column is null

SWTException -

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

indexOf

public int indexOf(TableItem item)

Searches the receiver's list starting at the first item (index 0) until an item is found that is equal to the argument, and returns the index of that item. If no item is found, returns -1.

Parameters:

item - the search item

Returns:

the index of the item

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null

SWTException -

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

isCustomToolTip

boolean isCustomToolTip()

isOptimizedRedraw

boolean isOptimizedRedraw()

isSelected

public boolean isSelected(int index)

Returns true if the item is selected, and false otherwise. Indices out of range are ignored.

Parameters:

index - the index of the item

Returns:

the selection state of the item at the index

Throws:

SWTException -

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

register

void register()

Overrides:

register in class Control

releaseChildren

void releaseChildren(boolean destroy)

Overrides:

releaseChildren in class Composite

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Composite

remove

public void remove(int[] indices)

Removes the items from the receiver's list at the given zero-relative indices.

Parameters:

indices - the array of indices of the items

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)
• ERROR_NULL_ARGUMENT - if the indices array is null

SWTException -

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

remove

public void remove(int index)

Removes the item from the receiver at the given zero-relative index.

Parameters:

index - the index for the item

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

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

remove

public void remove(int start,
          int end)

Removes the items from the receiver which are between the given zero-relative start and end indices (inclusive).

Parameters:

start - the start of the range

end - the end of the range

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_RANGE - if either the start or end are not between 0 and the number of elements in the list minus 1 (inclusive)

SWTException -

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

removeAll

public void removeAll()

Removes all of the items from the receiver.

Throws:

SWTException -

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

removeSelectionListener

public void removeSelectionListener(SelectionListener listener)

Removes the listener from the collection of listeners who will be notified when the user changes the receiver's selection.

Parameters:

listener - the listener which should no longer be notified

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the listener is null

SWTException -

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

See Also:

SelectionListener, addSelectionListener(SelectionListener)

select

public void select(int[] indices)

Selects the items at the given zero-relative indices in the receiver. The current selection is not cleared before the new items are selected.

If the item at a given index is not selected, it is selected. If the item at a given index was already selected, it remains selected. Indices that are out of range and duplicate indices are ignored. If the receiver is single-select and multiple indices are specified, then all indices are ignored.

Parameters:

indices - the array of indices for the items to select

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the array of indices is null

SWTException -

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

See Also:

setSelection(int[])

reskinChildren

void reskinChildren(int flags)

Overrides:

reskinChildren in class Composite

select

public void select(int index)

Selects the item at the given zero-relative index in the receiver. If the item at the index was already selected, it remains selected. Indices that are out of range are ignored.

Parameters:

index - the index of the item to select

Throws:

SWTException -

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

select

public void select(int start,
          int end)

Selects the items in the range specified by the given zero-relative indices in the receiver. The range of indices is inclusive. The current selection is not cleared before the new items are selected.

If an item in the given range is not selected, it is selected. If an item in the given range was already selected, it remains selected. Indices that are out of range are ignored and no items will be selected if start is greater than end. If the receiver is single-select and there is more than one item in the given range, then all indices are ignored.

Parameters:

start - the start of the range

end - the end of the range

Throws:

SWTException -

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

See Also:

setSelection(int,int)

selectAll

public void selectAll()

Selects all of the items in the receiver.

If the receiver is single-select, do nothing.

Throws:

SWTException -

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

sendEraseItemEvent

void sendEraseItemEvent(TableItem item,
                      NMLVCUSTOMDRAW nmcd,
                      int lParam,
                      Event measureEvent)

sendEraseItemEvent

Event sendEraseItemEvent(TableItem item,
                       NMTTCUSTOMDRAW nmcd,
                       int column,
                       RECT cellRect)

sendMeasureItemEvent

Event sendMeasureItemEvent(TableItem item,
                         int row,
                         int column,
                         int hDC)

sendMouseDownEvent

LRESULT sendMouseDownEvent(int type,
                         int button,
                         int msg,
                         int wParam,
                         int lParam)

sendPaintItemEvent

void sendPaintItemEvent(TableItem item,
                      NMLVCUSTOMDRAW nmcd)

sendPaintItemEvent

Event sendPaintItemEvent(TableItem item,
                       NMTTCUSTOMDRAW nmcd,
                       int column,
                       RECT itemRect)

setBackgroundImage

void setBackgroundImage(int hBitmap)

Overrides:

setBackgroundImage in class Control

setBackgroundPixel

void setBackgroundPixel(int newPixel)

Overrides:

setBackgroundPixel in class Control

setBackgroundTransparent

void setBackgroundTransparent(boolean transparent)

setBounds

void setBounds(int x,
             int y,
             int width,
             int height,
             int flags,
             boolean defer)

Overrides:

setBounds in class Composite

setColumnOrder

public void setColumnOrder(int[] order)

Sets the order that the items in the receiver should be displayed in to the given argument which is described in terms of the zero-relative ordering of when the items were added.

Parameters:

order - the new order to display the items

Throws:

SWTException -

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

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item order is null
• ERROR_INVALID_ARGUMENT - if the item order is not the same length as the number of items

Since:

3.1

See Also:

getColumnOrder(), TableColumn.getMoveable(), TableColumn.setMoveable(boolean), SWT.Move

setCustomDraw

void setCustomDraw(boolean customDraw)

setDeferResize

void setDeferResize(boolean defer)

setCheckboxImageList

void setCheckboxImageList(int width,
                        int height,
                        boolean fixScroll)

setFocusIndex

void setFocusIndex(int index)

setFont

public void setFont(Font font)

Description copied from class: Control

Sets the font that the receiver will use to paint textual information to the font specified by the argument, or to the default font for that kind of control if the argument is null.

Overrides:

setFont in class Control

Parameters:

font - the new font (or null)

setForegroundPixel

void setForegroundPixel(int pixel)

Overrides:

setForegroundPixel in class Control

setHeaderVisible

public void setHeaderVisible(boolean show)

Marks the receiver's header as visible if the argument is true, and marks it invisible otherwise.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Parameters:

show - the new visibility state

Throws:

SWTException -

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

setItemCount

public void setItemCount(int count)

Sets the number of items contained in the receiver.

Parameters:

count - the number of items

Throws:

SWTException -

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

Since:

3.0

setItemHeight

void setItemHeight(boolean fixScroll)

setItemHeight

void setItemHeight(int itemHeight)

Sets the height of the area which would be used to display one of the items in the table.

Parameters:

itemHeight - the height of one item

Throws:

SWTException -

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

Since:

3.2

setLinesVisible

public void setLinesVisible(boolean show)

Marks the receiver's lines as visible if the argument is true, and marks it invisible otherwise. Note that some platforms draw grid lines while others may draw alternating row colors.

If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Parameters:

show - the new visibility state

Throws:

SWTException -

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

setRedraw

public void setRedraw(boolean redraw)

Description copied from class: Control

If the argument is false, causes subsequent drawing operations in the receiver to be ignored. No drawing of any kind can occur in the receiver until the flag is set to true. Graphics operations that occurred while the flag was false are lost. When the flag is set to true, the entire widget is marked as needing to be redrawn. Nested calls to this method are stacked.

Note: This operation is a hint and may not be supported on some platforms or for some widgets.

Overrides:

setRedraw in class Control

Parameters:

redraw - the new redraw state

See Also:

Control.redraw(int, int, int, int, boolean), Control.update()

setScrollWidth

void setScrollWidth(int width)

setScrollWidth

boolean setScrollWidth(TableItem item,
                     boolean force)

setSelection

public void setSelection(int[] indices)

Selects the items at the given zero-relative indices in the receiver. The current selection is cleared before the new items are selected.

Indices that are out of range and duplicate indices are ignored. If the receiver is single-select and multiple indices are specified, then all indices are ignored.

Parameters:

indices - the indices of the items to select

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the array of indices is null

SWTException -

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

See Also:

deselectAll(), select(int[])

setSelection

public void setSelection(TableItem item)

Sets the receiver's selection to the given item. The current selection is cleared before the new item is selected.

If the item is not in the receiver, then it is ignored.

Parameters:

item - the item to select

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

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

Since:

3.2

setSelection

public void setSelection(TableItem[] items)

Sets the receiver's selection to be the given array of items. The current selection is cleared before the new items are selected.

Items that are not in the receiver are ignored. If the receiver is single-select and multiple items are specified, then all items are ignored.

Parameters:

items - the array of items

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the array of items is null
• ERROR_INVALID_ARGUMENT - if one of the items has been disposed

SWTException -

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

See Also:

deselectAll(), select(int[]), setSelection(int[])

setSelection

public void setSelection(int index)

Selects the item at the given zero-relative index in the receiver. The current selection is first cleared, then the new item is selected.

Parameters:

index - the index of the item to select

Throws:

SWTException -

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

See Also:

deselectAll(), select(int)

setSelection

public void setSelection(int start,
                int end)

Selects the items in the range specified by the given zero-relative indices in the receiver. The range of indices is inclusive. The current selection is cleared before the new items are selected.

Indices that are out of range are ignored and no items will be selected if start is greater than end. If the receiver is single-select and there is more than one item in the given range, then all indices are ignored.

Parameters:

start - the start index of the items to select

end - the end index of the items to select

Throws:

SWTException -

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

See Also:

deselectAll(), select(int,int)

setSortColumn

public void setSortColumn(TableColumn column)

Sets the column used by the sort indicator for the receiver. A null value will clear the sort indicator. The current sort column is cleared before the new column is set.

Parameters:

column - the column used by the sort indicator or null

Throws:

java.lang.IllegalArgumentException -

• ERROR_INVALID_ARGUMENT - if the column is disposed

SWTException -

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

Since:

3.2

setSortDirection

public void setSortDirection(int direction)

Sets the direction of the sort indicator for the receiver. The value can be one of UP, DOWN or NONE.

Parameters:

direction - the direction of the sort indicator

Throws:

SWTException -

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

Since:

3.2

setSubImagesVisible

void setSubImagesVisible(boolean visible)

setTableEmpty

void setTableEmpty()

setTopIndex

public void setTopIndex(int index)

Sets the zero-relative index of the item which is currently at the top of the receiver. This index can change when items are scrolled or new items are added and removed.

Parameters:

index - the index of the top item

Throws:

SWTException -

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

showColumn

public void showColumn(TableColumn column)

Shows the column. If the column is already showing in the receiver, this method simply returns. Otherwise, the columns are scrolled until the column is visible.

Parameters:

column - the column to be shown

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the column is null
• ERROR_INVALID_ARGUMENT - if the column has been disposed

SWTException -

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

Since:

3.0

showItem

void showItem(int index)

showItem

public void showItem(TableItem item)

Shows the item. If the item is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled until the item is visible.

Parameters:

item - the item to be shown

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the item is null
• ERROR_INVALID_ARGUMENT - if the item has been disposed

SWTException -

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

See Also:

showSelection()

showSelection

public void showSelection()

Shows the selection. If the selection is already showing in the receiver, this method simply returns. Otherwise, the items are scrolled until the selection is visible.

Throws:

SWTException -

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

See Also:

showItem(TableItem)

sort

void sort()

subclass

void subclass()

Overrides:

subclass in class Control

toolTipInset

RECT toolTipInset(RECT rect)

toolTipRect

RECT toolTipRect(RECT rect)

toolTipText

java.lang.String toolTipText(NMTTDISPINFO hdr)

Overrides:

toolTipText in class Composite

unsubclass

void unsubclass()

Overrides:

unsubclass in class Control

update

void update(boolean all)

Overrides:

update in class Control

updateHeaderToolTips

void updateHeaderToolTips()

updateImages

void updateImages()

Overrides:

updateImages in class Control

updateMenuLocation

void updateMenuLocation(Event event)

Overrides:

updateMenuLocation in class Widget

updateMoveable

void updateMoveable()

updateOrientation

void updateOrientation()

Overrides:

updateOrientation in class Composite

widgetStyle

int widgetStyle()

Overrides:

widgetStyle in class Composite

windowClass

TCHAR windowClass()

Overrides:

windowClass in class Scrollable

windowProc

int windowProc()

Overrides:

windowProc in class Scrollable

windowProc

int windowProc(int hwnd,
             int msg,
             int wParam,
             int lParam)

Overrides:

windowProc in class Control

WM_CHAR

LRESULT WM_CHAR(int wParam,
              int lParam)

Overrides:

WM_CHAR in class Control

WM_CONTEXTMENU

LRESULT WM_CONTEXTMENU(int wParam,
                     int lParam)

Overrides:

WM_CONTEXTMENU in class Control

WM_ERASEBKGND

LRESULT WM_ERASEBKGND(int wParam,
                    int lParam)

Overrides:

WM_ERASEBKGND in class Composite

WM_GETOBJECT

LRESULT WM_GETOBJECT(int wParam,
                   int lParam)

Overrides:

WM_GETOBJECT in class Control

WM_KEYDOWN

LRESULT WM_KEYDOWN(int wParam,
                 int lParam)

Overrides:

WM_KEYDOWN in class Control

WM_KILLFOCUS

LRESULT WM_KILLFOCUS(int wParam,
                   int lParam)

Overrides:

WM_KILLFOCUS in class Control

WM_LBUTTONDBLCLK

LRESULT WM_LBUTTONDBLCLK(int wParam,
                       int lParam)

Overrides:

WM_LBUTTONDBLCLK in class Control

WM_LBUTTONDOWN

LRESULT WM_LBUTTONDOWN(int wParam,
                     int lParam)

Overrides:

WM_LBUTTONDOWN in class Composite

WM_MOUSEHOVER

LRESULT WM_MOUSEHOVER(int wParam,
                    int lParam)

Overrides:

WM_MOUSEHOVER in class Control

WM_PAINT

LRESULT WM_PAINT(int wParam,
               int lParam)

Overrides:

WM_PAINT in class Composite

WM_RBUTTONDBLCLK

LRESULT WM_RBUTTONDBLCLK(int wParam,
                       int lParam)

Overrides:

WM_RBUTTONDBLCLK in class Control

WM_RBUTTONDOWN

LRESULT WM_RBUTTONDOWN(int wParam,
                     int lParam)

Overrides:

WM_RBUTTONDOWN in class Control

WM_SETFOCUS

LRESULT WM_SETFOCUS(int wParam,
                  int lParam)

Overrides:

WM_SETFOCUS in class Control

WM_SETFONT

LRESULT WM_SETFONT(int wParam,
                 int lParam)

Overrides:

WM_SETFONT in class Composite

WM_SETREDRAW

LRESULT WM_SETREDRAW(int wParam,
                   int lParam)

Overrides:

WM_SETREDRAW in class Control

WM_SIZE

LRESULT WM_SIZE(int wParam,
              int lParam)

Overrides:

WM_SIZE in class Composite

WM_SYSCOLORCHANGE

LRESULT WM_SYSCOLORCHANGE(int wParam,
                        int lParam)

Overrides:

WM_SYSCOLORCHANGE in class Composite

WM_HSCROLL

LRESULT WM_HSCROLL(int wParam,
                 int lParam)

Overrides:

WM_HSCROLL in class Scrollable

WM_VSCROLL

LRESULT WM_VSCROLL(int wParam,
                 int lParam)

Overrides:

WM_VSCROLL in class Scrollable

wmMeasureChild

LRESULT wmMeasureChild(int wParam,
                     int lParam)

Overrides:

wmMeasureChild in class Control

wmNotify

LRESULT wmNotify(NMHDR hdr,
               int wParam,
               int lParam)

Overrides:

wmNotify in class Composite

wmNotifyChild

LRESULT wmNotifyChild(NMHDR hdr,
                    int wParam,
                    int lParam)

Overrides:

wmNotifyChild in class Control

wmNotifyHeader

LRESULT wmNotifyHeader(NMHDR hdr,
                     int wParam,
                     int lParam)

wmNotifyToolTip

LRESULT wmNotifyToolTip(NMHDR hdr,
                      int wParam,
                      int lParam)

wmNotifyToolTip

LRESULT wmNotifyToolTip(NMTTCUSTOMDRAW nmcd,
                      int lParam)