com.esri.arcgis.system
Class IScaleFormatProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.system.IScaleFormatProxy
All Implemented Interfaces:
IScaleFormat, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for COM Interface 'IScaleFormat'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSystem.olb'

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 =

public class IScaleFormatProxy
extends com.esri.arcgis.interop.Dispatch
implements IScaleFormat, java.io.Serializable

Internal use class

See Also:
Serialized Form

Field Summary
 boolean noncastable
          Deprecated.  
static java.lang.Class targetClass
          Deprecated.  
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.system.IScaleFormat
IID, IIDae9eda31_a9f0_4687_b3a5_8c061c92d3eb
 
Constructor Summary
  IScaleFormatProxy()
          Deprecated. For internal use only
  IScaleFormatProxy(java.lang.Object obj)
          Deprecated.  
protected IScaleFormatProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  IScaleFormatProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected IScaleFormatProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Deprecated.  
 double calcMapUnitValue(double absoluteScale)
          Deprecated. Calculate the number of map units corresponding to the specified page units at the given absolute scale.
 java.lang.String getCustomFormat()
          Deprecated. A string defining the scale format.
 java.lang.String getEquals()
          Deprecated. The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
 int getFormat()
          Deprecated. Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
 int getMapUnits()
          Deprecated. The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
 INumberFormat getNumberFormat()
          Deprecated. Format used to display scale value, i.e., 20,000.
 int getPageUnits()
          Deprecated. The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
 double getPageUnitValue()
          Deprecated. The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
 java.lang.String getSeparator()
          Deprecated. Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000.
 boolean isAbbreviateUnits()
          Deprecated. Abbreviate the units in the scale string.
 boolean isCapitolizeUnits()
          Deprecated. Capitolize the units in the scale string.
 boolean isReverseOrder()
          Deprecated. Reverse the standard order [1:1000] becomes [1000:1] and [1 in = 10 mi] becomes [10 mi = 1 in].
 void loadFromRegistry()
          Deprecated. Obtain the scale format to the system default.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void saveToRegistry()
          Deprecated. Store the scale format as the system default.
 java.lang.String scaleToString(double scale)
          Deprecated. Convert the absolute scale to a string using the current IScaleFormat attributes.
 void setAbbreviateUnits(boolean flag)
          Deprecated. Abbreviate the units in the scale string.
 void setCapitolizeUnits(boolean flag)
          Deprecated. Capitolize the units in the scale string.
 void setCustomFormat(java.lang.String format)
          Deprecated. A string defining the scale format.
 void setEquals(java.lang.String text)
          Deprecated. The text used for 'equals', i.e., ' = ' in 1 inch = 5 miles.
 void setFormat(int format)
          Deprecated. Format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
 void setMapUnits(int units)
          Deprecated. The map units used to display a scale, i.e., the 'miles' in 1 inch = 5 miles.
 void setNumberFormat(INumberFormat format)
          Deprecated. Format used to display scale value, i.e., 20,000.
 void setPageUnits(int units)
          Deprecated. The page units used to display a scale, i.e., the 'inch' in 1 inch = 5 miles.
 void setPageUnitValue(double value)
          Deprecated. The number preceding the page units in a scale, i.e., the '1' in 1 inch = 5 miles.
 void setReverseOrder(boolean flag)
          Deprecated. 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)
          Deprecated. 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)
          Deprecated. Convert the string to an absolute scale using the current IScaleFormat attributes.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Deprecated. 

noncastable

public boolean noncastable
Deprecated. 
Constructor Detail

IScaleFormatProxy

public IScaleFormatProxy(java.lang.String CLSID,
                         java.lang.String host,
                         com.esri.arcgis.interop.AuthInfo authInfo)
                  throws java.net.UnknownHostException,
                         java.io.IOException
Deprecated. 
Throws:
java.net.UnknownHostException
java.io.IOException

IScaleFormatProxy

public IScaleFormatProxy()
Deprecated. 
For internal use only


IScaleFormatProxy

public IScaleFormatProxy(java.lang.Object obj)
                  throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IScaleFormatProxy

protected IScaleFormatProxy(java.lang.Object obj,
                            java.lang.String iid)
                     throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IScaleFormatProxy

protected IScaleFormatProxy(java.lang.String CLSID,
                            java.lang.String iid,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Deprecated. 
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Deprecated. 
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

setFormat

public void setFormat(int format)
               throws java.io.IOException,
                      AutomationException
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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
Deprecated. 
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.