com.esri.arcgis.carto
Class LegendFormat

java.lang.Object
  extended by com.esri.arcgis.carto.LegendFormat
All Implemented Interfaces:
ILegendFormat, ILegendLayout, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class LegendFormat
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILegendFormat, ILegendLayout, IPersistStream, IPersist, IClone, Externalizable

A legend format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
LegendFormat()
          Constructs a LegendFormat using ArcGIS Engine.
LegendFormat(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LegendFormat theLegendFormat = (LegendFormat) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 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.
 IAreaPatch getDefaultAreaPatch()
          Area patch.
 ILinePatch getDefaultLinePatch()
          Line patch.
 double getDefaultPatchHeight()
          Patch height in points.
 double getDefaultPatchWidth()
          Patch width in points.
 double getGroupGap()
          Vertical distance in points between legend groups.
 double getHeadingGap()
          Vertical distance in points between a heading and the legend graphics that follow.
 double getHorizontalItemGap()
          Horizontal distance in points between legend item columns.
 double getHorizontalPatchGap()
          Horizontal distance in points between a patch and the legend graphics before and after.
 double getLayerNameGap()
          Vertical distance in points between layer names and the legend graphics that follow.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 double getTextGap()
          Horizontal distance in points between labels and descriptions.
 double getTitleGap()
          Vertical distance in points between title and first legend item.
 int getTitlePosition()
          Legend title position.
 ITextSymbol getTitleSymbol()
          Text symbol used to draw the legend title.
 double getVerticalItemGap()
          Vertical distance in points between legend items.
 double getVerticalPatchGap()
          Vertical distance in points between patches.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isScaleGraphicsOnResize()
          Indicates if graphics are scaled when the legend is resized.
 boolean isShowTitle()
          Indicates if title is visibile.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void scale(double xScale, double yScale)
          Multiply all distances, gaps, and size property values on this interface by the specified scale factors.
 void setDefaultAreaPatch(IAreaPatch patch)
          Area patch.
 void setDefaultLinePatch(ILinePatch patch)
          Line patch.
 void setDefaultPatchHeight(double height)
          Patch height in points.
 void setDefaultPatchWidth(double width)
          Patch width in points.
 void setGroupGap(double gap)
          Vertical distance in points between legend groups.
 void setHeadingGap(double gap)
          Vertical distance in points between a heading and the legend graphics that follow.
 void setHorizontalItemGap(double gap)
          Horizontal distance in points between legend item columns.
 void setHorizontalPatchGap(double gap)
          Horizontal distance in points between a patch and the legend graphics before and after.
 void setLayerNameGap(double gap)
          Vertical distance in points between layer names and the legend graphics that follow.
 void setScaleGraphicsOnResize(boolean scaleGraphicsOnResize)
          Indicates if graphics are scaled when the legend is resized.
 void setShowTitle(boolean showTitle)
          Indicates if title is visibile.
 void setTextGap(double gap)
          Horizontal distance in points between labels and descriptions.
 void setTitleGap(double gap)
          Vertical distance in points between title and first legend item.
 void setTitlePosition(int pos)
          Legend title position.
 void setTitleSymbol(ITextSymbol symbol)
          Text symbol used to draw the legend title.
 void setVerticalItemGap(double gap)
          Vertical distance in points between legend items.
 void setVerticalPatchGap(double gap)
          Vertical distance in points between patches.
 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

LegendFormat

public LegendFormat()
             throws IOException,
                    UnknownHostException
Constructs a LegendFormat using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

LegendFormat

public LegendFormat(Object obj)
             throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LegendFormat theLegendFormat = (LegendFormat) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

isShowTitle

public boolean isShowTitle()
                    throws IOException,
                           AutomationException
Indicates if title is visibile.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isShowTitle in interface ILegendFormat
Returns:
The showTitle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowTitle

public void setShowTitle(boolean showTitle)
                  throws IOException,
                         AutomationException
Indicates if title is visibile.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShowTitle in interface ILegendFormat
Parameters:
showTitle - The showTitle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTitleSymbol

public ITextSymbol getTitleSymbol()
                           throws IOException,
                                  AutomationException
Text symbol used to draw the legend title.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTitleSymbol in interface ILegendFormat
Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTitleSymbol

public void setTitleSymbol(ITextSymbol symbol)
                    throws IOException,
                           AutomationException
Text symbol used to draw the legend title.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTitleSymbol in interface ILegendFormat
Parameters:
symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTitlePosition

public int getTitlePosition()
                     throws IOException,
                            AutomationException
Legend title position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTitlePosition in interface ILegendFormat
Returns:
A com.esri.arcgis.carto.esriRectanglePosition constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTitlePosition

public void setTitlePosition(int pos)
                      throws IOException,
                             AutomationException
Legend title position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTitlePosition in interface ILegendFormat
Parameters:
pos - A com.esri.arcgis.carto.esriRectanglePosition constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTitleGap

public double getTitleGap()
                   throws IOException,
                          AutomationException
Vertical distance in points between title and first legend item.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTitleGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTitleGap

public void setTitleGap(double gap)
                 throws IOException,
                        AutomationException
Vertical distance in points between title and first legend item.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTitleGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVerticalItemGap

public double getVerticalItemGap()
                          throws IOException,
                                 AutomationException
Vertical distance in points between legend items.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVerticalItemGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerticalItemGap

public void setVerticalItemGap(double gap)
                        throws IOException,
                               AutomationException
Vertical distance in points between legend items.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVerticalItemGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHorizontalItemGap

public double getHorizontalItemGap()
                            throws IOException,
                                   AutomationException
Horizontal distance in points between legend item columns. Used for legends that have more than one column.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHorizontalItemGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHorizontalItemGap

public void setHorizontalItemGap(double gap)
                          throws IOException,
                                 AutomationException
Horizontal distance in points between legend item columns. Used for legends that have more than one column.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHorizontalItemGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerNameGap

public double getLayerNameGap()
                       throws IOException,
                              AutomationException
Vertical distance in points between layer names and the legend graphics that follow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLayerNameGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerNameGap

public void setLayerNameGap(double gap)
                     throws IOException,
                            AutomationException
Vertical distance in points between layer names and the legend graphics that follow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLayerNameGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGroupGap

public double getGroupGap()
                   throws IOException,
                          AutomationException
Vertical distance in points between legend groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGroupGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGroupGap

public void setGroupGap(double gap)
                 throws IOException,
                        AutomationException
Vertical distance in points between legend groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGroupGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeadingGap

public double getHeadingGap()
                     throws IOException,
                            AutomationException
Vertical distance in points between a heading and the legend graphics that follow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHeadingGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeadingGap

public void setHeadingGap(double gap)
                   throws IOException,
                          AutomationException
Vertical distance in points between a heading and the legend graphics that follow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHeadingGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextGap

public double getTextGap()
                  throws IOException,
                         AutomationException
Horizontal distance in points between labels and descriptions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTextGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextGap

public void setTextGap(double gap)
                throws IOException,
                       AutomationException
Horizontal distance in points between labels and descriptions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTextGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVerticalPatchGap

public double getVerticalPatchGap()
                           throws IOException,
                                  AutomationException
Vertical distance in points between patches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVerticalPatchGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerticalPatchGap

public void setVerticalPatchGap(double gap)
                         throws IOException,
                                AutomationException
Vertical distance in points between patches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVerticalPatchGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHorizontalPatchGap

public double getHorizontalPatchGap()
                             throws IOException,
                                    AutomationException
Horizontal distance in points between a patch and the legend graphics before and after.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHorizontalPatchGap in interface ILegendFormat
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHorizontalPatchGap

public void setHorizontalPatchGap(double gap)
                           throws IOException,
                                  AutomationException
Horizontal distance in points between a patch and the legend graphics before and after.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setHorizontalPatchGap in interface ILegendFormat
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultPatchWidth

public double getDefaultPatchWidth()
                            throws IOException,
                                   AutomationException
Patch width in points. Can be overridden by the LegendItem.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultPatchWidth in interface ILegendFormat
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultPatchWidth

public void setDefaultPatchWidth(double width)
                          throws IOException,
                                 AutomationException
Patch width in points. Can be overridden by the LegendItem.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultPatchWidth in interface ILegendFormat
Parameters:
width - The width (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultPatchHeight

public double getDefaultPatchHeight()
                             throws IOException,
                                    AutomationException
Patch height in points. Can be overridden by the LegendItem.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultPatchHeight in interface ILegendFormat
Returns:
The height
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultPatchHeight

public void setDefaultPatchHeight(double height)
                           throws IOException,
                                  AutomationException
Patch height in points. Can be overridden by the LegendItem.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultPatchHeight in interface ILegendFormat
Parameters:
height - The height (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultLinePatch

public ILinePatch getDefaultLinePatch()
                               throws IOException,
                                      AutomationException
Line patch. Can be overridden by the LegendItem.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultLinePatch in interface ILegendFormat
Returns:
A reference to a com.esri.arcgis.carto.ILinePatch
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultLinePatch

public void setDefaultLinePatch(ILinePatch patch)
                         throws IOException,
                                AutomationException
Line patch. Can be overridden by the LegendItem.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultLinePatch in interface ILegendFormat
Parameters:
patch - A reference to a com.esri.arcgis.carto.ILinePatch (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultAreaPatch

public IAreaPatch getDefaultAreaPatch()
                               throws IOException,
                                      AutomationException
Area patch. Can be overridden by the LegendItem.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultAreaPatch in interface ILegendFormat
Returns:
A reference to a com.esri.arcgis.carto.IAreaPatch
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultAreaPatch

public void setDefaultAreaPatch(IAreaPatch patch)
                         throws IOException,
                                AutomationException
Area patch. Can be overridden by the LegendItem.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultAreaPatch in interface ILegendFormat
Parameters:
patch - A reference to a com.esri.arcgis.carto.IAreaPatch (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

scale

public void scale(double xScale,
                  double yScale)
           throws IOException,
                  AutomationException
Multiply all distances, gaps, and size property values on this interface by the specified scale factors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
scale in interface ILegendFormat
Parameters:
xScale - The xScale (in)
yScale - The yScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleGraphicsOnResize

public void setScaleGraphicsOnResize(boolean scaleGraphicsOnResize)
                              throws IOException,
                                     AutomationException
Indicates if graphics are scaled when the legend is resized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setScaleGraphicsOnResize in interface ILegendLayout
Parameters:
scaleGraphicsOnResize - The scaleGraphicsOnResize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleGraphicsOnResize

public boolean isScaleGraphicsOnResize()
                                throws IOException,
                                       AutomationException
Indicates if graphics are scaled when the legend is resized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isScaleGraphicsOnResize in interface ILegendLayout
Returns:
The scaleGraphicsOnResize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException