org.opencms.workplace.tools
Interface I_CmsToolHandler

All Known Implementing Classes:

A_CmsToolHandler

public interface I_CmsToolHandler

Interface for an admin tool handler.

These handlers are created and managed by the CmsToolManager.

Since:

6.0.0

Version:

$Revision: 1.15 $

Author:

Michael Moossen

Method Summary

String	getDisabledHelpText() Returns the help text if disabled.
String	getGroup() Returns the group.
String	getHelpText() Returns the help text.
String	getIconPath() Returns the path to the icon.
String	getLink() Returns the link to the tool.
String	getName() Returns the displayed name.
String	getParameters() Returns the needed parameters.
String	getPath() Returns the tool path to install the tool in.
float	getPosition() Returns the relative position in the group.
String	getShortName() Returns the name for the menu or navbar.
String	getSmallIconPath() Returns the path to an optional small(16x16) icon.
boolean	isEnabled(CmsObject cms) Returns the state of the admin tool for a given cms context.
boolean	isVisible(CmsObject cms) Returns the visibility flag for a given cms context.
boolean	setup(CmsObject cms, String resourcePath) Main method that somehow setups the admin tool handler.

Method Detail

getDisabledHelpText

public String getDisabledHelpText()

Returns the help text if disabled.

Returns:

the help text if disabled

getGroup

public String getGroup()

Returns the group.

Returns:

the group

getHelpText

public String getHelpText()

Returns the help text.

Returns:

the help text

getIconPath

public String getIconPath()

Returns the path to the icon.

Returns:

the path to the icon

getLink

public String getLink()

Returns the link to the tool.

Returns:

the link

getName

public String getName()

Returns the displayed name.

Returns:

the name

getParameters

public String getParameters()

Returns the needed parameters.

Returns:

the parameters

getPath

public String getPath()

Returns the tool path to install the tool in.

Returns:

the path

getPosition

public float getPosition()

Returns the relative position in the group.

Returns:

the position

getShortName

public String getShortName()

Returns the name for the menu or navbar.

Returns:

the short name

getSmallIconPath

public String getSmallIconPath()

Returns the path to an optional small(16x16) icon.

Returns:

the path to an optional small(16x16) icon

isEnabled

public boolean isEnabled(CmsObject cms)

Returns the state of the admin tool for a given cms context.

Parameters:

cms - the cms context

Returns:

true if enabled

isVisible

public boolean isVisible(CmsObject cms)

Returns the visibility flag for a given cms context.

Parameters:

cms - the cms context

Returns:

true if visible

setup

public boolean setup(CmsObject cms,
                     String resourcePath)

Main method that somehow setups the admin tool handler.

Parameters:

cms - the admin context (at opencms-workplace (re-)initialization time)

resourcePath - the resource path of the file/folder to use as admin tool

Returns:

false if something goes wrong