com.moximedia.aims
Class AimsWebSiteTab

java.lang.Object
  com.moximedia.aims.AimsWebSiteTab

All Implemented Interfaces:

java.io.Serializable

public class AimsWebSiteTab

extends java.lang.Object

implements java.io.Serializable

This class represents a single tab used in the MELP ISB web site framework. Tabs are created then added to the AimsWebSite object using XML configuration files.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Constructor Summary

AimsWebSiteTab()
Creates new AimsWebSiteTab

Method Summary

java.lang.String	getGraphic() Gets the URL of the graphic image for the tab.
int	getHeight() Gets the height of the graphic image for the tab.
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 tab.
java.lang.String	getName() Gets the name of the tab.
java.lang.String	getRolloverGraphic() Gets the URL of the rollover graphic image for the tab.
java.lang.String	getStatusMessage() Gets the status message that will appear when the mouse is over the tab.
java.lang.String	getTarget() Gets the target frame of the tab that the URL will be executed in when it is pushed.
java.lang.String	getUrl() Gets the URL of the document or JavaScript function that will be executed when it is pushed.
int	getWidth() Gets the width of the graphic image for the tab.
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	setGraphic(java.lang.String graphic) The URL of the tab's graphic image.
void	setHint(java.lang.String hint) Sets the hint text that will display when the mouse is over the tab.
void	setName(java.lang.String name) Sets the name of a tab.
void	setRolloverGraphic(java.lang.String graphic) The URL of the tab's rollover graphic image.
void	setStatusMessage(java.lang.String statusMessage) Sets the status message that will display when the mouse is ovet the tab.
void	setTarget(java.lang.String target) Sets the target frame where the URL is executed.
void	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsWebSiteTab

public AimsWebSiteTab()

Creates new AimsWebSiteTab

Method Detail

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.

getName

public java.lang.String getName()

Gets the name of the tab.

Returns:

The name of the tab.

setName

public void setName(java.lang.String name)

Sets the name of a tab. The name is used by the automated help script to display the help for the tab.

Parameters:

name - The name of the tab.

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 tab's action.

setHint

public void setHint(java.lang.String hint)

Sets the hint text that will display when the mouse is over the tab. 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 tab. The message appears in the browser's status bar.

Parameters:

statusMessage - The status message.

setGraphic

public void setGraphic(java.lang.String graphic)

The URL of the tab's graphic image.

setRolloverGraphic

public void setRolloverGraphic(java.lang.String graphic)

The URL of the tab's rollover graphic image.

getUrl

public java.lang.String getUrl()

Gets the URL of the document or JavaScript function that will be executed when it is pushed.

Returns:

The URL to execute when the tab is pushed.

getTarget

public java.lang.String getTarget()

Gets the target frame of the tab 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 tab.

getHint

public java.lang.String getHint()

Gets the hint that will appear when the mouse is over the tab.

Returns:

The mouseover hint of the tab.

getStatusMessage

public java.lang.String getStatusMessage()

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

Returns:

The mouseover status message of the tab.

getGraphic

public java.lang.String getGraphic()

Gets the URL of the graphic image for the tab.

Returns:

The URL of the graphic image for the tab.

getRolloverGraphic

public java.lang.String getRolloverGraphic()

Gets the URL of the rollover graphic image for the tab.

Returns:

The URL of the rollover graphic image for the tab.

getWidth

public int getWidth()

Gets the width of the graphic image for the tab.

Returns:

The width of the graphic image for the tab.

getHeight

public int getHeight()

Gets the height of the graphic image for the tab.

Returns:

The height of the graphic image for the tab.