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

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.controls.custom.CustomComposite
                      com.ibm.commons.swt.data.editors.api.CompositeEditor
                          com.ibm.commons.swt.data.controls.DCCompositeEditor
                              com.ibm.commons.swt.data.controls.DCCompositeText

All Implemented Interfaces:

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

public class DCCompositeText
extends DCCompositeEditor

A text composite control that is bound to data.

Nested Class Summary

static interface

DCCompositeText.CallDialog An interface that allows implementors determine the desired behavior when a button is pressed to launch a dialog from a composite control.

Field Summary

Fields inherited from class com.ibm.commons.swt.data.editors.api.CompositeEditor

cmptdDialogButton, COMPUTED_IMG, COMPUTED_IMG_HC, COMPUTED_IMG_HOVER, COMPUTED_IMG_HOVER_HC, control, CUSTOM_EDITOR_IMG, CUSTOM_EDITOR_IMG_HC, delButton, dialogButton, extraLabel, IMG_BROWSEBUTTON, IMG_BROWSEBUTTON_HC, IMG_COMPUTED, IMG_VALUEBINDING, label, menuButton, NON_COMPUTED_IMG, NON_COMPUTED_IMG_HC, NON_COMPUTED_IMG_HOVER, NON_COMPUTED_IMG_HOVER_HC, realControl, realDialogButton

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

handle

Constructor Summary

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

DCCompositeText(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	callDialog(java.lang.String value) If a DialogButton is associated with this Composite control, the callDialog method will be called when the DialogButton is pressed.
DCCompositeText.CallDialog	getCallDialog() Returns the CallDialog interface associated with this control.
int	getCols() Returns the width of the current text control in columns.
java.lang.String	getDialogButtonText() Returns the text that is to appear on the dialog button.
int	getRows() Returns the height of the current text control in rows.
IValidator	getValidator() Returns the validator associated with the current text control.
boolean	isDialogButton() Returns whether or not this composite control has a dialog button associated with it.
void	setCallDialog(DCCompositeText.CallDialog callDialog) Sets the CallDialog interface associated with this control.
void	setCols(int cols) Sets the width of the current text control in columns.
void	setDialogButton(boolean dialogButton) Sets whether or not this composite control has a dialog button associated with it.
void	setDialogButtonText(java.lang.String dialogButtonText) Sets the text that is to appear on the dialog button.
void	setRows(int rows) Sets the height of the current text control in rows.
void	setValidator(IValidator validator) Sets the validator associated with the current text control.

Methods inherited from class com.ibm.commons.swt.data.controls.DCCompositeEditor

getAttributeName, getControl, getDataNode, getEditorOptions, getPropertyEditor, getPropertyEditorName, getPropertyEditorParameter, initEditor, setAttributeName, setDataNode, setDataNodeBinding, setPropertyEditor, setPropertyEditorName, setPropertyEditorParameter

Methods inherited from class com.ibm.commons.swt.data.editors.api.CompositeEditor

addCompositeChildrenListener, addListeners, addValueChangedListener, callDialog, callScriptDialog, checkBtnVisible, getComputedLabelString, getComputedLabelTooltip, getCurrentValueType, getEditor, getEditorControl, getLabel, getMenuButtonImage, getMenuButtonImageHover, getPropertyEditorScriptMode, getRealControl, getValue, handleDeleteButton, hasCmptdAccessBtn, hasMenuButton, initComputedLabel, initPropertyEditor, isCellEditor, isComputable, isPrimitiveCollectionItemNode, isPropertyEditorScriptModeFixed, postDisposeEditor, removeCompositeChildrenListener, removeValueChangedListener, setAccessibleListener, setEnabled, setHasCmptdAccessBtn, setHasMenuButton, setIsComputable, setLabel, setTraverseListener, setValue, showPopUpMenu, updateControls, updateValue

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

getId, getUpdater, setId, setUpdater

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

DCCompositeText

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

DCCompositeText

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

getCallDialog

public DCCompositeText.CallDialog getCallDialog()

Returns the CallDialog interface associated with this control. The interface is responsible for popping up a dialog when the com.ibm.commons.swt.data.controls.DCCompositeText.callDialog(String) is called.

Returns:

com.ibm.commons.swt.data.controls.DCCompositeText.CallDialog

See Also:

DCCompositeText.CallDialog

setCallDialog

public void setCallDialog(DCCompositeText.CallDialog callDialog)

Sets the CallDialog interface associated with this control. The interface is responsible for popping up a dialog when the com.ibm.commons.swt.data.controls.DCCompositeText.callDialog(String) is called.

Parameters:

callDialog -

See Also:

DCCompositeText.CallDialog

getCols

public int getCols()

Returns the width of the current text control in columns.

Returns:

int

getRows

public int getRows()

Returns the height of the current text control in rows.

Returns:

int

setCols

public void setCols(int cols)

Sets the width of the current text control in columns.

setRows

public void setRows(int rows)

Sets the height of the current text control in rows.

getValidator

public IValidator getValidator()

Returns the validator associated with the current text control. May be null.

Returns:

See Also:

IValidator

setValidator

public void setValidator(IValidator validator)

Sets the validator associated with the current text control. May be null. The validator will be queried for the validity of the contents of the control on each keystroke event and also on the focus lost event.

Parameters:

validator -

See Also:

IValidator

isDialogButton

public boolean isDialogButton()

Returns whether or not this composite control has a dialog button associated with it. If true extra room will be laid out for a button control which will perform a user defined action when pressed.

Returns:

setDialogButton

public void setDialogButton(boolean dialogButton)

Sets whether or not this composite control has a dialog button associated with it. If true extra room will be laid out for a button control which will perform a user defined action when pressed.

Parameters:

boolean -

getDialogButtonText

public java.lang.String getDialogButtonText()

Returns the text that is to appear on the dialog button.

Returns:

String

setDialogButtonText

public void setDialogButtonText(java.lang.String dialogButtonText)

Sets the text that is to appear on the dialog button.

Parameters:

dialogButtonText -

callDialog

public java.lang.String callDialog(java.lang.String value)

If a DialogButton is associated with this Composite control, the callDialog method will be called when the DialogButton is pressed.

Parameters:

value -

Returns:

String The value returned by the dialog which was invoked

See Also:

DialogButton