public interface IScaleFormat
extends java.io.Serializable
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 =
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
|
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.
|
static final int IIDae9eda31_a9f0_4687_b3a5_8c061c92d3eb
static final int xxDummy
static final java.lang.String IID
void setFormat(int format) throws java.io.IOException, AutomationException
format
- A com.esri.arcgis.system.esriScaleFormat constant (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.int getFormat() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setNumberFormat(INumberFormat format) throws java.io.IOException, AutomationException
format
- A reference to a com.esri.arcgis.system.INumberFormat (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.INumberFormat getNumberFormat() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setSeparator(java.lang.String separator) throws java.io.IOException, AutomationException
separator
- The separator (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.java.lang.String getSeparator() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setPageUnitValue(double value) throws java.io.IOException, AutomationException
value
- The value (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.double getPageUnitValue() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setPageUnits(int units) throws java.io.IOException, AutomationException
units
- A com.esri.arcgis.system.esriUnits constant (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.int getPageUnits() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setEquals(java.lang.String text) throws java.io.IOException, AutomationException
text
- The text (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.java.lang.String getEquals() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setMapUnits(int units) throws java.io.IOException, AutomationException
units
- A com.esri.arcgis.system.esriUnits constant (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.int getMapUnits() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setCapitolizeUnits(boolean flag) throws java.io.IOException, AutomationException
flag
- The flag (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.boolean isCapitolizeUnits() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setAbbreviateUnits(boolean flag) throws java.io.IOException, AutomationException
flag
- The flag (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.boolean isAbbreviateUnits() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setReverseOrder(boolean flag) throws java.io.IOException, AutomationException
flag
- The flag (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.boolean isReverseOrder() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void setCustomFormat(java.lang.String format) throws java.io.IOException, AutomationException
format
- The format (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.java.lang.String getCustomFormat() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.double calcMapUnitValue(double absoluteScale) throws java.io.IOException, AutomationException
absoluteScale
- The absoluteScale (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.java.lang.String scaleToString(double scale) throws java.io.IOException, AutomationException
scale
- The scale (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.double stringToScale(java.lang.String scaleStr) throws java.io.IOException, AutomationException
scaleStr
- The scaleStr (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void saveToRegistry() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.void loadFromRegistry() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.