com.ibm.commons.swt.controls.custom
Class CustomTable

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
                      com.ibm.commons.swt.controls.custom.CustomTable

All Implemented Interfaces:

ICustomControl, org.eclipse.swt.graphics.Drawable

Direct Known Subclasses:

DCTable

public class CustomTable
extends org.eclipse.swt.widgets.Table
implements ICustomControl

An extension of the standard SWT Table class.
This class automatically takes care of many of the sizing issues that are normally associated with SWT Tables, such as sizing columns appropriately. This extension allows columns to define how they are to be sized within the table. Columns can control the amount of space they take up within the table by defining if they are to take up:

• A predefined number of pixels
• A predefined percentage of space
• A predefined number of characters
• The remaining width available in the table

For convenience this widget also allows the user to associate an ID with the widget.

See Also:

com.ibm.commons.swt.controls.custom.CustomTableColumn}

Field Summary

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

handle

Constructor Summary

CustomTable(org.eclipse.swt.widgets.Composite parent, int style, java.lang.String id)
Constructs a new instance of the class given the parent Composite, a style value describing its behavior and appearance, and id which can be used to later identify this control.

Method Summary

protected void	checkSubclass()
org.eclipse.swt.graphics.Point	computeSize(int wHint, int hHint, boolean changed)
int	getCols() Returns the width of the widget in columns.
java.lang.String	getId() Returns a string identifier associated with the current widget/control
int	getRows() Returns the height of the widget in rows.
void	redrawRow(int sel)
void	removeAllColumns()
void	setBounds(int x, int y, int width, int height)
void	setCols(int cols) Sets the width of the widget in columns.
void	setId(java.lang.String id) Sets a string identifier on the current widget/control.
void	setRows(int rows) Sets the height of the widget in rows.

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

addSelectionListener, clear, clear, clear, clearAll, computeTrim, deselect, deselect, deselect, deselectAll, getBorderWidth, getClientArea, getColumn, getColumnCount, getColumnOrder, getColumns, getGridLineWidth, getHeaderHeight, getHeaderVisible, getItem, getItem, getItemCount, getItemHeight, getItems, getLinesVisible, getSelection, getSelectionCount, getSelectionIndex, getSelectionIndices, getSortColumn, getSortDirection, getTopIndex, indexOf, indexOf, isSelected, remove, remove, remove, removeAll, removeSelectionListener, select, select, select, selectAll, setColumnOrder, setHeaderVisible, setItemCount, setLinesVisible, setRedraw, setSelection, setSelection, setSelection, setSelection, setSelection, setSortColumn, setSortDirection, setTopIndex, showColumn, showItem, showSelection

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

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

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

getHorizontalBar, 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, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, 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, setBackground, setBackgroundImage, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRegion, setSize, setSize, 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, getStyle, 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

Constructor Detail

CustomTable

public CustomTable(org.eclipse.swt.widgets.Composite parent,
                   int style,
                   java.lang.String id)

Constructs a new instance of the class given the parent Composite, a style value describing its behavior and appearance, and id which can be used to later identify this control.

Parameters:

parent - - a Composite control which will be the parent of the new instance (CANNOT be null).

style - - the style of the control to construct.

id - - the programmatic ID of the control once constructed.

Method Detail

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Overrides:

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

checkSubclass

protected void checkSubclass()

Overrides:

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

removeAllColumns

public void removeAllColumns()

getCols

public int getCols()

Returns the width of the widget in columns. A column is defined as the average width of a character as defined by SWT's FontMetrics class.

Returns:

An int value representing the column width of this control

See Also:

org.eclipse.swt.graphics.FontMetrics}

setCols

public void setCols(int cols)

Sets the width of the widget in columns. A column is defined as the average width of a character as defined by SWT's FontMetrics class.

Parameters:

numberOfCols - An int value, representing the number of columns

See Also:

org.eclipse.swt.graphics.FontMetrics}

getRows

public int getRows()

Returns the height of the widget in rows. A row is defined as the average height of a character as defined by SWT's FontMetrics class.

Returns:

An int value representing the row height of this control

See Also:

org.eclipse.swt.graphics.FontMetrics}

setRows

public void setRows(int rows)

Sets the height of the widget in rows. A row is defined as the average height of a character as defined by SWT's FontMetrics class.

Parameters:

numOfRows - An int value, representing the number of rows

See Also:

org.eclipse.swt.graphics.FontMetrics}

computeSize

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

Overrides:

computeSize in class org.eclipse.swt.widgets.Table

getId

public java.lang.String getId()

Description copied from interface: ICustomControl

Returns a string identifier associated with the current widget/control

Specified by:

getId in interface ICustomControl

Returns:

String

setId

public void setId(java.lang.String id)

Description copied from interface: ICustomControl

Sets a string identifier on the current widget/control.

Specified by:

setId in interface ICustomControl

redrawRow

public void redrawRow(int sel)