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

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  com.ibm.commons.swt.data.controls.DCNavigator

All Implemented Interfaces:

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

public class DCNavigator
extends org.eclipse.swt.widgets.Composite
implements ICustomControl, IDataControl

A navigator control which is bound to data. This control consists of several buttons that allow for various model manipulations to occur. During control initialization the model is found, and the attribute that this control is associated with is sought from the model. If the attribute exists in the model then the attribute's value is associated with this control.

Field Summary

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

handle

Constructor Summary

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

void	createControls() Creates the controls.
org.eclipse.swt.widgets.Control	getControl() Returns the control which is bound to the Data, in this case the DCNavigator control.
DataNode	getDataNode() Returns the DataNode associated with this control.
DataNode.Factory	getFactory() Returns the DataNode.Factory that is associated with this button.
java.lang.String	getId() Returns the programmatic ID for this control.
void	setDataNode(DataNode dataNode) Sets the DataNode associated with this control.
void	setDataNodeBinding(DataNodeBinding dataNodeBinding)
void	setFactory(DataNode.Factory factory) Sets the DataNode.Factory that is used in conjunction with the action associated with this button.
void	setId(java.lang.String id) Sets the programmatic ID for this control.
void	updateControl() Sets the enablement of the buttons per the enablement status of the associated data model.

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

changed, checkSubclass, computeSize, 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

computeTrim, getBorderWidth, getClientArea, 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, 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

DCNavigator

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

getId

public java.lang.String getId()

Returns the programmatic ID for this control.

Specified by:

getId in interface ICustomControl

Returns:

String

setId

public void setId(java.lang.String id)

Sets the programmatic ID for this control.

Specified by:

setId in interface ICustomControl

Parameters:

String -

getControl

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

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

Specified by:

getControl in interface IDataControl

Returns:

createControls

public void createControls()

Creates the controls.

updateControl

public void updateControl()

Sets the enablement of the buttons per the enablement status of the associated data model.

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

getFactory

public DataNode.Factory getFactory()

Returns the DataNode.Factory that is associated with this button.

Returns:

setFactory

public void setFactory(DataNode.Factory factory)

Sets the DataNode.Factory that is used in conjunction with the action associated with this button. If this button is of type DCCommandButton.ACTION_ADD the factory will be responsible for creating new instances of the desired object each time the button is pressed.

Parameters:

factory -

See Also:

DataNode.Factory

setDataNodeBinding

public void setDataNodeBinding(DataNodeBinding dataNodeBinding)

Parameters:

dataNodeBinding -

See Also:

DataNodeBinding