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

Field Summary

static int	TAB_TYPE_GRAPHIC Graphic tab type.
static int	TAB_TYPE_TEXT Text tab type.
static int	TAB_TYPE_UNKNOWN Unknown tab type.

Constructor Summary

AimsWebSiteTab()
Creates new AimsWebSiteTab

AimsWebSiteTab(int tabType)
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	getHelpUrl() Returns the url of additional help for this tool.
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.
int	getTabType() Sets the type of tab that this is.
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 url) The URL of the tab's graphic image.
void	setHeight(int height) Gets the height of the graphic image for the tab.
void	setHelpUrl(java.lang.String url) Sets the url of additional help for this tool.
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 url) 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	setTabType(int tabType) Sets the type of tab that this is.
void	setTarget(java.lang.String target) Sets the target frame where the URL is executed.
void	setUrl(java.lang.String url) Sets the URL or Javascript function that is executed when the tab is pressed.
void	setWidth(int width) Sets the width of the graphic image for the tab.

Methods inherited from class java.lang.Object

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

Field Detail

TAB_TYPE_UNKNOWN

public static final int TAB_TYPE_UNKNOWN

Unknown tab type.

See Also:

Constant Field Values

TAB_TYPE_GRAPHIC

public static final int TAB_TYPE_GRAPHIC

Graphic tab type.

See Also:

Constant Field Values

TAB_TYPE_TEXT

public static final int TAB_TYPE_TEXT

Text tab type.

See Also:

Constant Field Values

Constructor Detail

AimsWebSiteTab

public AimsWebSiteTab()

Creates new AimsWebSiteTab

AimsWebSiteTab

public AimsWebSiteTab(int tabType)

Creates new AimsWebSiteTab

Parameters:

tabType - The type of tab, TAB_TYPE_GRAPHIC or TAB_TYPE_TEXT.

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:

conf - The site donfiguration object used to get relative paths.

tag - The AXL element tag containing this attribute.

name - The AXL attribute name.

value - The AXL attribute value.

setGraphic

public void setGraphic(java.lang.String url)

The URL of the tab's graphic image.

Parameters:

url - The URL of the tab's image.

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.

setHeight

public void setHeight(int height)

Gets the height of the graphic image for the tab.

Parameters:

height - The height 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.

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.

setHelpUrl

public void setHelpUrl(java.lang.String url)

Sets the url of additional help for this tool.

Parameters:

url - The URL of the file containing help, or null.

getHelpUrl

public java.lang.String getHelpUrl()

Returns the url of additional help for this tool.

Returns:

The URL of the file containing help, or null.

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.

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.

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.

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.

setRolloverGraphic

public void setRolloverGraphic(java.lang.String url)

The URL of the tab's rollover graphic image.

Parameters:

url - The URL of the tab's rollover image.

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.

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.

getTabType

public int getTabType()

Sets the type of tab that this is.

Returns:

The type of tab, TAB_TYPE_GRAPHIC or TAB_TYPE_TEXT.

setTabType

public void setTabType(int tabType)

Sets the type of tab that this is.

Parameters:

tabType - The type of tab, TAB_TYPE_GRAPHIC or TAB_TYPE_TEXT.

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.

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.

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.

setUrl

public void setUrl(java.lang.String url)

Sets the URL or Javascript function that is executed when the tab is pressed.

Parameters:

url - The URL or Javascript function that is executed when the tab is pressed.

getWidth

public int getWidth()

Gets the width of the graphic image for the tab.

Returns:

The width of the graphic image for the tab.

setWidth

public void setWidth(int width)

Sets the width of the graphic image for the tab.

Parameters:

width - The width of the graphic image for the tab.