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

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

All Implemented Interfaces:

ICustomControl, IDataControl, IDataFieldControl, org.eclipse.swt.graphics.Drawable

public class DCNavListBox
extends CustomList
implements IDataFieldControl

A navigation listbox which is associated with a data model.

Field Summary

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

handle

Constructor Summary

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

protected void	checkSubclass()
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 DCNavListBox control
DataNode	getDataNode() Returns the DataNode associated with this control.
org.eclipse.jface.viewers.ILabelProvider	getLabelProvider() Returns the label provider associated with the current list box.
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	setLabelProvider(org.eclipse.jface.viewers.ILabelProvider labelProvider) Sets a label provider that is to be used in conjunction with the current list box.

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

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

DCNavListBox

public DCNavListBox(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 DCNavListBox control

Specified by:

getControl in interface IDataControl

Returns:

checkSubclass

protected void checkSubclass()

Overrides:

checkSubclass in class CustomList

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 -

getLabelProvider

public org.eclipse.jface.viewers.ILabelProvider getLabelProvider()

Returns the label provider associated with the current list box.

Returns:

setLabelProvider

public void setLabelProvider(org.eclipse.jface.viewers.ILabelProvider labelProvider)

Sets a label provider that is to be used in conjunction with the current list box. The provider is queried with the object from the data model for a value and an image that corresponds to the current object.

Parameters:

labelProvider -

See Also:

ILabelProvider