gov.nih.nlm.mms
Interface GUIConfigurable

All Superinterfaces:

Comparable, Configurable

All Known Subinterfaces:

Browser, BrowserRestrictor, ConceptContentSelector, ConceptManipulator, ConceptSelector, ConceptView, Filter, Finder, MetamorphoSysInputStream, MetamorphoSysOutputStream

All Known Implementing Classes:

AbstractBrowserRestrictor, AbstractConceptView, AbstractFilter, AbstractFinder, AbstractGUIConfigurable, AttributeTypesToRemoveFilter, CodeSearchFinder, ContentViewBrowserRestrictor, ContentViewBrowserRestrictorFilter, ContentViewFilter, CuiSearchFinder, ExpandableConceptView, ExpandableRawView, LanguagesToRemoveFilter, MRCXTBuilder, NLMFileMetamorphoSysInputStream, OriginalMRMetamorphoSysInputStream, OriginalMRMetamorphoSysOutputStream, PrecedenceFilter, RelationshipTypesToRemoveFilter, RemoveByTermgroupFilter, RichMRMetamorphoSysInputStream, RichMRMetamorphoSysOutputStream, SemanticTypesBrowserRestrictor, SemanticTypesBrowserRestrictorFilter, SemanticTypesToRemoveFilter, ShowAllBrowserRestrictor, SourceBrowserRestrictor, SourceBrowserRestrictorFilter, SourcesToRemoveFilter, SuppressibleTermgroupsFilter, TreeBrowserFinder, WordSearchFinder

public interface GUIConfigurable
extends Configurable, Comparable

Generically represents an object that can be configured by the MetamorphoSysGUI.

Author:

Deborah Shapiro

Method Summary

void	addDataChangeListener(DataChangeListener dcl) Adds a DataChangeListener that responds to configuration changes.
Color	getColor() Returns the Color that should be used to display the name.
GUIConfigurable	getGUIConfigurableForValidationFailure() Returns the GUIConfigurable whose tab should next be displayed to allow the user to correct an error or warning.
JPanel	getHelpPanel() Returns a JPanel that will be displayed when the user selects the corresponding menu item from the Help menu and will provide the user with detailed instructions on the tab's use.
String	getName() Returns the name.
JPanel	getPanel() Returns a JPanel containing configuration options.
String	getTabDescription() Returns the description to be used in conjunction with the panel when presented to the user.
String[]	getValidationErrors() Returns the messages indicating why validation failed.
String[]	getValidationWarnings() Returns warnings that were indicated during validation.
boolean	hasAdvancedOptions() Indicates whether or not an options menu item should be supplied for advanced configuration options.
boolean	hasDataChanged() Indicates whether or not the configuration information has changed.
void	removeDataChangeListener(DataChangeListener dcl) Removes the specified DataChangeListener.
void	resetDataChanged() Sets the data changed flag to false.
void	setDataChanged(boolean b) Sets the value of the data changed flag.
void	setPanelSelections() Updates the view to reflect the data model.
void	showOptions() Presents an advanced options GUI to the user.
boolean	validate() Indicates whether or not the validation rules have passed.

Methods inherited from interface gov.nih.nlm.mms.Configurable

getConfigurationDetails, getProperties, resetToDefaults, setConfiguration, setConfiguration, setProperties

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getPanel

JPanel getPanel()

Returns a JPanel containing configuration options.

Returns:

a JPanel containing configuration options

hasDataChanged

boolean hasDataChanged()

Indicates whether or not the configuration information has changed.

Returns:

true if data has changed; false otherwise

setDataChanged

void setDataChanged(boolean b)

Sets the value of the data changed flag.

Parameters:

b - the boolean value for the data changed flag

resetDataChanged

void resetDataChanged()

Sets the data changed flag to false.

addDataChangeListener

void addDataChangeListener(DataChangeListener dcl)

Adds a DataChangeListener that responds to configuration changes. Allows main GUI to record all changes to this gui in the undo/redo mechanism.

Parameters:

dcl - the DataChangeListener to add

removeDataChangeListener

void removeDataChangeListener(DataChangeListener dcl)

Removes the specified DataChangeListener.

Parameters:

dcl - the DataChangeListener to remove

getColor

Color getColor()

Returns the Color that should be used to display the name.

Returns:

the Color that should be used to display the name.

getName

String getName()

Returns the name.

Returns:

the name

getTabDescription

String getTabDescription()

Returns the description to be used in conjunction with the panel when presented to the user.

Returns:

the description

showOptions

void showOptions()

Presents an advanced options GUI to the user.

hasAdvancedOptions

boolean hasAdvancedOptions()

Indicates whether or not an options menu item should be supplied for advanced configuration options.

Returns:

true if so; false otherwise

getHelpPanel

JPanel getHelpPanel()

Returns a JPanel that will be displayed when the user selects the corresponding menu item from the Help menu and will provide the user with detailed instructions on the tab's use.

Returns:

the JPanel to be used when showing user help

setPanelSelections

void setPanelSelections()

Updates the view to reflect the data model.

validate

boolean validate()

Indicates whether or not the validation rules have passed.

Returns:

booleantrue if so; false otherwise

getValidationErrors

String[] getValidationErrors()

Returns the messages indicating why validation failed. Should only be called if validate() returns false.

Returns:

the failure messages

getValidationWarnings

String[] getValidationWarnings()

Returns warnings that were indicated during validation.

Returns:

the warning messages

getGUIConfigurableForValidationFailure

GUIConfigurable getGUIConfigurableForValidationFailure()

Returns the GUIConfigurable whose tab should next be displayed to allow the user to correct an error or warning.

Returns:

GUIConfigurable to be displayed