com.moximedia.ows.website
Class Config

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

All Implemented Interfaces:

java.io.Serializable

public class Config

extends java.lang.Object

implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Config()
Creates new WebSiteConfiguration

Method Summary

void	addHelpContext(java.lang.String context, java.lang.String url)
void	addQuickViewExtent(Envelope namedExtent) Adds a named envelope to the quickview extents shown on the status bar.
void	addStartupScript(java.lang.String scriptName) Adds a startup script to the startup script array.
void	addTheme(Theme theme)
void	addToolset(Toolset toolset)
void	addWmsPortalResource(WmsPortalResource res) Adds a WMS resource to the resource array.
java.lang.String	getActiveToolName()
Toolset	getActiveToolset()
java.lang.String	getBrowser()
java.lang.String	getDataFramePosition()
java.lang.String	getDataFrameUrl()
int	getDataFrameWidth()
FindLocationType	getFindLocationType(java.lang.String type)
FindLocationTypes	getFindLocationTypes()
java.lang.String	getFrameworkUrlPath()
java.lang.String	getGuiScript() Gets the name of the script used for the IMF interface.
java.lang.String	getHelpContextUrl()
java.lang.String	getHelpContextUrl(java.lang.String context)
java.lang.String	getHiddenFrameUrl()
int	getHiddenFrameWidth()
java.lang.String	getImfPropertiesFileName()
java.lang.String	getImfVersion() Gets the IMF version number string.
java.lang.String	getIndexMapXmlUrl()
java.util.Locale	getLocale()
java.lang.String	getMapXmlUrl()
Color	getPanBorderOutColor() Gets the color of the pan border when the mouse is not on it.
Color	getPanBorderOverColor() Gets the color of the pan border when the mouse is moved onto it.
java.lang.String	getProperty(java.lang.String name) Gets the value of a property set in the configuration XML using a <property> element.
java.lang.String	getProperty(java.lang.String identifier, java.lang.String name)
java.util.ArrayList	getQuickViewExtents() Gets the array of quickview extents, or null if no quickview extents exist.
Registrations	getRegistrations()
boolean	getResizeRefresh() Returns an indicator of whether the map in the viewer should refresh when the window is resized.
java.lang.String	getSaxParser() Gets the name of the class used for parsing XML.
SelectMenuOptions	getSelectMenuOptions() Gets the selection options for the select menu page.
SelectSetOptions	getSelectSetOptions() Gets the selection options for the selected set page.
java.lang.String	getSiteUrl()
java.lang.String	getSiteUrlPath()
java.util.ArrayList	getStartupScripts() Gets the startup script array, or null if there are not any.
int	getStatusFrameHeight()
java.lang.String	getStatusFrameUrl()
java.lang.String	getStyleUrl() Gets the URL of the css styling file used for the IMF interface.
int	getTabDecorationLeftHeight()
java.lang.String	getTabDecorationLeftUrl()
int	getTabDecorationLeftWidth()
int	getTabDecorationRightHeight()
java.lang.String	getTabDecorationRightUrl()
int	getTabDecorationRightWidth()
int	getTabDecorationSpaceHeight()
java.lang.String	getTabDecorationSpaceUrl()
int	getTabDecorationSpaceWidth()
java.lang.String	getTabFrameUrl()
int	getTabMaximumHeight() Gets the maximum height of the tabs.
java.util.ArrayList	getTabs()
java.util.ArrayList	getThemes()
java.lang.String	getThemesXmlUrl()
java.lang.String	getThemeUrlPath()
int	getTitleFrameHeight()
java.lang.String	getTitleFrameUrl()
Tool	getTool(java.lang.String toolName)
java.lang.String	getToolFrameUrl()
int	getToolMaximumHeight() Gets the maximum height of the tools in all toolsets.
java.lang.String	getToolPosition()
java.util.ArrayList	getTools()
Toolset	getToolset(java.lang.String toolsetName)
java.lang.String	getWindowTitle()
java.util.ArrayList	getWmsPortalResources() Gets the WMS resource array.
boolean	isBrowser(java.lang.String id)
boolean	isBrowserIE()
boolean	isBrowserIE5up()
boolean	isBrowserNS()
boolean	isBrowserNS5up()
void	removeQuickViewExtent(java.lang.String name) Removes a named envelope from the quickview extents shown on the status bar.
void	removeWmsPortalResource(java.lang.String name) Removes a named WMS portal resourse from the resource array.
void	setActiveToolset(java.lang.String toolsetName)
void	setBrowser(java.lang.String browser)
void	setFrameworkUrlPath(java.lang.String path)
void	setGuiScript(java.lang.String filename) Sets the name of the script used for the IMF interface.
void	setHelpContext(java.lang.String context)
void	setImfPropertiesFileName(java.lang.String filename)
void	setImfVersion(java.lang.String release, java.lang.String build) Sets the IMF version string shown on the layers page.
void	setIndexMapXmlUrl(java.lang.String href)
void	setLocale(java.util.Locale locale) Sets the internationalization locale of the IMF interface.
void	setMapXmlUrl(java.lang.String href)
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property (programmer defined).
void	setProperty(java.lang.String identifier, java.lang.String name, java.lang.String value)
void	setRefreshResize(boolean flag) Sets whether the map in the viewer should refresh when the window is resized.
void	setSaxParser(java.lang.String className) Sets the class name of the SAX parser
void	setSiteUrl(java.lang.String href)
void	setSiteUrlPath(java.lang.String path)
void	setStyleUrl(java.lang.String href) Sets the URL of the css styling file used for the IMF interface.
void	setThemesXmlUrl(java.lang.String themesXmlUrl)
void	setThemeUrlPath(java.lang.String path)
void	setTitleFrameUrl(java.lang.String url)
void	setXmlAttribute(java.lang.String element, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
boolean	showPanBorder() Returns whether to show the pan border around the map.

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config()

Creates new WebSiteConfiguration

Method Detail

isBrowser

public boolean isBrowser(java.lang.String id)

isBrowserIE

public boolean isBrowserIE()

isBrowserIE5up

public boolean isBrowserIE5up()

isBrowserNS

public boolean isBrowserNS()

isBrowserNS5up

public boolean isBrowserNS5up()

showPanBorder

public boolean showPanBorder()

Returns whether to show the pan border around the map.

Returns:

True if the pan border should be shown, otherwise false.

getPanBorderOutColor

public Color getPanBorderOutColor()

Gets the color of the pan border when the mouse is not on it.

Returns:

The color of the border.

getPanBorderOverColor

public Color getPanBorderOverColor()

Gets the color of the pan border when the mouse is moved onto it.

Returns:

The color of the border.

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the value of a property set in the configuration XML using a <property> element.

Parameters:

name - The property name

Returns:

The property value, or null.

getProperty

public java.lang.String getProperty(java.lang.String identifier,
                                    java.lang.String name)

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Sets the value of a property (programmer defined).

Parameters:

name - The property name

value - The property value.

setProperty

public void setProperty(java.lang.String identifier,
                        java.lang.String name,
                        java.lang.String value)

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

Sets the internationalization locale of the IMF interface.

Parameters:

locale - The locale, see java documentation.

getSaxParser

public java.lang.String getSaxParser()

Gets the name of the class used for parsing XML.

Returns:

The name of the class used for parsing XML.

setSaxParser

public void setSaxParser(java.lang.String className)

Sets the class name of the SAX parser

Parameters:

className - The class name of the SAX parser.

getSelectMenuOptions

public SelectMenuOptions getSelectMenuOptions()

Gets the selection options for the select menu page.

Returns:

The options.

getSelectSetOptions

public SelectSetOptions getSelectSetOptions()

Gets the selection options for the selected set page.

Returns:

The options.

addStartupScript

public void addStartupScript(java.lang.String scriptName)

Adds a startup script to the startup script array.

Parameters:

scriptName - The file name of the startup script. Must be in the IMF directory or a subdirectory.

getStartupScripts

public java.util.ArrayList getStartupScripts()

Gets the startup script array, or null if there are not any.

Returns:

The array of startup script file names.

getTools

public java.util.ArrayList getTools()

getToolMaximumHeight

public int getToolMaximumHeight()

Gets the maximum height of the tools in all toolsets.

Returns:

The maximumn height.

getTool

public Tool getTool(java.lang.String toolName)

getActiveToolName

public java.lang.String getActiveToolName()

addToolset

public void addToolset(Toolset toolset)

getToolset

public Toolset getToolset(java.lang.String toolsetName)

getActiveToolset

public Toolset getActiveToolset()

setActiveToolset

public void setActiveToolset(java.lang.String toolsetName)

setHelpContext

public void setHelpContext(java.lang.String context)

getHelpContextUrl

public java.lang.String getHelpContextUrl(java.lang.String context)

getHelpContextUrl

public java.lang.String getHelpContextUrl()

addHelpContext

public void addHelpContext(java.lang.String context,
                           java.lang.String url)

getFindLocationTypes

public FindLocationTypes getFindLocationTypes()

getFindLocationType

public FindLocationType getFindLocationType(java.lang.String type)

getRegistrations

public Registrations getRegistrations()

addTheme

public void addTheme(Theme theme)

getThemeUrlPath

public java.lang.String getThemeUrlPath()

setThemeUrlPath

public void setThemeUrlPath(java.lang.String path)

getSiteUrlPath

public java.lang.String getSiteUrlPath()

setSiteUrlPath

public void setSiteUrlPath(java.lang.String path)

setFrameworkUrlPath

public void setFrameworkUrlPath(java.lang.String path)

getFrameworkUrlPath

public java.lang.String getFrameworkUrlPath()

getBrowser

public java.lang.String getBrowser()

setBrowser

public void setBrowser(java.lang.String browser)

setXmlAttribute

public void setXmlAttribute(java.lang.String element,
                            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:

name - The XML attribute name.

value - The XML attribute value.

setMapXmlUrl

public void setMapXmlUrl(java.lang.String href)

getMapXmlUrl

public java.lang.String getMapXmlUrl()

setIndexMapXmlUrl

public void setIndexMapXmlUrl(java.lang.String href)

getIndexMapXmlUrl

public java.lang.String getIndexMapXmlUrl()

setThemesXmlUrl

public void setThemesXmlUrl(java.lang.String themesXmlUrl)

getThemesXmlUrl

public java.lang.String getThemesXmlUrl()

getWindowTitle

public java.lang.String getWindowTitle()

getTitleFrameUrl

public java.lang.String getTitleFrameUrl()

getTabFrameUrl

public java.lang.String getTabFrameUrl()

getToolFrameUrl

public java.lang.String getToolFrameUrl()

getDataFrameUrl

public java.lang.String getDataFrameUrl()

getDataFrameWidth

public int getDataFrameWidth()

getHiddenFrameWidth

public int getHiddenFrameWidth()

getDataFramePosition

public java.lang.String getDataFramePosition()

getSiteUrl

public java.lang.String getSiteUrl()

setSiteUrl

public void setSiteUrl(java.lang.String href)

getThemes

public java.util.ArrayList getThemes()

getToolPosition

public java.lang.String getToolPosition()

setTitleFrameUrl

public void setTitleFrameUrl(java.lang.String url)

getTitleFrameHeight

public int getTitleFrameHeight()

getStatusFrameHeight

public int getStatusFrameHeight()

getStatusFrameUrl

public java.lang.String getStatusFrameUrl()

getHiddenFrameUrl

public java.lang.String getHiddenFrameUrl()

getTabMaximumHeight

public int getTabMaximumHeight()

Gets the maximum height of the tabs.

Returns:

The maximumn height.

getTabs

public java.util.ArrayList getTabs()

getTabDecorationLeftUrl

public java.lang.String getTabDecorationLeftUrl()

getTabDecorationLeftWidth

public int getTabDecorationLeftWidth()

getTabDecorationLeftHeight

public int getTabDecorationLeftHeight()

getTabDecorationRightUrl

public java.lang.String getTabDecorationRightUrl()

getTabDecorationRightWidth

public int getTabDecorationRightWidth()

getTabDecorationRightHeight

public int getTabDecorationRightHeight()

getTabDecorationSpaceUrl

public java.lang.String getTabDecorationSpaceUrl()

getTabDecorationSpaceWidth

public int getTabDecorationSpaceWidth()

getTabDecorationSpaceHeight

public int getTabDecorationSpaceHeight()

setImfPropertiesFileName

public void setImfPropertiesFileName(java.lang.String filename)

getImfPropertiesFileName

public java.lang.String getImfPropertiesFileName()

getWmsPortalResources

public java.util.ArrayList getWmsPortalResources()

Gets the WMS resource array.

Returns:

The WMS named resource array.

addWmsPortalResource

public void addWmsPortalResource(WmsPortalResource res)

Adds a WMS resource to the resource array.

Parameters:

res - The WMS named resource.

removeWmsPortalResource

public void removeWmsPortalResource(java.lang.String name)

Removes a named WMS portal resourse from the resource array.

Parameters:

name - The resource name.

addQuickViewExtent

public void addQuickViewExtent(Envelope namedExtent)

Adds a named envelope to the quickview extents shown on the status bar. The quickview extents can be set using the quick-view element in the site configuration XML file.

Parameters:

namedExtent - An envelope with a name.

removeQuickViewExtent

public void removeQuickViewExtent(java.lang.String name)

Removes a named envelope from the quickview extents shown on the status bar.

getQuickViewExtents

public java.util.ArrayList getQuickViewExtents()

Gets the array of quickview extents, or null if no quickview extents exist.

Returns:

The array of quickview extents (as AimsEnvelope objects), or null if no quickview extents exist.

getStyleUrl

public java.lang.String getStyleUrl()

Gets the URL of the css styling file used for the IMF interface.

Returns:

The URL of the style file.

setStyleUrl

public void setStyleUrl(java.lang.String href)

Sets the URL of the css styling file used for the IMF interface.

Parameters:

href - The URL of the style file.

getGuiScript

public java.lang.String getGuiScript()

Gets the name of the script used for the IMF interface.

Returns:

The name of the script used for the IMF graphical user interface.

setGuiScript

public void setGuiScript(java.lang.String filename)

Sets the name of the script used for the IMF interface.

Parameters:

filename - The name of the script used for the IMF graphical user interface. The file path should be relative to the IMF installation directory.

getResizeRefresh

public boolean getResizeRefresh()

Returns an indicator of whether the map in the viewer should refresh when the window is resized. This setting is used to overcome a bug in IE that repeatedly refreshes the map when iframes are used in custom guis. Set this to false if iframes are used.

Returns:

True if the window should refresh, otherwise false.

setRefreshResize

public void setRefreshResize(boolean flag)

Sets whether the map in the viewer should refresh when the window is resized. This setting is used to overcome a bug in IE that repeatedly refreshes the map when iframes are used in custom guis. Set this to false if iframes are used.

Parameters:

flag - True if the window should refresh, otherwise false.

setImfVersion

public void setImfVersion(java.lang.String release,
                          java.lang.String build)

Sets the IMF version string shown on the layers page. This method is called by the imf startup routine and should not normally be used by an application programmer.

Parameters:

release - The major release number.

build - The build number.

getImfVersion

public java.lang.String getImfVersion()

Gets the IMF version number string.

Returns:

The version string.