com.moximedia.aims
Class AimsTheme

java.lang.Object
  com.moximedia.aims.AimsTheme

All Implemented Interfaces:

java.io.Serializable

public class AimsTheme

extends java.lang.Object

implements java.io.Serializable

The AimsTheme object is used to define map settings for a particular set of layers and folders to allow the user to change the map to another theme which is set up to display a different view. The themes are loaded into the site configuration object when the site is initialized, if the tag is present.

Author:

Doug Cates

See Also:

Serialized Form

Constructor Summary

AimsTheme()
Creates new AimsTheme

Method Summary

java.lang.String	getDescription() Returns the description of this theme.
java.lang.String	getName() Returns the name of this theme.
boolean	getRefreshDataFrame() Returns true if the data frame should be refreshed to contain the document configured in the site configuration when the theme is applied.
boolean	getRunStartupScripts() Returns true if the configured startup scripts should be executed when the theme is applied.
boolean	getSameExtent() Returns true if the extent should stay the same when the theme is applied.
java.lang.String	getSiteConfigXml() Returns the XML file defining the site configuration for this theme.
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	setDescription(java.lang.String description) Sets the description of this theme.
void	setName(java.lang.String name) Sets the name of this theme.
void	setRefreshDataFrame(boolean refresh) Sets whether the data frame should be refreshed to contain the document configured in the site configuration when the theme is applied.
void	setRunStartupScripts(boolean flag) Sets whether the configured startup scripts should be executed when the theme is applied.
void	setSameExtent(boolean sameExtent) Sets whether the extent should stay the same when the theme is applied.
void	setSiteConfigXml(java.lang.String href) Returns the XML file defining the site configuration for this theme.

Methods inherited from class java.lang.Object

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

Constructor Detail

AimsTheme

public AimsTheme()

Creates new AimsTheme

Method Detail

getName

public java.lang.String getName()

Returns the name of this theme.

Returns:

The theme name.

setName

public void setName(java.lang.String name)

Sets the name of this theme.

Parameters:

name - The theme name.

getDescription

public java.lang.String getDescription()

Returns the description of this theme.

Returns:

The theme description.

setDescription

public void setDescription(java.lang.String description)

Sets the description of this theme.

Parameters:

description - The theme description.

getRefreshDataFrame

public boolean getRefreshDataFrame()

Returns true if the data frame should be refreshed to contain the document configured in the site configuration when the theme is applied.

Returns:

True if the dataframe should refresh, otherwise false, meaning that the apply themes page will remain.

setRefreshDataFrame

public void setRefreshDataFrame(boolean refresh)

Sets whether the data frame should be refreshed to contain the document configured in the site configuration when the theme is applied.

Parameters:

refresh - True if the dataframe should refresh, otherwise false, meaning that the apply themes page will remain.

getSameExtent

public boolean getSameExtent()

Returns true if the extent should stay the same when the theme is applied.

Returns:

False if the extent is changed to the map service initial extent, or true if the theme is applied at the same extent.

setSameExtent

public void setSameExtent(boolean sameExtent)

Sets whether the extent should stay the same when the theme is applied.

Parameters:

sameExtent - False if the extent is changed to the map service initial extent, or true if the theme is applied at the same extent.

getRunStartupScripts

public boolean getRunStartupScripts()

Returns true if the configured startup scripts should be executed when the theme is applied.

Returns:

True if the startup scripts should be executed, otherwise false.

setRunStartupScripts

public void setRunStartupScripts(boolean flag)

Sets whether the configured startup scripts should be executed when the theme is applied.

Parameters:

flag - True if the startup scripts should be executed, otherwise false.

getSiteConfigXml

public java.lang.String getSiteConfigXml()

Returns the XML file defining the site configuration for this theme.

Returns:

The XML file defining the site-configuration for this theme.

setSiteConfigXml

public void setSiteConfigXml(java.lang.String href)

Returns the XML file defining the site configuration for this theme.

Parameters:

href - The XML file defining the site-configuration for this theme.

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.