com.esri.arcgis.carto
Class MapFrameDescription

java.lang.Object
  extended by com.esri.arcgis.carto.MapFrameDescription
All Implemented Interfaces:
IMapFrameDescription, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class MapFrameDescription
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapFrameDescription, IXMLSerialize, IPersistStream, IPersist, java.io.Externalizable

COM Class 'MapFrameDescription'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The Map Frame Description coclass contains settings of a map frame in the current document.' 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IMapFrameDescription
IID, IID42cabfce_786d_43aa_bfa1_bb1f26aceb6b, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
MapFrameDescription()
          Constructs a MapFrameDescription using ArcGIS Engine.
MapFrameDescription(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapFrameDescription theMapFrameDescription = (MapFrameDescription) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IMapDescription getMapDescription()
          The map description for the map contained in the frame.
 IEnvelope getPageLocation()
          The extent of the map frame on the page.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a MapFrameDescription.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setMapDescriptionByRef(IMapDescription mapDesc)
          The map description for the map contained in the frame.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

MapFrameDescription

public MapFrameDescription()
                    throws java.io.IOException,
                           java.net.UnknownHostException
Constructs a MapFrameDescription using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

MapFrameDescription

public MapFrameDescription(java.lang.Object obj)
                    throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapFrameDescription theMapFrameDescription = (MapFrameDescription) obj;

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

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

getClsid

public static java.lang.String getClsid()
getClsid.


equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a MapFrameDescription.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getPageLocation

public IEnvelope getPageLocation()
                          throws java.io.IOException,
                                 AutomationException
The extent of the map frame on the page.

Specified by:
getPageLocation in interface IMapFrameDescription
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapDescription

public IMapDescription getMapDescription()
                                  throws java.io.IOException,
                                         AutomationException
The map description for the map contained in the frame.

Specified by:
getMapDescription in interface IMapFrameDescription
Returns:
A reference to a com.esri.arcgis.carto.IMapDescription
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapDescriptionByRef

public void setMapDescriptionByRef(IMapDescription mapDesc)
                            throws java.io.IOException,
                                   AutomationException
The map description for the map contained in the frame.

Specified by:
setMapDescriptionByRef in interface IMapFrameDescription
Parameters:
mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

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

save

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

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

getSizeMax

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

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

getClassID

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

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

writeExternal

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

readExternal

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