com.esri.arcgis.carto

Class LayoutImage

java.lang.Object

com.esri.arcgis.carto.LayoutImage

All Implemented Interfaces:

IImageResult, ILayoutImage, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class LayoutImage
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageResult, ILayoutImage, IXMLSerialize, IPersistStream, IPersist, java.io.Externalizable

COM Class 'LayoutImage'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description 'The Layout Image coclass contains information about the generated layout image.' 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.ILayoutImage

IID, IID904ba065_af13_40f4_a661_79b7bcfb989a, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IImageResult

IIDbe47d208_d27a_4048_a118_c9167662db74

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

Constructors

Constructor and Description
LayoutImage() Constructs a LayoutImage using ArcGIS Engine.
LayoutImage(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. LayoutImage theLayoutImage = (LayoutImage) obj;

Method Summary

Modifier and Type	Method and Description
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.
IEnvelope	getExtent() The extent of the page that is fitted to the height and width of the generated image.
int	getHeight() The height of the image in pixels.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IMapImages	getMapImages() A collection of MapImage objects contained in the layout.
byte[]	getMimeData() Binary data representing the generated image.
java.lang.String	getMimeType() The MIME type of the generated image.
double	getReferenceDPI() The device resolution of the image specified in the request (dots per inch).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getURL() The URL of the generated image.
int	getWidth() The width of the image in pixels.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
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

LayoutImage

public LayoutImage()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a LayoutImage using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LayoutImage

public LayoutImage(java.lang.Object obj)
            throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LayoutImage theLayoutImage = (LayoutImage) obj;

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getMimeData

public byte[] getMimeData()
                   throws java.io.IOException,
                          AutomationException

Binary data representing the generated image.

Specified by:

getMimeData in interface IImageResult

Returns:

An unsigned byte

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURL

public java.lang.String getURL()
                        throws java.io.IOException,
                               AutomationException

The URL of the generated image.

Specified by:

getURL in interface IImageResult

Returns:

The uRL

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws java.io.IOException,
                     AutomationException

The height of the image in pixels.

Specified by:

getHeight in interface IImageResult

Returns:

The heightPixels

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws java.io.IOException,
                    AutomationException

The width of the image in pixels.

Specified by:

getWidth in interface IImageResult

Returns:

The widthPixels

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDPI

public double getReferenceDPI()
                       throws java.io.IOException,
                              AutomationException

The device resolution of the image specified in the request (dots per inch).

Specified by:

getReferenceDPI in interface IImageResult

Returns:

The dpi

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMimeType

public java.lang.String getMimeType()
                             throws java.io.IOException,
                                    AutomationException

The MIME type of the generated image.

Specified by:

getMimeType in interface IImageResult

Returns:

The pMimeType

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent of the page that is fitted to the height and width of the generated image.

Specified by:

getExtent in interface ILayoutImage

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.

getMapImages

public IMapImages getMapImages()
                        throws java.io.IOException,
                               AutomationException

A collection of MapImage objects contained in the layout. There will be one MapImage object returned for each data frame.

Specified by:

getMapImages in interface ILayoutImage

Returns:

A reference to a com.esri.arcgis.carto.IMapImages

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