org.opencms.workplace.tools

Class CmsToolGroup

java.lang.Object

org.opencms.workplace.tools.CmsToolGroup

public class CmsToolGroup
extends java.lang.Object

This is an admin tool group, it just generates the html code for the group structure.

Since:

6.0.0

Constructor Summary

Constructors

Constructor and Description
CmsToolGroup(java.lang.String id, java.lang.String name) Default Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAdminTool(CmsTool adminTool) Adds an admin tool.
void	addAdminTool(CmsTool adminTool, float position) Adds an admin tool at the given position.
java.util.List<CmsTool>	getAdminTools() Returns a list of admin tools.
java.lang.String	getId() Returns the id.
java.lang.String	getName() Returns the group name.
java.lang.String	groupHtml(CmsWorkplace wp) Returns the necessary html code.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsToolGroup

public CmsToolGroup(java.lang.String id,
                    java.lang.String name)

Default Constructor.

Parameters:

id - a unique id

name - the name of the group

Method Detail

addAdminTool

public void addAdminTool(CmsTool adminTool)

Adds an admin tool.

Parameters:

adminTool - the admin tool

See Also:

CmsIdentifiableObjectContainer.addIdentifiableObject(String, Object)

addAdminTool

public void addAdminTool(CmsTool adminTool,
                         float position)

Adds an admin tool at the given position.

Parameters:

adminTool - the admin tool

position - the position

See Also:

CmsIdentifiableObjectContainer.addIdentifiableObject(String, Object, float)

getAdminTools

public java.util.List<CmsTool> getAdminTools()

Returns a list of admin tools.

Returns:

a list of CmsTools

getId

public java.lang.String getId()

Returns the id.

Returns:

the id

getName

public java.lang.String getName()

Returns the group name.

Returns:

the group name

groupHtml

public java.lang.String groupHtml(CmsWorkplace wp)

Returns the necessary html code.

Parameters:

wp - the jsp page to write the code to

Returns:

html code