com.esri.arcgis.system

Class ScaleFormat

java.lang.Object

com.esri.arcgis.system.ScaleFormat

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IScaleFormat, java.io.Externalizable, java.io.Serializable

public class ScaleFormat
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IScaleFormat, IPersistStream, IPersist, IClone, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'ScaleFormat'. Generated 5/5/2025 2:28:32 PM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'A utility object for formatting scale.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.system.IScaleFormat

IID, IIDae9eda31_a9f0_4687_b3a5_8c061c92d3eb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

Constructors

Constructor and Description
ScaleFormat() Constructs a ScaleFormat using ArcGIS Engine.
ScaleFormat(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ScaleFormat theScaleFormat = (ScaleFormat) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
double	calcMapUnitValue(double absoluteScale) Calculate the number of map units corresponding to the specified page units at the given absolute scale.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getCustomFormat() A string defining the scale format.
java.lang.String	getEquals() The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
int	getFormat() Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	getMapUnits() The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
INumberFormat	getNumberFormat() Format used to display scale value, i.e., 20,000.
int	getPageUnits() The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
double	getPageUnitValue() The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
java.lang.String	getSeparator() Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
boolean	isAbbreviateUnits() Abbreviate the units in the scale string.
boolean	isCapitolizeUnits() Capitolize the units in the scale string.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isReverseOrder() Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	loadFromRegistry() Obtain the scale format to the system default.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	saveToRegistry() Store the scale format as the system default.
java.lang.String	scaleToString(double scale) Convert the absolute scale to a string using the current IScaleFormat attributes.
void	setAbbreviateUnits(boolean flag) Abbreviate the units in the scale string.
void	setCapitolizeUnits(boolean flag) Capitolize the units in the scale string.
void	setCustomFormat(java.lang.String format) A string defining the scale format.
void	setEquals(java.lang.String text) The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
void	setFormat(int format) Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
void	setMapUnits(int units) The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
void	setNumberFormat(INumberFormat format) Format used to display scale value, i.e., 20,000.
void	setPageUnits(int units) The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
void	setPageUnitValue(double value) The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
void	setReverseOrder(boolean flag) Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
void	setSeparator(java.lang.String separator) Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
double	stringToScale(java.lang.String scaleStr) Convert the string to an absolute scale using the current IScaleFormat attributes.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ScaleFormat

public ScaleFormat()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a ScaleFormat using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ScaleFormat

public ScaleFormat(java.lang.Object obj)
            throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ScaleFormat theScaleFormat = (ScaleFormat) obj;

Construct a ScaleFormat using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ScaleFormat.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setFormat

public void setFormat(int format)
               throws java.io.IOException,
                      AutomationException

Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.

Specified by:

setFormat in interface IScaleFormat

Parameters:

format - A com.esri.arcgis.system.esriScaleFormat constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormat

public int getFormat()
              throws java.io.IOException,
                     AutomationException

Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.

Specified by:

getFormat in interface IScaleFormat

Returns:

A com.esri.arcgis.system.esriScaleFormat constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFormat

public void setNumberFormat(INumberFormat format)
                     throws java.io.IOException,
                            AutomationException

Format used to display scale value, i.e., 20,000.

Specified by:

setNumberFormat in interface IScaleFormat

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws java.io.IOException,
                                     AutomationException

Format used to display scale value, i.e., 20,000.

Specified by:

getNumberFormat in interface IScaleFormat

Returns:

A reference to a com.esri.arcgis.system.INumberFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSeparator

public void setSeparator(java.lang.String separator)
                  throws java.io.IOException,
                         AutomationException

Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.

Specified by:

setSeparator in interface IScaleFormat

Parameters:

separator - The separator (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeparator

public java.lang.String getSeparator()
                              throws java.io.IOException,
                                     AutomationException

Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.

Specified by:

getSeparator in interface IScaleFormat

Returns:

The separator

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageUnitValue

public void setPageUnitValue(double value)
                      throws java.io.IOException,
                             AutomationException

The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.

Specified by:

setPageUnitValue in interface IScaleFormat

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageUnitValue

public double getPageUnitValue()
                        throws java.io.IOException,
                               AutomationException

The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.

Specified by:

getPageUnitValue in interface IScaleFormat

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageUnits

public void setPageUnits(int units)
                  throws java.io.IOException,
                         AutomationException

The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.

Specified by:

setPageUnits in interface IScaleFormat

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageUnits

public int getPageUnits()
                 throws java.io.IOException,
                        AutomationException

The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.

Specified by:

getPageUnits in interface IScaleFormat

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEquals

public void setEquals(java.lang.String text)
               throws java.io.IOException,
                      AutomationException

The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.

Specified by:

setEquals in interface IScaleFormat

Parameters:

text - The text (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEquals

public java.lang.String getEquals()
                           throws java.io.IOException,
                                  AutomationException

The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.

Specified by:

getEquals in interface IScaleFormat

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapUnits

public void setMapUnits(int units)
                 throws java.io.IOException,
                        AutomationException

The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.

Specified by:

setMapUnits in interface IScaleFormat

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnits

public int getMapUnits()
                throws java.io.IOException,
                       AutomationException

The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.

Specified by:

getMapUnits in interface IScaleFormat

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCapitolizeUnits

public void setCapitolizeUnits(boolean flag)
                        throws java.io.IOException,
                               AutomationException

Capitolize the units in the scale string.

Specified by:

setCapitolizeUnits in interface IScaleFormat

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCapitolizeUnits

public boolean isCapitolizeUnits()
                          throws java.io.IOException,
                                 AutomationException

Capitolize the units in the scale string.

Specified by:

isCapitolizeUnits in interface IScaleFormat

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbbreviateUnits

public void setAbbreviateUnits(boolean flag)
                        throws java.io.IOException,
                               AutomationException

Abbreviate the units in the scale string.

Specified by:

setAbbreviateUnits in interface IScaleFormat

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbbreviateUnits

public boolean isAbbreviateUnits()
                          throws java.io.IOException,
                                 AutomationException

Abbreviate the units in the scale string.

Specified by:

isAbbreviateUnits in interface IScaleFormat

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReverseOrder

public void setReverseOrder(boolean flag)
                     throws java.io.IOException,
                            AutomationException

Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].

Specified by:

setReverseOrder in interface IScaleFormat

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReverseOrder

public boolean isReverseOrder()
                       throws java.io.IOException,
                              AutomationException

Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].

Specified by:

isReverseOrder in interface IScaleFormat

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomFormat

public void setCustomFormat(java.lang.String format)
                     throws java.io.IOException,
                            AutomationException

A string defining the scale format. Embed XML tokens where scale values should go, i.e., . Possible attributes: Scale, Separator, PageUnitValue, PageUnits, EqualsText, MapUnits.

Specified by:

setCustomFormat in interface IScaleFormat

Parameters:

format - The format (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomFormat

public java.lang.String getCustomFormat()
                                 throws java.io.IOException,
                                        AutomationException

A string defining the scale format. Embed XML tokens where scale values should go, i.e., . Possible attributes: Scale, Separator, PageUnitValue, PageUnits, EqualsText, MapUnits.

Specified by:

getCustomFormat in interface IScaleFormat

Returns:

The format

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calcMapUnitValue

public double calcMapUnitValue(double absoluteScale)
                        throws java.io.IOException,
                               AutomationException

Calculate the number of map units corresponding to the specified page units at the given absolute scale.

Specified by:

calcMapUnitValue in interface IScaleFormat

Parameters:

absoluteScale - The absoluteScale (in)

Returns:

The mapUnitValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

scaleToString

public java.lang.String scaleToString(double scale)
                               throws java.io.IOException,
                                      AutomationException

Convert the absolute scale to a string using the current IScaleFormat attributes.

Specified by:

scaleToString in interface IScaleFormat

Parameters:

scale - The scale (in)

Returns:

The scaleStr

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stringToScale

public double stringToScale(java.lang.String scaleStr)
                     throws java.io.IOException,
                            AutomationException

Convert the string to an absolute scale using the current IScaleFormat attributes.

Specified by:

stringToScale in interface IScaleFormat

Parameters:

scaleStr - The scaleStr (in)

Returns:

The scale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToRegistry

public void saveToRegistry()
                    throws java.io.IOException,
                           AutomationException

Store the scale format as the system default.

Specified by:

saveToRegistry in interface IScaleFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromRegistry

public void loadFromRegistry()
                      throws java.io.IOException,
                             AutomationException

Obtain the scale format to the system default.

Specified by:

loadFromRegistry in interface IScaleFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException