|
Eclipse Platform Release 3.1 |
|||||||||||
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.jface.preference.StringFieldEditor
org.eclipse.jface.preference.StringButtonFieldEditor
An abstract field editor for a string type preference that presents
a string input field with a change button to its right to edit the
input field's content. When the user presses the change button, the
abstract framework method changePressed()
gets called
to compute a new string.
Field Summary |
---|
Fields inherited from class org.eclipse.jface.preference.StringFieldEditor |
---|
UNLIMITED, VALIDATE_ON_FOCUS_LOST, VALIDATE_ON_KEY_STROKE |
Fields inherited from class org.eclipse.jface.preference.FieldEditor |
---|
HORIZONTAL_GAP, IS_VALID, VALUE |
Constructor Summary | |
---|---|
protected |
StringButtonFieldEditor()
Creates a new string button field editor |
protected |
StringButtonFieldEditor(String name,
String labelText,
Composite parent)
Creates a string button field editor. |
Method Summary | |
---|---|
protected void |
adjustForNumColumns(int numColumns)
Adjusts the horizontal span of this field editor's basic controls. |
protected abstract String |
changePressed()
Notifies that this field editor's change button has been pressed. |
protected void |
doFillIntoGrid(Composite parent,
int numColumns)
Fills this field editor's basic controls into the given parent. |
protected Button |
getChangeControl(Composite parent)
Get the change control. |
int |
getNumberOfControls()
Returns the number of basic controls this field editor consists of. |
protected Shell |
getShell()
Returns this field editor's shell. |
void |
setChangeButtonText(String text)
Sets the text of the change button. |
void |
setEnabled(boolean enabled,
Composite parent)
Set whether or not the controls in the field editor are enabled. |
Methods inherited from class org.eclipse.jface.preference.StringFieldEditor |
---|
checkState, doCheckState, doLoad, doLoadDefault, doStore, getErrorMessage, getStringValue, getTextControl, getTextControl, isEmptyStringAllowed, isValid, refreshValidState, setEmptyStringAllowed, setErrorMessage, setFocus, setStringValue, setTextLimit, setValidateStrategy, showErrorMessage, valueChanged |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected StringButtonFieldEditor()
protected StringButtonFieldEditor(String name, String labelText, Composite parent)
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 |
protected void adjustForNumColumns(int numColumns)
FieldEditor
Subclasses must implement this method to adjust the horizontal span of controls so they appear correct in the given number of columns.
The number of columns will always be equal to or greater than the
value returned by this editor's getNumberOfControls
method.
adjustForNumColumns
in class StringFieldEditor
protected abstract String changePressed()
Subclasses must implement this method to provide a corresponding
new string for the text field. If the returned value is null
,
the currently displayed value remains.
null
to leave the
old string showingprotected void doFillIntoGrid(Composite parent, int numColumns)
StringFieldEditor
The string field implementation of this FieldEditor
framework method contributes the text field. Subclasses may override
but must call super.doFillIntoGrid
.
doFillIntoGrid
in class StringFieldEditor
protected Button getChangeControl(Composite parent)
parent
-
public int getNumberOfControls()
FieldEditor
getNumberOfControls
in class StringFieldEditor
protected Shell getShell()
public void setChangeButtonText(String text)
text
- the new textpublic void setEnabled(boolean enabled, Composite parent)
FieldEditor
setEnabled
in class StringFieldEditor
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.