|
RSE Release 3.0 |
|||||||||
| 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.rse.ui.propertypages.SystemStringFieldEditor
public class SystemStringFieldEditor
A preference page field editor that prompts for a string. Unlike the eclipse-supplied StringFieldEditor, this one allows use of RSE validators and massagers for error checking and massaging of the user-entered input prior to persisting.
| Field Summary |
|---|
| Fields inherited from class org.eclipse.jface.preference.FieldEditor |
|---|
HORIZONTAL_GAP, IS_VALID, VALUE |
| Constructor Summary | |
|---|---|
SystemStringFieldEditor(String name,
ResourceBundle rb,
String rbKey,
Composite parent)
Constructor for SystemStringFieldEditor |
|
| Method Summary | |
|---|---|
protected void |
adjustForNumColumns(int numColumns)
Adjust grid data to support the number of columns, after all field editors have been added to the page. |
protected void |
createModifyListener()
Creates a modify text listener used in per-keystroke validation |
protected void |
doFillIntoGrid(Composite parent,
int numColumns)
This is called by our parent's constructor, which is too soon for us! |
protected void |
doLoad()
Load the entry field contents from the preference store current value |
protected void |
doLoadDefault()
Load the entry field contents from the preference store default value |
protected void |
doOurFillIntoGrid()
Create controls |
protected void |
doStore()
Save the user-entered value to the preference store. |
int |
getNumberOfControls()
Return number of columns we need. |
protected Text |
getTextControl()
Returns this field editor's Text control. |
Text |
getTextControl(Composite parent)
Returns this field editor's text control. |
boolean |
isValid()
Override of parent to return validity state. |
protected void |
refreshValidState()
Override of parent to refresh validity state by checking if the input is valid. |
void |
setFocus()
Set focus |
void |
setMassager(ISystemMassager massager)
Set the massager that is used to affect the user-entered text before saving it to the preference store. |
void |
setToolTipText(String tip)
Allows setting of tooltip text |
void |
setValidator(ISystemValidator validator)
Set the validator to use per keystroke. |
protected void |
validate()
Validate contents of text field |
protected void |
valueChanged()
Informs this field editor's listener, if it has one, about a change to the value ( VALUE property) provided that the old and
new values are different. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SystemStringFieldEditor(String name,
ResourceBundle rb,
String rbKey,
Composite parent)
name - - the unique ID for this editor. Used as index in preference storerb - - the resource bundle from which to retrieve the mrirbKey - - the key into the resource bundle, to get the label (_LABEL and tooltip text (_TOOLTIPparent - - the parent composite to host this editor| Method Detail |
|---|
public void setValidator(ISystemValidator validator)
public void setMassager(ISystemMassager massager)
public int getNumberOfControls()
getNumberOfControls in class FieldEditorFieldEditor.getNumberOfControls()protected void doStore()
doStore in class FieldEditorFieldEditor.doStore()protected void doLoadDefault()
doLoadDefault in class FieldEditorFieldEditor.doLoadDefault()protected void doLoad()
doLoad in class FieldEditorFieldEditor.doLoad()
protected void doFillIntoGrid(Composite parent,
int numColumns)
doFillIntoGrid in class FieldEditorFieldEditor.doFillIntoGrid(Composite, int)protected void doOurFillIntoGrid()
protected void adjustForNumColumns(int numColumns)
adjustForNumColumns in class FieldEditorFieldEditor.adjustForNumColumns(int)protected Text getTextControl()
public Text getTextControl(Composite parent)
The control is created if it does not yet exist
parent - the parent
public void setToolTipText(String tip)
protected void createModifyListener()
protected void validate()
protected void valueChanged()
VALUE property) provided that the old and
new values are different.
This hook is not called when the text is initialized (or reset to the default value) from the preference store.
public boolean isValid()
isValid in class FieldEditorprotected void refreshValidState()
refreshValidState in class FieldEditorpublic void setFocus()
setFocus in class FieldEditor
|
RSE Release 3.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||