|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.preference.FieldEditor
org.eclipse.cdt.ui.newui.MultiLineTextFieldEditor
public class MultiLineTextFieldEditor
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 |
---|
public static final int VALIDATE_ON_KEY_STROKE
0
) indicating that
the editor should perform validation after every key stroke.
setValidateStrategy(int)
,
Constant Field Valuespublic static final int VALIDATE_ON_FOCUS_LOST
1
) indicating that
the editor should perform validation only when the text widget
loses focus.
setValidateStrategy(int)
,
Constant Field Valuespublic static int UNLIMITED
-1
) indicating unlimited
text limit and width.
Constructor Detail |
---|
public MultiLineTextFieldEditor(java.lang.String name, java.lang.String labelText, int width, int strategy, org.eclipse.swt.widgets.Composite parent)
setTextLimit
to limit the text.
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorwidth
- the width of the text input field in characters,
or UNLIMITED
for no limitstrategy
- 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 inparent
- the parent of the field editor's controlpublic MultiLineTextFieldEditor(java.lang.String name, java.lang.String labelText, int width, org.eclipse.swt.widgets.Composite parent)
setTextLimit
to limit the text.
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorwidth
- the width of the text input field in characters,
or UNLIMITED
for no limitparent
- the parent of the field editor's controlpublic MultiLineTextFieldEditor(java.lang.String name, java.lang.String labelText, org.eclipse.swt.widgets.Composite parent)
setTextLimit
to limit the text.
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorparent
- the parent of the field editor's controlMethod Detail |
---|
public java.lang.String getErrorMessage()
null
if nonepublic int getNumberOfControls()
getNumberOfControls
in class org.eclipse.jface.preference.FieldEditor
public java.lang.String getStringValue()
public org.eclipse.swt.widgets.Text getTextControl(org.eclipse.swt.widgets.Composite parent)
The control is created if it does not yet exist
parent
- the parent
public boolean isEmptyStringAllowed()
true
if an empty string is a valid value, and
false
if an empty string is invalidsetEmptyStringAllowed(boolean)
public boolean isValid()
The default implementation of this framework method
returns true
. Subclasses wishing to perform
validation should override both this method and
refreshValidState
.
isValid
in class org.eclipse.jface.preference.FieldEditor
true
if the field value is valid,
and false
if invalidrefreshValidState()
public void setEmptyStringAllowed(boolean b)
b
- true
if the empty string is allowed,
and false
if it is considered invalidpublic void setErrorMessage(java.lang.String message)
message
- the error messagepublic void setFocus()
The default implementation of this framework method does nothing. Subclasses may reimplement.
setFocus
in class org.eclipse.jface.preference.FieldEditor
public void setStringValue(java.lang.String value)
value
- the new value, or null
meaning the empty stringpublic void setTextLimit(int limit)
limit
- the limit on the number of character in the text
input field, or UNLIMITED
for no limitpublic void setValidateStrategy(int value)
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.
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 inpublic void showErrorMessage()
setErrorMessage
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |