|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.system.ScaleFormat
public class ScaleFormat
A utility object for formatting scale.
| Constructor Summary | |
|---|---|
ScaleFormat()
Constructs a ScaleFormat using ArcGIS Engine. |
|
ScaleFormat(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ScaleFormat theScaleFormat = (ScaleFormat) obj; |
|
| Method Summary | |
|---|---|
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. |
Object |
convertToSupportedObject(int docVersion)
Convert the object to another object that is supported. |
boolean |
equals(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 String |
getClsid()
getClsid. |
String |
getCustomFormat()
A string defining the scale format. |
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. |
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(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
saveToRegistry()
Store the scale format as the system default. |
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(String format)
A string defining the scale format. |
void |
setEquals(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(String separator)
Character(s) used to separate '1' from the scale in an absolute scale, i.e., the ':' in 1:20000. |
double |
stringToScale(String scaleStr)
Convert the string to an absolute scale using the current IScaleFormat attributes. |
void |
writeExternal(ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public ScaleFormat()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public ScaleFormat(Object obj)
throws IOException
ScaleFormat theScaleFormat = (ScaleFormat) obj;
obj to ScaleFormat.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void setFormat(int format)
throws IOException,
AutomationException
setFormat in interface IScaleFormatformat - A com.esri.arcgis.system.esriScaleFormat constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getFormat()
throws IOException,
AutomationException
getFormat in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNumberFormat(INumberFormat format)
throws IOException,
AutomationException
setNumberFormat in interface IScaleFormatformat - A reference to a com.esri.arcgis.system.INumberFormat (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INumberFormat getNumberFormat()
throws IOException,
AutomationException
getNumberFormat in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSeparator(String separator)
throws IOException,
AutomationException
setSeparator in interface IScaleFormatseparator - The separator (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getSeparator()
throws IOException,
AutomationException
getSeparator in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPageUnitValue(double value)
throws IOException,
AutomationException
setPageUnitValue in interface IScaleFormatvalue - The value (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getPageUnitValue()
throws IOException,
AutomationException
getPageUnitValue in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPageUnits(int units)
throws IOException,
AutomationException
setPageUnits in interface IScaleFormatunits - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getPageUnits()
throws IOException,
AutomationException
getPageUnits in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setEquals(String text)
throws IOException,
AutomationException
setEquals in interface IScaleFormattext - The text (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getEquals()
throws IOException,
AutomationException
getEquals in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMapUnits(int units)
throws IOException,
AutomationException
setMapUnits in interface IScaleFormatunits - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getMapUnits()
throws IOException,
AutomationException
getMapUnits in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCapitolizeUnits(boolean flag)
throws IOException,
AutomationException
setCapitolizeUnits in interface IScaleFormatflag - The flag (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCapitolizeUnits()
throws IOException,
AutomationException
isCapitolizeUnits in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAbbreviateUnits(boolean flag)
throws IOException,
AutomationException
setAbbreviateUnits in interface IScaleFormatflag - The flag (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isAbbreviateUnits()
throws IOException,
AutomationException
isAbbreviateUnits in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setReverseOrder(boolean flag)
throws IOException,
AutomationException
setReverseOrder in interface IScaleFormatflag - The flag (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isReverseOrder()
throws IOException,
AutomationException
isReverseOrder in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCustomFormat(String format)
throws IOException,
AutomationException
setCustomFormat in interface IScaleFormatformat - The format (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCustomFormat()
throws IOException,
AutomationException
getCustomFormat in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double calcMapUnitValue(double absoluteScale)
throws IOException,
AutomationException
calcMapUnitValue in interface IScaleFormatabsoluteScale - The absoluteScale (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String scaleToString(double scale)
throws IOException,
AutomationException
scaleToString in interface IScaleFormatscale - The scale (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double stringToScale(String scaleStr)
throws IOException,
AutomationException
stringToScale in interface IScaleFormatscaleStr - The scaleStr (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void saveToRegistry()
throws IOException,
AutomationException
saveToRegistry in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void loadFromRegistry()
throws IOException,
AutomationException
loadFromRegistry in interface IScaleFormatIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClone esri_clone()
throws IOException,
AutomationException
esri_clone in interface ICloneIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws IOException,
AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws IOException,
AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isSupportedAtVersion(int docVersion)
throws IOException,
AutomationException
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.
isSupportedAtVersion in interface IDocumentVersionSupportGENdocVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object convertToSupportedObject(int docVersion)
throws IOException,
AutomationException
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.
convertToSupportedObject in interface IDocumentVersionSupportGENdocVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||