com.ibm.commons.swt.data.controls
Class DCListBox

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.data.controls.DCListBox

All Implemented Interfaces:

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

public class DCListBox
extends CustomList
implements IDataFieldControl, com.ibm.commons.iloader.node.lookups.api.LookupListener

Composite ListBox bound to data.

Field Summary

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

handle

Constructor Summary

DCListBox(org.eclipse.swt.widgets.Composite parent, int style, java.lang.String id)
Constructs a new instance of the class given the parent Composite, the style flags which are used to set the look/behavior of the control, and an id property that can be used to programatically identify the control.

Method Summary

java.lang.String	getAttributeName() Description copied from com.ibm.commons.swt.data.controls.IDataFieldControl Returns the name of the attribute that the control is associated with, may be null.
org.eclipse.swt.widgets.Control	getControl() Returns the control which is bound to the Data, in this case the DCListBox control
DataNode	getDataNode() Returns the DataNode associated with this control.
java.lang.String	getFirstLineTitle() Used in conjunction with isFirstBlankLine().
ILookup	getLookup() Returns the lookup that is used to populate the contents of the control.
java.lang.String	getValue() Returns the value currently selected in the list box.
boolean	isFirstBlankLine() Returns whether or not the first item in the combo box should be null? The default value is false.
void	lookupChanged(ILookup lookup) Typically called by the lookup framework to notify controls when the values in a lookup object changed.
void	setAttributeName(java.lang.String attributeName) Description copied from com.ibm.commons.swt.data.controls.IDataFieldControl Sets the name of the attribute that the control is associated with.
void	setDataNode(DataNode dataNode) Sets the DataNode associated with this control.
void	setDataNodeBinding(DataNodeBinding dataNodeBinding)
void	setFirstBlankLine(boolean firstBlankLine) Sets whether or not the first line in the combo box will be blank.
void	setFirstLineTitle(java.lang.String firstLineTitle) Used in conjunction with isFirstBlankLine().
void	setLookup(ILookup lookup) Sets the lookup used to populate the contents of the control.
void	setValue(java.lang.String value) Sets the value of the current control.

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, 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, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFocus, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, 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

DCListBox

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

Constructs a new instance of the class given the parent Composite, the style flags which are used to set the look/behavior of the control, and an id property that can be used to programatically identify the control.

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

id - a String which can be used to programatically identify the control

Method Detail

getControl

public org.eclipse.swt.widgets.Control getControl()

Returns the control which is bound to the Data, in this case the DCListBox control

Specified by:

getControl in interface IDataControl

Returns:

getLookup

public ILookup getLookup()

Returns the lookup that is used to populate the contents of the control.

Returns:

ILookup

See Also:

ILookup

setLookup

public void setLookup(ILookup lookup)

Sets the lookup used to populate the contents of the control. A lookup is basically a simple model whereby the value of the data set by the control differs with what appears in the UI, analogous to a key-value pair.

Parameters:

lookup - - ILookup

lookupChanged

public void lookupChanged(ILookup lookup)

Typically called by the lookup framework to notify controls when the values in a lookup object changed.

Specified by:

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

getValue

public java.lang.String getValue()

Returns the value currently selected in the list box. If a lookup is being used then the 'code' corresponding to the currently displayed 'value' is returned.

Returns:

String

See Also:

com.ibm.commons.swt.data.controls.DCComboBox.lookup

setValue

public void setValue(java.lang.String value)

Sets the value of the current control. Note, if a lookup is in use the value set via this method should correspond if possible to one of the 'codes' defined in the lookup.

Parameters:

value - - String

See Also:

com.ibm.commons.swt.data.controls.DCComboBox.lookup

getDataNode

public DataNode getDataNode()

Returns the DataNode associated with this control. The DataNode is responsible for providing the model through which the control accesses data.

Returns:

com.ibm.commons.iloader.node.DataNode

See Also:

DataNode

setDataNode

public void setDataNode(DataNode dataNode)

Sets the DataNode associated with this control. The DataNode is responsible for providing the model through which the control accesses data.

See Also:

DataNode

setDataNodeBinding

public void setDataNodeBinding(DataNodeBinding dataNodeBinding)

Parameters:

dataNodeBinding -

See Also:

DataNodeBinding

getAttributeName

public java.lang.String getAttributeName()

Description copied from com.ibm.commons.swt.data.controls.IDataFieldControl
Returns the name of the attribute that the control is associated with, may be null.

Specified by:

getAttributeName in interface IDataFieldControl

Returns:

setAttributeName

public void setAttributeName(java.lang.String attributeName)

Description copied from com.ibm.commons.swt.data.controls.IDataFieldControl
Sets the name of the attribute that the control is associated with.

Specified by:

setAttributeName in interface IDataFieldControl

Parameters:

attributeName -

isFirstBlankLine

public boolean isFirstBlankLine()

Returns whether or not the first item in the combo box should be null? The default value is false. If true the first item in the combo will be null regardless of the values supplied via the lookup.

Returns:

boolean

setFirstBlankLine

public void setFirstBlankLine(boolean firstBlankLine)

Sets whether or not the first line in the combo box will be blank. If true the first line will be blank regardless of the values supplied via the lookup.

Parameters:

firstBlankLine -

getFirstLineTitle

public java.lang.String getFirstLineTitle()

Used in conjunction with isFirstBlankLine(). If the first line of the control is set to be blank then the title supplied by getFirstLineTitle() will be used as the text for the first line.

Returns:

String

setFirstLineTitle

public void setFirstLineTitle(java.lang.String firstLineTitle)

Used in conjunction with isFirstBlankLine(). If the first line of the control is set to be blank then the title set by setFirstLineTitle() will be used as the text for the first line.

Parameters:

String -