com.esri.arcgis.system

Interface IScaleFormat

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IScaleFormatProxy, ScaleFormat

public interface IScaleFormat
extends java.io.Serializable

COM Interface 'IScaleFormat'. Generated 4/9/2024 11:09:18 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description: 'Provides access to scale formatting options.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDae9eda31_a9f0_4687_b3a5_8c061c92d3eb
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
double	calcMapUnitValue(double absoluteScale) Calculate the number of map units corresponding to the specified page units at the given absolute scale.
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.
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.
boolean	isAbbreviateUnits() Abbreviate the units in the scale string.
boolean	isCapitolizeUnits() Capitolize the units in the scale string.
boolean	isReverseOrder() Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
void	loadFromRegistry() Obtain the scale format to the system default.
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.

Field Detail

IIDae9eda31_a9f0_4687_b3a5_8c061c92d3eb

static final int IIDae9eda31_a9f0_4687_b3a5_8c061c92d3eb

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setFormat

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

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

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

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

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

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

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

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

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

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

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

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

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.

Parameters:

separator - The separator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSeparator

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.

Returns:

The separator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageUnitValue

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.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageUnitValue

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.

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageUnits

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.

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

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

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

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

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

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

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEquals

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

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

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapUnits

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.

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

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

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

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

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

Capitolize the units in the scale string.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCapitolizeUnits

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

Capitolize the units in the scale string.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAbbreviateUnits

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

Abbreviate the units in the scale string.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAbbreviateUnits

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

Abbreviate the units in the scale string.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReverseOrder

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].

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReverseOrder

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].

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomFormat

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.

Parameters:

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomFormat

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.

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

calcMapUnitValue

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.

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

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

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

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

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

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

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

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

Store the scale format as the system default.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadFromRegistry

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

Obtain the scale format to the system default.

Throws:

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

AutomationException - If the ArcObject component throws an exception.