com.moximedia.aims
Class AimsWebSiteToolset

java.lang.Object
  com.moximedia.aims.AimsWebSiteToolset

All Implemented Interfaces:

java.io.Serializable

public class AimsWebSiteToolset

extends java.lang.Object

implements java.io.Serializable

An AimsToolset contains a set of tools that can be used in an IMF web site.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Constructor Summary

AimsWebSiteToolset()
Creates new AimsToolset

Method Summary

void	addTool(AimsWebSiteTool tool) Adds a tool to the toolset.
java.lang.String	getActiveToolName() Gets the name of the tool that is active when the toolset is first shown.
java.lang.String	getDescription() Gets the description for the toolset.
java.lang.String	getHelpUrl() Gets the help URL for the toolset.
int	getLength() Gets the number of tools in the toolset.
int	getMaximumToolHeight() Gets the height of the tallest tool in the toolset.
java.lang.String	getName() Gets the name of the toolset.
AimsWebSiteTool	getTool(int index)
AimsWebSiteTool	getTool(java.lang.String toolName)
AimsWebSiteTool[]	getToolArray() Gets the tools in this toolset as an Array.
java.util.Vector	getTools() Gets the tools in this toolset as a Vector.
void	setAxlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value, AimsWebSiteConfig conf) Sets one of the attributes of this object using a string value.
void	setDescription(java.lang.String text) Sets the description for the toolset.
void	setHelpUrl(java.lang.String href) Sets the help URL for the toolset.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsWebSiteToolset

public AimsWebSiteToolset()

Creates new AimsToolset

Method Detail

getDescription

public java.lang.String getDescription()

Gets the description for the toolset.

Returns:

The description for the toolset.

setDescription

public void setDescription(java.lang.String text)

Sets the description for the toolset.

Parameters:

text - The description for the toolset.

getName

public java.lang.String getName()

Gets the name of the toolset.

Returns:

The name of the toolset.

getHelpUrl

public java.lang.String getHelpUrl()

Gets the help URL for the toolset.

Returns:

The help URL for the toolset.

setHelpUrl

public void setHelpUrl(java.lang.String href)

Sets the help URL for the toolset.

Parameters:

href - The help URL for the toolset.

addTool

public void addTool(AimsWebSiteTool tool)

Adds a tool to the toolset.

Parameters:

tool - The tool to add.

getLength

public int getLength()

Gets the number of tools in the toolset.

Returns:

The number of tools in the toolset.

getTool

public AimsWebSiteTool getTool(int index)

getTool

public AimsWebSiteTool getTool(java.lang.String toolName)

getTools

public java.util.Vector getTools()

Gets the tools in this toolset as a Vector.

Returns:

The tools in this toolset as a Vector.

getToolArray

public AimsWebSiteTool[] getToolArray()

Gets the tools in this toolset as an Array.

Returns:

The tools in this toolset as an Array.

getActiveToolName

public java.lang.String getActiveToolName()

Gets the name of the tool that is active when the toolset is first shown.

Returns:

The name of the tool that is active when the toolset is first shown.

getMaximumToolHeight

public int getMaximumToolHeight()

Gets the height of the tallest tool in the toolset.

Returns:

The height, in pixels.

setAxlAttribute

public void setAxlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value,
                            AimsWebSiteConfig conf)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.