org.gvsig.coreplugin

Class PreferencesExtension

java.lang.Object

org.gvsig.andami.plugins.Extension

org.gvsig.coreplugin.PreferencesExtension

All Implemented Interfaces:

IExtension, IExtensionExecuteWithArgs, IExtensionQueryByAction

public class PreferencesExtension
extends Extension

Extension that provides support for visual application configuration through a Preferences dialog where the user can specify its own settings for general purpose aspects.

Adding new preference pages is made through ExtensionPoints by invoking this.extensionPoints.add("AplicationPreferences","YourIPreferencesClassName", yourIPreferencesPage); and then call DlgPreferences.refreshExtensionPoints();

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_FOLDER_PROPERTY_NAME
static String	PROJECTS_FOLDER_PROPERTY_NAME
static String	SYMBOL_LIBRARY_FOLDER_PROPERTY_NAME
static String	TEMPLATES_FOLDER_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
PreferencesExtension()

Method Summary

Modifier and Type	Method and Description
void	addPreferencesPage(IPreference pp)
void	execute(String actionCommand) This method is executed when the user clicks on any of the controls associated with this extension (menus, tools, etc).
void	initialize() Extension's initialization code should be here.
boolean	isEnabled() This method is invoked by Andami to check whether the extension (and its associated controls) is enabled or disabled.
boolean	isVisible() This method is invoked by Andami to check whether the extension (and its associated controls) is visible or hidden.
void	postInitialize() Extension's post-initialization code should be here.

Methods inherited from class org.gvsig.andami.plugins.Extension

canQueryByAction, execute, getPlugin, getStatus, getStatus, getText, isEnabled, isVisible, setPlugin, terminate

Methods inherited from class java.lang.Object

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

Field Detail

PROJECTS_FOLDER_PROPERTY_NAME

public static final String PROJECTS_FOLDER_PROPERTY_NAME

See Also:

Constant Field Values

DATA_FOLDER_PROPERTY_NAME

public static final String DATA_FOLDER_PROPERTY_NAME

See Also:

Constant Field Values

TEMPLATES_FOLDER_PROPERTY_NAME

public static final String TEMPLATES_FOLDER_PROPERTY_NAME

See Also:

Constant Field Values

SYMBOL_LIBRARY_FOLDER_PROPERTY_NAME

public static final String SYMBOL_LIBRARY_FOLDER_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

PreferencesExtension

public PreferencesExtension()

Method Detail

initialize

public void initialize()

Description copied from interface: IExtension

Extension's initialization code should be here. This method is called for all the extensions during Andami's initialization.

execute

public void execute(String actionCommand)

Description copied from interface: IExtension

This method is executed when the user clicks on any of the controls associated with this extension (menus, tools, etc).

Parameters:

actionCommand - An String specifying the action to execute. This is useful when there are different controls associated with the same extension.

isEnabled

public boolean isEnabled()

Description copied from interface: IExtension

This method is invoked by Andami to check whether the extension (and its associated controls) is enabled or disabled. Disabled controls (menus and buttons) are shown in light grey colour, and it is not possible to click on them.

Returns:

true if the extension should be enabled, false otherwise

isVisible

public boolean isVisible()

Description copied from interface: IExtension

This method is invoked by Andami to check whether the extension (and its associated controls) is visible or hidden.

Returns:

true if the extension should be visible, false otherwise

addPreferencesPage

public void addPreferencesPage(IPreference pp)

postInitialize

public void postInitialize()

Description copied from interface: IExtension

Extension's post-initialization code should be here. This method is called for all the extensions during Andami's initialization, after initialize() has been called for ALL the extensions.

Specified by:

postInitialize in interface IExtension

Overrides:

postInitialize in class Extension