com.moximedia.ows.website
Class Toolset

java.lang.Object
  com.moximedia.ows.website.Toolset

All Implemented Interfaces:

java.io.Serializable

public class Toolset

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

Toolset()
Creates new AimsToolset

Method Summary

void	addIdentifyTool(Tool tool) Adds the tool to the toolset.
void	addPanTool(Tool tool) Adds the tool to the toolset.
void	addSelectTool(Tool tool) Adds the tool to the toolset.
void	addTool(Tool tool) Adds a tool to the toolset.
void	addZoomInTool(Tool tool) Adds the tool to the toolset.
void	addZoomOutTool(Tool tool) Adds the 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	getHelpUrl() Gets the help URL for the toolset.
java.lang.String	getIdentifyScript() Gets the identify script url.
Tool	getIdentifyTool() Gets the tool, or null if there isn't one.
java.lang.String	getIdentifyToolName() Gets the tool name, or "Identify" if there isn't one.
int	getLength() Gets the number of tools in the toolset.
java.lang.String	getName() Gets the name of the toolset.
Tool	getPanTool() Gets the tool, or null if there isn't one.
java.lang.String	getPanToolName() Gets the tool name, or "Pan" if there isn't one.
Tool	getSelectool() Gets the tool, or null if there isn't one.
java.lang.String	getSelectToolName() Gets the tool name, or "Select" if there isn't one.
Tool	getTool(int index)
Tool	getTool(java.lang.String toolName)
int	getToolMaximumHeight() Gets the maximum height of the tools in this toolset.
java.util.ArrayList	getTools() Gets the tools in this toolset.
Tool	getZoomInTool() Gets the tool, or null if there isn't one.
java.lang.String	getZoomInToolName() Gets the tool name, or "Zoom In" if there isn't one.
Tool	getZoomOutTool() Gets the tool, or null if there isn't one.
java.lang.String	getZoomOutToolName() Gets the tool name, or "Zoom Out" if there isn't one.
java.util.Iterator	iterator() Gets an iterator containing the tools in this toolset.
void	setXmlAttribute(Config conf, java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Toolset

public Toolset()

Creates new AimsToolset

Method Detail

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.

addTool

public void addTool(Tool 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 Tool getTool(int index)

getTool

public Tool getTool(java.lang.String toolName)

getTools

public java.util.ArrayList getTools()

Gets the tools in this toolset.

Returns:

The tools in this toolset.

iterator

public java.util.Iterator iterator()

Gets an iterator containing the tools in this toolset.

Returns:

The iterator of tools.

getToolMaximumHeight

public int getToolMaximumHeight()

Gets the maximum height of the tools in this toolset.

Returns:

The maximumn height.

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.

setXmlAttribute

public void setXmlAttribute(Config conf,
                            java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

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 XML element tag containing this attribute.

name - The XML attribute name.

value - The XML attribute value.

getIdentifyScript

public java.lang.String getIdentifyScript()

Gets the identify script url.

Returns:

The url, defaults to "imfIdentify.jsp" if there isn't an identify tool.

getIdentifyTool

public Tool getIdentifyTool()

Gets the tool, or null if there isn't one.

Returns:

The tool.

getIdentifyToolName

public java.lang.String getIdentifyToolName()

Gets the tool name, or "Identify" if there isn't one.

Returns:

The tool name.

addIdentifyTool

public void addIdentifyTool(Tool tool)

Adds the tool to the toolset. Only one tool of this type is accepted.

Parameters:

tool - The tool.

getPanTool

public Tool getPanTool()

Gets the tool, or null if there isn't one.

Returns:

The tool.

getPanToolName

public java.lang.String getPanToolName()

Gets the tool name, or "Pan" if there isn't one.

Returns:

The tool name.

addPanTool

public void addPanTool(Tool tool)

Adds the tool to the toolset. Only one tool of this type is accepted.

Parameters:

tool - The tool.

getSelectool

public Tool getSelectool()

Gets the tool, or null if there isn't one.

Returns:

The tool.

getSelectToolName

public java.lang.String getSelectToolName()

Gets the tool name, or "Select" if there isn't one.

Returns:

The tool name.

addSelectTool

public void addSelectTool(Tool tool)

Adds the tool to the toolset. Only one tool of this type is accepted.

Parameters:

tool - The tool.

getZoomInTool

public Tool getZoomInTool()

Gets the tool, or null if there isn't one.

Returns:

The tool.

getZoomInToolName

public java.lang.String getZoomInToolName()

Gets the tool name, or "Zoom In" if there isn't one.

Returns:

The tool name.

addZoomInTool

public void addZoomInTool(Tool tool)

Adds the tool to the toolset. Only one tool of this type is accepted.

Parameters:

tool - The tool.

getZoomOutTool

public Tool getZoomOutTool()

Gets the tool, or null if there isn't one.

Returns:

The tool.

getZoomOutToolName

public java.lang.String getZoomOutToolName()

Gets the tool name, or "Zoom Out" if there isn't one.

Returns:

The tool name.

addZoomOutTool

public void addZoomOutTool(Tool tool)

Adds the tool to the toolset. Only one tool of this type is accepted.

Parameters:

tool - The tool.