org.gvsig.andami.plugins

Class Extension

java.lang.Object

org.gvsig.andami.plugins.Extension

All Implemented Interfaces:

IExtension, IExtensionExecuteWithArgs, IExtensionQueryByAction

Direct Known Subclasses:

LibraryExtension

public abstract class Extension
extends java.lang.Object
implements IExtension, IExtensionQueryByAction, IExtensionExecuteWithArgs

Extensions are the way in which plugins extend Andami. Extensions can add controls to user interface (GUI) and execute some code when controls are activated. Every class implementing IExtension is an extension, but directly implementing that interface is discouraged. The preferred way to create an extension is extending this absctract class.

Author:

Jorge Piera Llodrá (piera_jor@gva.es)

See Also:

IExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
Extension()

Method Summary

Modifier and Type	Method and Description
boolean	canQueryByAction()
void	execute(java.lang.String command, java.lang.Object[] args)
PluginServices	getPlugin()
IExtensionStatus	getStatus() Gets the status of the extension, which may be queried to check if the extension has some unsaved data or some associated background tasks.
IExtensionStatus	getStatus(IExtension extension)
java.lang.String	getText(java.lang.String msg)
boolean	isEnabled(java.lang.String action)
boolean	isVisible(java.lang.String action)
void	postInitialize() Extension's post-initialization code should be here.
void	setPlugin(PluginServices plugin)
void	terminate() Extension's termination code should be here.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.andami.plugins.IExtension

execute, initialize, isEnabled, isVisible

Field Detail

logger

protected static org.slf4j.Logger logger

Constructor Detail

Extension

public Extension()

Method Detail

canQueryByAction

public boolean canQueryByAction()

Specified by:

canQueryByAction in interface IExtensionQueryByAction

execute

public void execute(java.lang.String command,
                    java.lang.Object[] args)

Specified by:

execute in interface IExtensionExecuteWithArgs

getPlugin

public PluginServices getPlugin()

getStatus

public IExtensionStatus getStatus()

Description copied from interface: IExtension

Gets the status of the extension, which may be queried to check if the extension has some unsaved data or some associated background tasks.

Specified by:

getStatus in interface IExtension

Returns:

An IExtensionStatus object, containing the status of this extension.

See Also:

IExtensionStatus

getStatus

public IExtensionStatus getStatus(IExtension extension)

Specified by:

getStatus in interface IExtension

getText

public java.lang.String getText(java.lang.String msg)

isEnabled

public boolean isEnabled(java.lang.String action)

Specified by:

isEnabled in interface IExtensionQueryByAction

isVisible

public boolean isVisible(java.lang.String action)

Specified by:

isVisible in interface IExtensionQueryByAction

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

setPlugin

public void setPlugin(PluginServices plugin)

terminate

public void terminate()

Description copied from interface: IExtension

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

Specified by:

terminate in interface IExtension