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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DCCompositeCheckbox, DCCompositeCombo, DCCompositeLabel, DCCompositeTable, DCCompositeText

public class DCCompositeEditor
extends CompositeEditor
implements IDataFieldControl

A Composite editor that is associated with data and a model.

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

	DCCompositeEditor(org.eclipse.swt.widgets.Composite parent, int style) 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 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.
protected	DCCompositeEditor(org.eclipse.swt.widgets.Composite parent, int style, PropertyEditor propertyEditor)
protected	DCCompositeEditor(org.eclipse.swt.widgets.Composite parent, int style, PropertyEditor propertyEditor, java.lang.String id)

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 DCCompositeEditor control
DataNode	getDataNode() Returns the DataNode associated with this control.
protected ICompositeEditorOptions	getEditorOptions() An abstract method that returns the editor options (ICompositeEditorOptions) related to the property that the underlying PropertyEditor represents.
PropertyEditor	getPropertyEditor() Returns the property editor that is used to edit the associated attribute
java.lang.String	getPropertyEditorName() Returns the property editor id
java.lang.String	getPropertyEditorParameter() Returns the parameters to be used when creating the property editor
protected void	initEditor()
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	setPropertyEditor(PropertyEditor propertyEditor) Sets the property editor that is used to edit the associated attribute
void	setPropertyEditorName(java.lang.String propertyEditorName) Set the property editor id.
void	setPropertyEditorParameter(java.lang.String propertyEditorParameter) Sets the parameters to be used when creating the property editor.

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

DCCompositeEditor

public DCCompositeEditor(org.eclipse.swt.widgets.Composite parent,
                         int style)

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

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

DCCompositeEditor

protected DCCompositeEditor(org.eclipse.swt.widgets.Composite parent,
                            int style,
                            PropertyEditor propertyEditor)

DCCompositeEditor

protected DCCompositeEditor(org.eclipse.swt.widgets.Composite parent,
                            int style,
                            PropertyEditor propertyEditor,
                            java.lang.String id)

Method Detail

getEditorOptions

protected ICompositeEditorOptions getEditorOptions()

Description copied from class: CompositeEditor

An abstract method that returns the editor options (ICompositeEditorOptions) related to the property that the underlying PropertyEditor represents.

Specified by:

getEditorOptions in class CompositeEditor

Returns:

ICompositeEditorOptions

See Also:

ICompositeEditorOptions

getControl

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

Returns the control which is bound to the Data, in this case the DCCompositeEditor 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 -

getPropertyEditor

public PropertyEditor getPropertyEditor()

Returns the property editor that is used to edit the associated attribute

Returns:

setPropertyEditor

public void setPropertyEditor(PropertyEditor propertyEditor)

Sets the property editor that is used to edit the associated attribute

Parameters:

PropertyEditor -

getPropertyEditorName

public java.lang.String getPropertyEditorName()

Returns the property editor id

Returns:

String

setPropertyEditorName

public void setPropertyEditorName(java.lang.String propertyEditorName)

Set the property editor id. This id should match the id of the property editor as set in plugin.xml in the property editor definition.

Parameters:

propertyEditorName -

getPropertyEditorParameter

public java.lang.String getPropertyEditorParameter()

Returns the parameters to be used when creating the property editor

Returns:

setPropertyEditorParameter

public void setPropertyEditorParameter(java.lang.String propertyEditorParameter)

Sets the parameters to be used when creating the property editor.

Parameters:

propertyEditorParameter -

initEditor

protected void initEditor()