org.eclipse.cdt.ui.newui
Class MultiLineTextFieldEditor

java.lang.Object
  extended by org.eclipse.jface.preference.FieldEditor
      extended by org.eclipse.cdt.ui.newui.MultiLineTextFieldEditor

public class MultiLineTextFieldEditor
extends org.eclipse.jface.preference.FieldEditor

MultiLineTextFieldEditor. Field editor that is same as string field editor but will have the multi line text field for user input.


Field Summary
static int UNLIMITED
          Text limit constant (value -1) indicating unlimited text limit and width.
static int VALIDATE_ON_FOCUS_LOST
          Validation strategy constant (value 1) indicating that the editor should perform validation only when the text widget loses focus.
static int VALIDATE_ON_KEY_STROKE
          Validation strategy constant (value 0) indicating that the editor should perform validation after every key stroke.
 
Fields inherited from class org.eclipse.jface.preference.FieldEditor
IS_VALID, VALUE
 
Constructor Summary
MultiLineTextFieldEditor(java.lang.String name, java.lang.String labelText, org.eclipse.swt.widgets.Composite parent)
          Creates a string field editor of unlimited width.
MultiLineTextFieldEditor(java.lang.String name, java.lang.String labelText, int width, org.eclipse.swt.widgets.Composite parent)
          Creates a string field editor.
MultiLineTextFieldEditor(java.lang.String name, java.lang.String labelText, int width, int strategy, org.eclipse.swt.widgets.Composite parent)
          Creates a string field editor.
 
Method Summary
 java.lang.String getErrorMessage()
          Returns the error message that will be displayed when and if an error occurs.
 int getNumberOfControls()
          Returns the number of basic controls this field editor consists of.
 java.lang.String getStringValue()
          Returns the field editor's value.
 org.eclipse.swt.widgets.Text getTextControl(org.eclipse.swt.widgets.Composite parent)
          Returns this field editor's text control.
 boolean isEmptyStringAllowed()
          Returns whether an empty string is a valid value.
 boolean isValid()
          Returns whether this field editor contains a valid value.
 void setEmptyStringAllowed(boolean b)
          Sets whether the empty string is a valid value or not.
 void setErrorMessage(java.lang.String message)
          Sets the error message that will be displayed when and if an error occurs.
 void setFocus()
          Sets the focus to this field editor.
 void setStringValue(java.lang.String value)
          Sets this field editor's value.
 void setTextLimit(int limit)
          Sets this text field's text limit.
 void setValidateStrategy(int value)
          Sets the strategy for validating the text.
 void showErrorMessage()
          Shows the error message set via setErrorMessage.
 
Methods inherited from class org.eclipse.jface.preference.FieldEditor
dispose, fillIntoGrid, getFieldEditorFontName, getLabelControl, getLabelText, getPreferenceName, getPreferenceStore, load, loadDefault, presentsDefaultValue, setEnabled, setLabelText, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPropertyChangeListener, store
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VALIDATE_ON_KEY_STROKE

public static final int VALIDATE_ON_KEY_STROKE
Validation strategy constant (value 0) indicating that the editor should perform validation after every key stroke.

See Also:
setValidateStrategy(int), Constant Field Values

VALIDATE_ON_FOCUS_LOST

public static final int VALIDATE_ON_FOCUS_LOST
Validation strategy constant (value 1) indicating that the editor should perform validation only when the text widget loses focus.

See Also:
setValidateStrategy(int), Constant Field Values

UNLIMITED

public static int UNLIMITED
Text limit constant (value -1) indicating unlimited text limit and width.

Constructor Detail

MultiLineTextFieldEditor

public MultiLineTextFieldEditor(java.lang.String name,
                                java.lang.String labelText,
                                int width,
                                int strategy,
                                org.eclipse.swt.widgets.Composite parent)
Creates a string field editor. Use the method setTextLimit to limit the text.

Parameters:
name - the name of the preference this field editor works on
labelText - the label text of the field editor
width - the width of the text input field in characters, or UNLIMITED for no limit
strategy - either VALIDATE_ON_KEY_STROKE to perform on the fly checking (the default), or VALIDATE_ON_FOCUS_LOST to perform validation only after the text has been typed in
parent - the parent of the field editor's control
Since:
2.0

MultiLineTextFieldEditor

public MultiLineTextFieldEditor(java.lang.String name,
                                java.lang.String labelText,
                                int width,
                                org.eclipse.swt.widgets.Composite parent)
Creates a string field editor. Use the method setTextLimit to limit the text.

Parameters:
name - the name of the preference this field editor works on
labelText - the label text of the field editor
width - the width of the text input field in characters, or UNLIMITED for no limit
parent - the parent of the field editor's control

MultiLineTextFieldEditor

public MultiLineTextFieldEditor(java.lang.String name,
                                java.lang.String labelText,
                                org.eclipse.swt.widgets.Composite parent)
Creates a string field editor of unlimited width. Use the method setTextLimit to limit the text.

Parameters:
name - the name of the preference this field editor works on
labelText - the label text of the field editor
parent - the parent of the field editor's control
Method Detail

getErrorMessage

public java.lang.String getErrorMessage()
Returns the error message that will be displayed when and if an error occurs.

Returns:
the error message, or null if none

getNumberOfControls

public int getNumberOfControls()
Returns the number of basic controls this field editor consists of.

Specified by:
getNumberOfControls in class org.eclipse.jface.preference.FieldEditor
Returns:
the number of controls

getStringValue

public java.lang.String getStringValue()
Returns the field editor's value.

Returns:
the current value

getTextControl

public org.eclipse.swt.widgets.Text getTextControl(org.eclipse.swt.widgets.Composite parent)
Returns this field editor's text control.

The control is created if it does not yet exist

Parameters:
parent - the parent
Returns:
the text control

isEmptyStringAllowed

public boolean isEmptyStringAllowed()
Returns whether an empty string is a valid value.

Returns:
true if an empty string is a valid value, and false if an empty string is invalid
See Also:
setEmptyStringAllowed(boolean)

isValid

public boolean isValid()
Returns whether this field editor contains a valid value.

The default implementation of this framework method returns true. Subclasses wishing to perform validation should override both this method and refreshValidState.

Overrides:
isValid in class org.eclipse.jface.preference.FieldEditor
Returns:
true if the field value is valid, and false if invalid
See Also:
refreshValidState()

setEmptyStringAllowed

public void setEmptyStringAllowed(boolean b)
Sets whether the empty string is a valid value or not.

Parameters:
b - true if the empty string is allowed, and false if it is considered invalid

setErrorMessage

public void setErrorMessage(java.lang.String message)
Sets the error message that will be displayed when and if an error occurs.

Parameters:
message - the error message

setFocus

public void setFocus()
Sets the focus to this field editor.

The default implementation of this framework method does nothing. Subclasses may reimplement.

Overrides:
setFocus in class org.eclipse.jface.preference.FieldEditor

setStringValue

public void setStringValue(java.lang.String value)
Sets this field editor's value.

Parameters:
value - the new value, or null meaning the empty string

setTextLimit

public void setTextLimit(int limit)
Sets this text field's text limit.

Parameters:
limit - the limit on the number of character in the text input field, or UNLIMITED for no limit

setValidateStrategy

public void setValidateStrategy(int value)
Sets the strategy for validating the text.

Calling this method has no effect after createPartControl is called. Thus this method is really only useful for subclasses to call in their constructor. However, it has public visibility for backward compatibility.

Parameters:
value - either VALIDATE_ON_KEY_STROKE to perform on the fly checking (the default), or VALIDATE_ON_FOCUS_LOST to perform validation only after the text has been typed in

showErrorMessage

public void showErrorMessage()
Shows the error message set via setErrorMessage.