org.gvsig.help

Class HelpExtension

java.lang.Object

org.gvsig.andami.plugins.Extension

org.gvsig.help.HelpExtension

All Implemented Interfaces:

IExtension, IExtensionExecuteWithArgs, IExtensionQueryByAction

public class HelpExtension
extends Extension

Constructor Summary

Constructors

Constructor and Description
HelpExtension()

Method Summary

Modifier and Type	Method and Description
void	execute(String actionCommand) This method is executed when the user clicks on any of the controls associated with this extension (menus, tools, etc).
static String	getExtensionPath()
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

Constructor Detail

HelpExtension

public HelpExtension()

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

getExtensionPath

public static String getExtensionPath()

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