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

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Scrollable
              extended by org.eclipse.swt.widgets.Text
                  extended by com.ibm.commons.swt.controls.custom.CustomText
                      extended by com.ibm.commons.swt.data.controls.DCText
All Implemented Interfaces:
ICustomControl, IDataControl, IDataFieldControl, org.eclipse.swt.graphics.Drawable

public class DCText
extends CustomText
implements IDataFieldControl

A text control which may be bound to data.


Field Summary
protected  boolean honorModifyTextListener
           
protected  boolean isModified
           
 
Fields inherited from class org.eclipse.swt.widgets.Text
DELIMITER, LIMIT
 
Fields inherited from class org.eclipse.swt.widgets.Control
handle
 
Constructor Summary
DCText(org.eclipse.swt.widgets.Composite parent, int style)
          Constructs a new instance of the class given the parent Composite, and the style flags which are used to set the look/behavior of the control.
DCText(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 text control
 DataNode getDataNode()
          Returns the DataNode associated with this control.
 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 updateModelOnModify(boolean val)
          Used when it is necessary to bypass the modify-listener associated internally with the control.
 
Methods inherited from class com.ibm.commons.swt.controls.custom.CustomText
checkSubclass, computeSize, getCols, getDoubleValue, getId, getIntValue, getLongValue, getRows, getValidator, isWantTabs, resetTextToPriorValue, setCols, setDoubleValue, setId, setIntValue, setLongValue, setRows, setValidator, setWantTabs, validate
 
Methods inherited from class org.eclipse.swt.widgets.Text
addModifyListener, addSelectionListener, addVerifyListener, append, clearSelection, computeTrim, copy, cut, getBorderWidth, getCaretLineNumber, getCaretLocation, getCaretPosition, getCharCount, getDoubleClickEnabled, getEchoChar, getEditable, getLineCount, getLineDelimiter, getLineHeight, getMessage, getOrientation, getSelection, getSelectionCount, getSelectionText, getTabs, getText, getText, getTextChars, getTextLimit, getTopIndex, getTopPixel, insert, paste, removeModifyListener, removeSelectionListener, removeVerifyListener, selectAll, setDoubleClickEnabled, setEchoChar, setEditable, setMessage, setOrientation, setSelection, setSelection, setSelection, setTabs, setText, setTextChars, setTextLimit, setTopIndex, showSelection
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
getClientArea, 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, 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, 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
 

Field Detail

honorModifyTextListener

protected boolean honorModifyTextListener

isModified

protected boolean isModified
Constructor Detail

DCText

public DCText(org.eclipse.swt.widgets.Composite parent,
              int style)
Constructs a new instance of the class given the parent Composite, and the style flags which are used to set the look/behavior of 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

DCText

public DCText(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 text control

Specified by:
getControl in interface IDataControl
Returns:

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 -

updateModelOnModify

public void updateModelOnModify(boolean val)
Used when it is necessary to bypass the modify-listener associated internally with the control. When set to false only the keylistener associated with this control will be invoked when the contents of the control are modified.
Defaults to true.

Parameters:
boolean - - false if the modify listener is to be ignored.