com.ibm.commons.swt.controls
Class LookupList

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

All Implemented Interfaces:

com.ibm.commons.iloader.node.lookups.api.LookupListener, ICustomControl, java.util.EventListener, org.eclipse.swt.graphics.Drawable

public class LookupList
extends CustomList
implements com.ibm.commons.iloader.node.lookups.api.LookupListener

A List control that extends com.ibm.commons.swt.controls.custom.CustomList. This control has the added functionality that it can be constructed based on an ILookup.

See Also:

com.ibm.commons.iloader.node.lookups.api.ILookup}

Field Summary

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

handle

Constructor Summary

LookupList(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

java.lang.String	getFirstLineTitle() Used in conjunction with setFirstBlankLine(boolean).
ILookup	getLookup() Returns the lookup associated with this list box.
java.lang.String	getValue() If a lookup has been assigned to this control, then calling this method will return the 'code' associated with the currently selected 'label'.
boolean	isFirstBlankLine() Returns whether or not the first row of the listbox will be blank (default is false).
void	lookupChanged(ILookup lookup)
void	setFirstBlankLine(boolean firstBlankLine) Sets whether or not the first row of the listbox is empty by default.
void	setFirstLineTitle(java.lang.String firstLineTitle)
void	setLookup(ILookup lookup) Sets a lookup to be used in conjunction with this listbox.
void	setValue(java.lang.String value) Sets the value of the listbox.

Methods inherited from class com.ibm.commons.swt.controls.custom.CustomList

checkSubclass, computeSize, getCols, getId, getRows, setCols, setId, setRows

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

LookupList

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

getLookup

public ILookup getLookup()

Returns the lookup associated with this list box.

Returns:

returns an instance of ILookup, or null if a lookup has not been defined.

See Also:

com.ibm.commons.iloader.node.lookups.api.ILookup}

setLookup

public void setLookup(ILookup lookup)

Sets a lookup to be used in conjunction with this listbox. The lookup provides a way for the control to provide a 'UI' and a 'Model'. The lookup provides labels and codes. The labels are shown to the end user, but when 'getValue' is called on the widget the 'code' supplied by the lookup with be returned (as opposed to the label).

Parameters:

lookup - an instance of ILookup containing codes and labels

lookupChanged

public void lookupChanged(ILookup lookup)

Specified by:

lookupChanged in interface com.ibm.commons.iloader.node.lookups.api.LookupListener

getValue

public java.lang.String getValue()

If a lookup has been assigned to this control, then calling this method will return the 'code' associated with the currently selected 'label'. Otherwise the current value of the list is returned.

Returns:

returns a string

setValue

public void setValue(java.lang.String value)

Sets the value of the listbox. If the value is one of the codes in the lookup then the label correspondending to the code is set as the value of the listbox, otherwise the value passed into the method is set as the value of the listbox.

Parameters:

value - the desired value of the comobo box.

isFirstBlankLine

public boolean isFirstBlankLine()

Returns whether or not the first row of the listbox will be blank (default is false).

Returns:

setFirstBlankLine

public void setFirstBlankLine(boolean firstBlankLine)

Sets whether or not the first row of the listbox is empty by default. If true the first row of the listbox will always be empty.

Parameters:

firstBlankLine -

getFirstLineTitle

public java.lang.String getFirstLineTitle()

Used in conjunction with setFirstBlankLine(boolean). If the first row is set to be blank, and has a title, then the null value of the model will be assigned a lable for instance in some models it may be desirable to assign a value to the default case, e.g. '(default)'.

Returns:

setFirstLineTitle

public void setFirstLineTitle(java.lang.String firstLineTitle)