com.moximedia.aims
Class AimsEnvironment

java.lang.Object
  com.moximedia.aims.AimsEnvironment

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class AimsEnvironment

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

Implementation of ArcIMS 3.1 Environment tag.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

static int	DISABLED_STATUS_FALSE
static int	DISABLED_STATUS_TRUE
static int	DISABLED_STATUS_UNKNOWN

Constructor Summary

AimsEnvironment()
Creates new AimsEnvironment

AimsEnvironment(double arcImsVersion)
Creates new AimsEnvironment for a specific ArcIMS version

Method Summary

java.lang.Object	clone() Returns a clone of this object
double	getArcImsVersion() Returns the value of attribute arcImsVersion.
int	getDisabledStatus(java.lang.String type) Returns a status code indicating whether the specified image type has been disabled.
java.lang.String	getForbidden() Returns the value of attribute forbidden.
long	getImageLimit() Returns the value of attribute imageLimit.
java.lang.String	getLocaleCountry() Returns the value of attribute localeCountry.
java.lang.String	getLocaleLanguage() Returns the value of attribute localeLanguage.
java.lang.String	getLocaleVariant() Returns the value of attribute localeVariant.
int	getScreenDpi() Returns the value of attribute screenDpi.
java.lang.String	getSeparatorsCs() Returns the value of attribute separatorsCs.
java.lang.String	getSeparatorsTs() Returns the value of attribute separatorsTs.
AimsColor	getUifontColor() Returns the value of attribute uifontColor.
java.lang.String	getUifontName() Returns the value of attribute uifontName.
int	getUifontSize() Returns the value of attribute uifontSize.
boolean	isArcMap() Returns whether the environment is an ArcMap session.
boolean	isForbidden(java.lang.String serviceName) Returns whether a specified service is forbidden.
void	setAxlAttribute(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	setForbidden(java.lang.String forbiddenServices) Sets the value of attribute forbidden.
void	setImageLimit(long pixelCount) Sets the value of attribute imageLimit.
void	setIsArcMap(boolean isArcMap) Sets whether the environment is an ArcMap session.
void	setLocaleCountry(java.lang.String countryCode) Sets the value of attribute localeCountry.
void	setLocaleLanguage(java.lang.String languageCode) Sets the value of attribute localeLanguage.
void	setLocaleVariant(java.lang.String variantCode) Sets the value of attribute localeVariant.
void	setScreenDpi(int dpi) Sets the value of attribute screenDpi.
void	setSeparatorsCs(java.lang.String separator) Sets the value of attribute separatorsCs.
void	setSeparatorsTs(java.lang.String separator) Sets the value of attribute separatorsTs.
void	setUifontColor(AimsColor color) Sets the value of attribute uifontColor.
void	setUifontName(java.lang.String fontName) Sets the value of attribute uifontName.
void	setUifontSize(int size) Sets the value of attribute uifontSize.
java.lang.String	toAxlString() Returns the AXL string to refresh this object.

Methods inherited from class java.lang.Object

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

Field Detail

DISABLED_STATUS_UNKNOWN

public static final int DISABLED_STATUS_UNKNOWN

See Also:

Constant Field Values

DISABLED_STATUS_TRUE

public static final int DISABLED_STATUS_TRUE

See Also:

Constant Field Values

DISABLED_STATUS_FALSE

public static final int DISABLED_STATUS_FALSE

See Also:

Constant Field Values

Constructor Detail

AimsEnvironment

public AimsEnvironment()

Creates new AimsEnvironment

AimsEnvironment

public AimsEnvironment(double arcImsVersion)

Creates new AimsEnvironment for a specific ArcIMS version

Parameters:

arcImsVersion - The ArcIMS version number, either 3.0, 3.1 or 4.0.

Method Detail

clone

public java.lang.Object clone()

Returns a clone of this object

Returns:

This object as a java.lang.Object. Remember to cast the clone to the proper object type before using.

getArcImsVersion

public double getArcImsVersion()

Returns the value of attribute arcImsVersion.

Returns:

The value of attribute arcImsVersion.

getLocaleLanguage

public java.lang.String getLocaleLanguage()

Returns the value of attribute localeLanguage.

Returns:

The value of attribute localeLanguage.

getLocaleCountry

public java.lang.String getLocaleCountry()

Returns the value of attribute localeCountry.

Returns:

The value of attribute localeCountry.

getLocaleVariant

public java.lang.String getLocaleVariant()

Returns the value of attribute localeVariant.

Returns:

The value of attribute localeVariant.

getUifontColor

public AimsColor getUifontColor()

Returns the value of attribute uifontColor.

Returns:

The value of attribute uifontColor.

getUifontName

public java.lang.String getUifontName()

Returns the value of attribute uifontName.

Returns:

The value of attribute uifontName.

getUifontSize

public int getUifontSize()

Returns the value of attribute uifontSize.

Returns:

The value of attribute uifontSize.

getSeparatorsCs

public java.lang.String getSeparatorsCs()

Returns the value of attribute separatorsCs.

Returns:

The value of attribute separatorsCs.

getSeparatorsTs

public java.lang.String getSeparatorsTs()

Returns the value of attribute separatorsTs.

Returns:

The value of attribute separatorsTs.

getScreenDpi

public int getScreenDpi()

Returns the value of attribute screenDpi.

Returns:

The value of attribute screenDpi.

getImageLimit

public long getImageLimit()

Returns the value of attribute imageLimit.

Returns:

The value of attribute imageLimit.

isArcMap

public boolean isArcMap()

Returns whether the environment is an ArcMap session.

Returns:

True if it is an ArcMap session, otherwise false.

setIsArcMap

public void setIsArcMap(boolean isArcMap)

Sets whether the environment is an ArcMap session.

Parameters:

isArcMap - True if it is an ArcMap session, otherwise false.

getForbidden

public java.lang.String getForbidden()

Returns the value of attribute forbidden.

Returns:

The value of attribute forbidden.

isForbidden

public boolean isForbidden(java.lang.String serviceName)

Returns whether a specified service is forbidden.

Returns:

True if the service is forbidden, otherwise false.

getDisabledStatus

public int getDisabledStatus(java.lang.String type)

Returns a status code indicating whether the specified image type has been disabled.

Parameters:

type - The imaage type.

Returns:

The status, DISABLED_STATUS_FALSE, DISABLED_STATUS_TRUE, DISABLED_STATUS_UNKNOWN.

setLocaleLanguage

public void setLocaleLanguage(java.lang.String languageCode)

Sets the value of attribute localeLanguage.

Parameters:

languageCode - The attribute setting. Refer to the AXL documentation for the list of valid settings.

setLocaleCountry

public void setLocaleCountry(java.lang.String countryCode)

Sets the value of attribute localeCountry.

Parameters:

countryCode - The attribute setting. Refer to the AXL documentation for the list of valid settings.

setLocaleVariant

public void setLocaleVariant(java.lang.String variantCode)

Sets the value of attribute localeVariant.

Parameters:

variantCode - The attribute setting. Refer to the AXL documentation for the list of valid settings.

setUifontColor

public void setUifontColor(AimsColor color)

Sets the value of attribute uifontColor.

Parameters:

color - The attribute setting.

setUifontName

public void setUifontName(java.lang.String fontName)

Sets the value of attribute uifontName.

Parameters:

fontName - The attribute setting.

setUifontSize

public void setUifontSize(int size)

Sets the value of attribute uifontSize.

Parameters:

size - The attribute setting.

setSeparatorsCs

public void setSeparatorsCs(java.lang.String separator)

Sets the value of attribute separatorsCs.

Parameters:

separator - The attribute setting.

setSeparatorsTs

public void setSeparatorsTs(java.lang.String separator)

Sets the value of attribute separatorsTs.

Parameters:

separator - The attribute setting.

setScreenDpi

public void setScreenDpi(int dpi)

Sets the value of attribute screenDpi.

Parameters:

dpi - The attribute setting.

setImageLimit

public void setImageLimit(long pixelCount)

Sets the value of attribute imageLimit.

Parameters:

pixelCount - The attribute setting.

setForbidden

public void setForbidden(java.lang.String forbiddenServices)

Sets the value of attribute forbidden.

Parameters:

forbiddenServices - The attribute setting.

toAxlString

public java.lang.String toAxlString()

Returns the AXL string to refresh this object.

Returns:

The AXL string to refresh this object.

setAxlAttribute

public void setAxlAttribute(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 can 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.