com.xmlmind.guiutil

Class PreferencesSheet

java.lang.Object

com.xmlmind.guiutil.PreferencesSheet

Direct Known Subclasses:

AppPreferencesSheet, DAVDriveOptions, FeaturesOptions, HelperApplicationsOptions, HunspellOptions, JSONFormatOptions, MasterDocumentOptions, NewOptions, PrintOptions, ProfilingOptions, ProxiesOptions, RevisionsOptions, SpellOptions, TextFormatOptions, ValidateOptions, XSCOptions

public class PreferencesSheet
extends Object

The representation of a preferences sheet (AKA property sheet).

Field Summary

Fields

Modifier and Type	Field and Description
protected PreferencesEditor	editor PreferencesEditor hosting this sheet.
protected boolean	filled Field private to the PreferencesEditor hosting this sheet.
protected String	label Caption of this sheet used by the PreferencesEditor.
protected String	name ID of this sheet.
protected PreferencesSheetPane	pane Panel implementing the GUI of this sheet.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PreferencesSheet() Constructs a preferences sheet nothaving an ID and a caption.
	PreferencesSheet(String name, String label) Constructs a preferences sheet having specified ID and caption.

Method Summary

Modifier and Type	Method and Description
void	applyPreferences(Preferences prefs) ``Applies'' the preferences found in specified object which are relevant to this sheet.
protected void	badField(JTextField field) Validation helper: beeps, move keyboard focus to specified text field and selects all text contained in this field.
protected void	badText(JTextArea text) Validation helper: beeps, move keyboard focus to specified text area and selects all text contained in this area.
protected double	checkDoubleField(JTextField field, double min, double max, double invalid) Validation helper: checks that specified field contains a valid double.
protected int	checkIntField(JTextField field, int min, int max, int invalid) Validation helper: checks that specified field contains a valid integer.
protected PreferencesSheetPane	createPane() Creates and returns the panel implementing the GUI of this sheet.
void	fillPane(Preferences prefs) Fills pane using preferences found in specified object.
void	focusPane() Requests focus for the first component contained in pane.
String	getLabel() Returns the caption of this sheet.
String	getName() Returns the unique ID of this sheet.
PreferencesSheetPane	getPane() Returns the panel implementing the GUI of this sheet.
protected void	selectPane() Validation helper: tells #preferencesEditor to display this sheet, unless this is already the case.
void	setLabel(String label) Changes the caption of this sheet to specified value.
String	toString() Returns the caption of this sheet.
boolean	validatePane(Preferences prefs) Validates preferences specified by the user using pane and updates specified object to reflect the changes made by the user.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

ID of this sheet. Unique within the PreferencesEditor hosting this sheet.

label

protected String label

Caption of this sheet used by the PreferencesEditor.

editor

protected PreferencesEditor editor

PreferencesEditor hosting this sheet.

filled

protected boolean filled

Field private to the PreferencesEditor hosting this sheet. Do not use.

pane

protected PreferencesSheetPane pane

Panel implementing the GUI of this sheet. Lazily created.

Constructor Detail

PreferencesSheet

public PreferencesSheet(String name,
                        String label)

Constructs a preferences sheet having specified ID and caption.

PreferencesSheet

protected PreferencesSheet()

Constructs a preferences sheet nothaving an ID and a caption. These required fields should be initialized by subclass.

Method Detail

getName

public String getName()

Returns the unique ID of this sheet.

setLabel

public void setLabel(String label)

Changes the caption of this sheet to specified value.

getLabel

public String getLabel()

Returns the caption of this sheet.

toString

public String toString()

Returns the caption of this sheet. Same as getLabel().

Overrides:

toString in class Object

getPane

public PreferencesSheetPane getPane()

Returns the panel implementing the GUI of this sheet. Before that, creates it using createPane() if needed to.

createPane

protected PreferencesSheetPane createPane()

Creates and returns the panel implementing the GUI of this sheet. Called once.

focusPane

public void focusPane()

Requests focus for the first component contained in pane. Default implementation does nothing at all.

fillPane

public void fillPane(Preferences prefs)

Fills pane using preferences found in specified object.

validatePane

public boolean validatePane(Preferences prefs)

Validates preferences specified by the user using pane and updates specified object to reflect the changes made by the user.

Parameters:

prefs - object updated to reflect the changes made by the user

Returns:

true if preferences specified by the user are valid; false otherwise.

applyPreferences

public void applyPreferences(Preferences prefs)

``Applies'' the preferences found in specified object which are relevant to this sheet. Applying means performing any useful side-effect. Default implementation does nothing at all.

checkIntField

protected int checkIntField(JTextField field,
                            int min,
                            int max,
                            int invalid)

Validation helper: checks that specified field contains a valid integer. If specified text field is found to contain an invalid value, badField(JTextField) is used to report the error.

Parameters:

field - text field containing the value to be checked

min - smallest valid value (inclusive)

max - largest valid value (inclusive)

invalid - value returned by this function when the content of specified text field is found to be invalid

Returns:

integer number contained in specified field if found valid; invalid otherwise.

checkDoubleField

protected double checkDoubleField(JTextField field,
                                  double min,
                                  double max,
                                  double invalid)

Validation helper: checks that specified field contains a valid double. If specified text field is found to contain an invalid value, badField(JTextField) is used to report the error.

Parameters:

field - text field containing the value to be checked

min - smallest valid value (inclusive)

max - largest valid value (inclusive)

invalid - value returned by this function when the content of specified text field is found to be invalid

Returns:

double number contained in specified field if found valid; invalid otherwise.

badField

protected void badField(JTextField field)

Validation helper: beeps, move keyboard focus to specified text field and selects all text contained in this field.

badText

protected void badText(JTextArea text)

Validation helper: beeps, move keyboard focus to specified text area and selects all text contained in this area.

selectPane

protected void selectPane()

Validation helper: tells #preferencesEditor to display this sheet, unless this is already the case.