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

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.List
                  com.ibm.commons.swt.controls.custom.CustomList

All Implemented Interfaces:

ICustomControl, org.eclipse.swt.graphics.Drawable

Direct Known Subclasses:

DCListBox, DCNavListBox, LookupList

public class CustomList
extends org.eclipse.swt.widgets.List
implements ICustomControl

An extension of the standard SWT List class that allows the user to set the width of the control in columns and the height in rows (where a column is the average width of a character, and a row is the average height).
For convenience this widget also allows the user to associate an ID with the widget.

Field Summary

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

handle

Constructor Summary

CustomList(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	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.List

add, add, addSelectionListener, computeTrim, deselect, deselect, deselect, deselectAll, getBorderWidth, getClientArea, getFocusIndex, getItem, getItemCount, getItemHeight, getItems, getSelection, getSelectionCount, getSelectionIndex, getSelectionIndices, getTopIndex, indexOf, indexOf, isSelected, remove, remove, remove, remove, removeAll, removeSelectionListener, select, select, select, selectAll, setItem, setItems, setSelection, setSelection, setSelection, setSelection, setTopIndex, showSelection

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

getHorizontalBar, getVerticalBar

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

addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFocus, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, 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

CustomList

public CustomList(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

checkSubclass

protected void checkSubclass()

Overrides:

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

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.List

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