com.ibm.commons.swt.data.editors
Class MultilineTextEditor

java.lang.Object
  com.ibm.commons.swt.data.editors.api.PropertyEditor
      com.ibm.commons.swt.data.editors.api.AbstractTextEditor
          com.ibm.commons.swt.data.editors.MultilineTextEditor

All Implemented Interfaces:

IPropertyEditor

public class MultilineTextEditor
extends AbstractTextEditor

A text editor control which may span multiple lines.
id = com.ibm.std.MultiLine

Nested Class Summary

static class

MultilineTextEditor.InputDialog

Constructor Summary

MultilineTextEditor()

Method Summary

java.lang.String	callDialog(CompositeEditor parent, java.lang.String oldValue) Open a dialog to edit this property.
protected int	getTextStyle()
boolean	hasDialogButton(CompositeEditor parent) Return true if this property may be edited via a dialog button.

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

createControl, getCols, getRows, initControlValue, isImmediateUpdate, setCols, setId, setRows, stopEdit

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

addPropertyEditorUpdateListener, addValidator, getContextAttribute, getContextObject, getDefaultEditor, getDialogButtonAltText, getDialogButtonImage, getDialogButtonText, getEditor, getRenderedValue, getScriptMode, getTextValidator, getValidator, getWorkBenchPart, isScriptModeFixed, postModelUpdate, preModelUpdate, removePropertyEditorUpdateListener, setContextAttribute, setContextObject, setScriptMode, setValidator, setWorkBenchPart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultilineTextEditor

public MultilineTextEditor()

Method Detail

getTextStyle

protected int getTextStyle()

Overrides:

getTextStyle in class AbstractTextEditor

hasDialogButton

public boolean hasDialogButton(CompositeEditor parent)

Description copied from class: PropertyEditor

Return true if this property may be edited via a dialog button.

Overrides:

hasDialogButton in class PropertyEditor

Returns:

boolean

callDialog

public java.lang.String callDialog(CompositeEditor parent,
                                   java.lang.String oldValue)

Description copied from class: PropertyEditor

Open a dialog to edit this property. It is at the discretion of the PropertyEditor implementor to override this method in order to actually invoke the dialog, and return the appropriate string value to the PropertyEditor once the dialog is dismissed (via OK or Cancel).

Overrides:

callDialog in class PropertyEditor

Parameters:

parent - - The parent composite editor

oldValue - - The current value being edited

Returns:

the new property value after the dialog has been dismissed