net.sf.commonclipse.preferences
Class ComboFieldEditor

java.lang.Object
  org.eclipse.jface.preference.FieldEditor
      net.sf.commonclipse.preferences.ComboFieldEditor

Direct Known Subclasses:

ClassConstantFieldEditor

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

Implementation identical to StringFieldEditor but using a combo instead of a Text field.

Version:

$Revision: 1.4 $ ($Author: fgiust $)

Author:

fgiust

Field Summary

(package private) org.eclipse.swt.widgets.Combo	textField The text field, or null if none.
static int	UNLIMITED Text limit constant (value -1) indicating unlimited text limit and width.

Fields inherited from class org.eclipse.jface.preference.FieldEditor

HORIZONTAL_GAP, IS_VALID, VALUE

Constructor Summary

protected	ComboFieldEditor() Creates a new string field editor.
	ComboFieldEditor(java.lang.String name, java.lang.String labelText, org.eclipse.swt.widgets.Composite parent) Creates a string field editor of unlimited width.
	ComboFieldEditor(java.lang.String name, java.lang.String labelText, int width, org.eclipse.swt.widgets.Composite parent) Creates a string field editor.

Method Summary

protected void	adjustForNumColumns(int numColumns)
protected boolean	checkState() Checks whether the text input field contains a valid value or not.
protected void	clearErrorMessage()
protected boolean	doCheckState() Hook for subclasses to do specific state checks.
protected void	doFillIntoGrid(org.eclipse.swt.widgets.Composite parent, int numColumns)
protected void	doLoad()
protected void	doLoadDefault()
protected void	doStore()
java.lang.String	getErrorMessage() Returns the error message that will be displayed when and if an error occurs.
int	getNumberOfControls()
java.lang.String	getStringValue() Returns the field editor's value.
protected org.eclipse.swt.widgets.Combo	getTextControl() Returns this field editor's text control.
org.eclipse.swt.widgets.Combo	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()
protected void	refreshValidState()
void	setEmptyStringAllowed(boolean b) Sets whether the empty string is a valid value or not.
void	setEnabled(boolean enabled, org.eclipse.swt.widgets.Composite parent)
void	setErrorMessage(java.lang.String message) Sets the error message that will be displayed when and if an error occurs.
void	setFocus()
void	setPredefinedValues(java.lang.String[] strings) Sets a list of predefined values that must be shown in the combo.
void	setStringValue(java.lang.String value) Sets this field editor's value.
void	setTextLimit(int limit) Sets this text field's text limit.
void	showErrorMessage() Shows the error message set via setErrorMessage.
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 org.eclipse.jface.preference.FieldEditor

applyFont, checkParent, clearMessage, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, createControl, dispose, fillIntoGrid, fireStateChanged, fireValueChanged, getFieldEditorFontName, getLabelControl, getLabelControl, getLabelText, getPage, getPreferenceName, getPreferencePage, getPreferenceStore, init, load, loadDefault, presentsDefaultValue, setButtonLayoutData, setLabelText, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store

Methods inherited from class java.lang.Object

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

Field Detail

UNLIMITED

public static final int UNLIMITED

Text limit constant (value -1) indicating unlimited text limit and width.

See Also:

Constant Field Values

textField

org.eclipse.swt.widgets.Combo textField

The text field, or null if none.

Constructor Detail

ComboFieldEditor

protected ComboFieldEditor()

Creates a new string field editor.

ComboFieldEditor

public ComboFieldEditor(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

ComboFieldEditor

public ComboFieldEditor(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

checkState

protected boolean checkState()

Checks whether the text input field contains a valid value or not.

Returns:

true if the field value is valid, and false if invalid

doLoad

protected void doLoad()

Specified by:

doLoad in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.doLoad()

doLoadDefault

protected void doLoadDefault()

Specified by:

doLoadDefault in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.doLoadDefault()

doStore

protected void doStore()

Specified by:

doStore in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.doStore()

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()

Specified by:

getNumberOfControls in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.getNumberOfControls()

getStringValue

public java.lang.String getStringValue()

Returns the field editor's value.

Returns:

the current value

getTextControl

protected org.eclipse.swt.widgets.Combo getTextControl()

Returns this field editor's text control.

Returns:

the text control, or null if no text field is created yet

getTextControl

public org.eclipse.swt.widgets.Combo 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()

Overrides:

isValid in class org.eclipse.jface.preference.FieldEditor

See Also:

# isValid()

refreshValidState

protected void refreshValidState()

Overrides:

refreshValidState in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.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()

Overrides:

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

See Also:

FieldEditor.setFocus()

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

showErrorMessage

public void showErrorMessage()

Shows the error message set via setErrorMessage.

valueChanged

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.

This hook is not called when the text is initialized (or reset to the default value) from the preference store.

setEnabled

public void setEnabled(boolean enabled,
                       org.eclipse.swt.widgets.Composite parent)

Overrides:

setEnabled in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.setEnabled(boolean,Composite).

doCheckState

protected boolean doCheckState()

Hook for subclasses to do specific state checks.

The default implementation of this framework method does nothing and returns true. Subclasses should override this method to specific state checks.

Returns:

true if the field value is valid, and false if invalid

adjustForNumColumns

protected void adjustForNumColumns(int numColumns)

Specified by:

adjustForNumColumns in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.adjustForNumColumns(int)

doFillIntoGrid

protected void doFillIntoGrid(org.eclipse.swt.widgets.Composite parent,
                              int numColumns)

Specified by:

doFillIntoGrid in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.doFillIntoGrid(Composite, int)

setPredefinedValues

public void setPredefinedValues(java.lang.String[] strings)

Sets a list of predefined values that must be shown in the combo.

Parameters:

strings - array of Strings added to the combo

clearErrorMessage

protected void clearErrorMessage()

Overrides:

clearErrorMessage in class org.eclipse.jface.preference.FieldEditor

See Also:

FieldEditor.clearErrorMessage()