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

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

All Implemented Interfaces:

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

public class DCCompositeCombo
extends DCCompositeEditor

Combobox control binded to data.

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

DCCompositeCombo(org.eclipse.swt.widgets.Composite parent, int style, boolean isEditable, 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, a flag to determine if the values in the combo can be edited, and an id property that can be used to programatically identify the control.

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

int	getCols() Returns the number of columns wide the combo box is.
java.lang.String	getComboText() Returns the current value of the combo box
java.lang.String	getDefaultValue() Returns the default value of the control
java.lang.String	getDialogButtonText() Returns the text that is to appear on the dialog button.
java.lang.String	getFirstLineTitle() Used in conjunction with isFirstBlankLine().
com.ibm.commons.swt.data.controls.IListActions	getListActions() Returms a list of actions that can be performed by the combo box.
ILookup	getLookup() Returns the lookup that is used to populate the contents of the control.
boolean	isDialogButton() Returns whether or not this composite control has a dialog button associated with it.
boolean	isFirstBlankLine() Returns whether or not the first item in the combo box should be null? The default value is false.
void	setCols(int cols) Sets the number of columns wide the combo box should be.
void	setDefaultValue(java.lang.String text) Sets the default value of the control
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	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	setListActions(com.ibm.commons.swt.data.controls.IListActions listActions) Sets the list of actions that can be performed by the combo box.
void	setLookup(ILookup lookup) Sets the lookup used to populate the contents of the control.
void	updateControls() Updates the control value based on the value of the associated attribute in the model

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

DCCompositeCombo

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

DCCompositeCombo

public DCCompositeCombo(org.eclipse.swt.widgets.Composite parent,
                        int style,
                        boolean isEditable,
                        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, a flag to determine if the values in the combo can be edited, 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

isEditable - sets whether or not the values in the combo can be edited

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

Method Detail

getCols

public int getCols()

Returns the number of columns wide the combo box is.

Returns:

int

setCols

public void setCols(int cols)

Sets the number of columns wide the combo box should be. Each column is calculated to be the average width of a single character.

Parameters:

cols -

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 -

getListActions

public com.ibm.commons.swt.data.controls.IListActions getListActions()

Returms a list of actions that can be performed by the combo box.

Returns:

setListActions

public void setListActions(com.ibm.commons.swt.data.controls.IListActions listActions)

Sets the list of actions that can be performed by the combo box.

Parameters:

listActions -

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

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 -

getComboText

public java.lang.String getComboText()

Returns the current value of the combo box

Returns:

String

setDefaultValue

public void setDefaultValue(java.lang.String text)

Sets the default value of the control

Parameters:

value - String

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default value of the control

Returns:

String

updateControls

public void updateControls()

Updates the control value based on the value of the associated attribute in the model

Overrides:

updateControls in class CompositeEditor