com.moximedia.aims
Class AimsWebSiteTool

java.lang.Object
  com.moximedia.aims.AimsWebSiteTool

All Implemented Interfaces:

java.io.Serializable

public class AimsWebSiteTool

extends java.lang.Object

implements java.io.Serializable

This class represents a map tool button used in the MELP ISB web site framework. Tools are created then added to the AimsWebSite object using XML configuration files.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Constructor Summary

AimsWebSiteTool()
Creates new WebSiteButton

Method Summary

java.lang.String	getActiveGraphic() Gets the URL of the active graphic image for the tool button, the one that is displayed when the tool is active.
java.lang.String	getCursorStyle() Gets the cursor to show when this tool is active.
java.lang.String	getHandler() Gets the custom handler for of the tool button.
int	getHeight() Returns the height of the tool button image.
java.lang.String	getHelp() Gets the descriptive help for the tool button for use in the generated help page.
java.lang.String	getHint() Gets the hint that will appear when the mouse is over the tool button.
boolean	getIsSpace()
java.lang.String	getName() Gets the name of the tool button.
java.lang.String	getNormalGraphic() Gets the URL of the standard graphic image for the tool button.
java.lang.String	getOption(java.lang.String optionName)
java.lang.String	getOptions() Gets the options for the tool button.
java.lang.String	getShapeType() Gets the shape type of the tool button.
boolean	getShowPoint() Returns true if the tool or button is for advanced users, otherwise false.
java.lang.String	getStatusMessage() Gets the status message that will appear when the mouse is over the tool button.
java.lang.String	getTarget() Gets the target frame of the tool button that the URL will be executed in when it is pushed.
java.lang.String	getUrl() Gets the URL of the tool button that will be executed when it is pushed.
int	getWidth() Returns the width of the tool button image.
boolean	isButton() Returns true if the tool button is a button, otherwise false.
boolean	isPopup() Gets an indicator of whether a tool is shown in a popup window.
boolean	isTool() Returns true if the tool button is a tool, otherwise false.
boolean	isVisible() Returns true if the tool is visible, otherwise false.
void	setActiveGraphic(java.lang.String graphic) The URL of the graphic that will appear when the tool is active.
void	setAxlAttribute(AimsWebSiteConfig 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.
void	setCursorGeneric(java.lang.String cursor) Sets the generic cursor for the tool.
void	setCursorUrl(java.lang.String cursor) Sets the URL to the cursor for the tool.
void	setHint(java.lang.String hint) Sets the hint text that will display when the mouse is over the tool.
void	setIsButton(boolean isButton) Sets this tool to be a button as opposed to a tool or a space.
void	setIsSpace(boolean isSpace) Sets this tool to be a space.
void	setIsTool(boolean isTool) Sets this tool to be a tool as opposed to a button or a space.
void	setName(java.lang.String name) Sets the name of a map tool.
void	setNormalGraphic(java.lang.String graphic) The URL of the graphic that will appear when the tool is not active.
void	setPopup(boolean isPopup) Sets whether a tool is shown in a popup window.
void	setShapeType(java.lang.String type) Sets the shape type of the tool button.
void	setShowPoint(boolean showPoint) Sets whether the clicked point should be displayed.
void	setStatusMessage(java.lang.String statusMessage) Sets the status message that will display when the mouse is ovet the tool.
void	setTarget(java.lang.String target) Sets the target frame where the URL is executed.
void	setUrl(java.lang.String url)
void	setVisible(boolean isVisible) Sets the visiblity of a tool

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsWebSiteTool

public AimsWebSiteTool()

Creates new WebSiteButton

Method Detail

getCursorStyle

public java.lang.String getCursorStyle()

Gets the cursor to show when this tool is active.

Returns:

The dursor style.

setCursorGeneric

public void setCursorGeneric(java.lang.String cursor)

Sets the generic cursor for the tool. See the CSS2 specifications for valid cursor values.

Parameters:

cursor - The name of the CSS2 generic cursor.

setCursorUrl

public void setCursorUrl(java.lang.String cursor)

Sets the URL to the cursor for the tool. Note: Has no effect in some browsers.

Parameters:

cursor - The URL of the cursor.

setAxlAttribute

public void setAxlAttribute(AimsWebSiteConfig 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 AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.

getHelp

public java.lang.String getHelp()

Gets the descriptive help for the tool button for use in the generated help page.

Returns:

The descriptive help for the tool button.

setName

public void setName(java.lang.String name)

Sets the name of a map tool. The name is used by the map tool frame and status frame to identify the active tool, if applicable.

Parameters:

name - The name of the map tool.

setUrl

public void setUrl(java.lang.String url)

setTarget

public void setTarget(java.lang.String target)

Sets the target frame where the URL is executed. Valid frame names are: "mapFrame", "dataFrame", "toolFrame", "statusFrame", "hiddenFrame", or "_blank".

Parameters:

target - The target frame for the tool's action.

setHint

public void setHint(java.lang.String hint)

Sets the hint text that will display when the mouse is over the tool. Keep this short.

Parameters:

hint - The hint text.

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)

Sets the status message that will display when the mouse is ovet the tool. The message appears in the browser's status bar.

Parameters:

statusMessage - The status message.

setNormalGraphic

public void setNormalGraphic(java.lang.String graphic)

The URL of the graphic that will appear when the tool is not active. If the tool is a button, this will be the only graphic, but if it is a tool, the image will be replaced with the Active Graphic.

Parameters:

graphic - The URL of the standard (non-active) tool image.

setActiveGraphic

public void setActiveGraphic(java.lang.String graphic)

The URL of the graphic that will appear when the tool is active. If the tool is a tool (not a button), this image will be displayed when the user selects this tool.

Parameters:

graphic - The URL of the active tool image.

setIsButton

public void setIsButton(boolean isButton)

Sets this tool to be a button as opposed to a tool or a space.

Parameters:

isButton - True if the tool is a button, otherwise false.

setIsSpace

public void setIsSpace(boolean isSpace)

Sets this tool to be a space.

Parameters:

isSpace - True if the tool is a space, otherwise false.

setIsTool

public void setIsTool(boolean isTool)

Sets this tool to be a tool as opposed to a button or a space.

Parameters:

isTool - True if the tool is a tool, otherwise false.

getIsSpace

public boolean getIsSpace()

setShowPoint

public void setShowPoint(boolean showPoint)

Sets whether the clicked point should be displayed.

Parameters:

showPoint - True if the click point should be shown, otherwise false.

getOptions

public java.lang.String getOptions()

Gets the options for the tool button. Options are a list of keywords and values separated by commas that are used to customize the action of the tool. For example, the options may be visible=true,inscale=false.

Returns:

The options for the tool button.

getOption

public java.lang.String getOption(java.lang.String optionName)

getName

public java.lang.String getName()

Gets the name of the tool button.

Returns:

The name of the tool button.

getShapeType

public java.lang.String getShapeType()

Gets the shape type of the tool button.

Returns:

The shape type of the tool button.

setShapeType

public void setShapeType(java.lang.String type)

Sets the shape type of the tool button.

Parameters:

type - The shape type of the tool button.

getHandler

public java.lang.String getHandler()

Gets the custom handler for of the tool button.

Returns:

The custom handler the tool button.

getUrl

public java.lang.String getUrl()

Gets the URL of the tool button that will be executed when it is pushed.

Returns:

The URL of the tool button.

getTarget

public java.lang.String getTarget()

Gets the target frame of the tool button that the URL will be executed in when it is pushed. Valid frame names are: "mapFrame", "dataFrame", "toolFrame", "statusFrame", "hiddenFrame", or "_blank".

Returns:

The target frame of the tool button.

getHint

public java.lang.String getHint()

Gets the hint that will appear when the mouse is over the tool button.

Returns:

The mouseover hint of the tool button.

getStatusMessage

public java.lang.String getStatusMessage()

Gets the status message that will appear when the mouse is over the tool button.

Returns:

The mouseover status message of the tool button.

getNormalGraphic

public java.lang.String getNormalGraphic()

Gets the URL of the standard graphic image for the tool button.

Returns:

The URL of the standard graphic image for the tool button.

getActiveGraphic

public java.lang.String getActiveGraphic()

Gets the URL of the active graphic image for the tool button, the one that is displayed when the tool is active.

Returns:

The URL of the active graphic image for the tool button.

getWidth

public int getWidth()

Returns the width of the tool button image.

Returns:

The width the tool button image.

getHeight

public int getHeight()

Returns the height of the tool button image.

Returns:

The height the tool button image.

isTool

public boolean isTool()

Returns true if the tool button is a tool, otherwise false.

Returns:

True if the tool button is a tool, otherwise false.

getShowPoint

public boolean getShowPoint()

Returns true if the tool or button is for advanced users, otherwise false.

Returns:

True if the tool button is advanced, otherwise false.

isButton

public boolean isButton()

Returns true if the tool button is a button, otherwise false.

Returns:

True if the tool button is a button, otherwise false.

isVisible

public boolean isVisible()

Returns true if the tool is visible, otherwise false.

Returns:

True if the tool is a tool and visible or is a button, otherwise false.

setVisible

public void setVisible(boolean isVisible)

Sets the visiblity of a tool

Parameters:

isVisible - True if the tool should be visible.

setPopup

public void setPopup(boolean isPopup)

Sets whether a tool is shown in a popup window.

Parameters:

isPopup - True if the tool should popup, otherwise false.

isPopup

public boolean isPopup()

Gets an indicator of whether a tool is shown in a popup window.

Returns:

True if the tool should popup, otherwise false.