com.esri.arcgis.carto
Class ImageType

java.lang.Object
  com.esri.arcgis.carto.ImageType

All Implemented Interfaces:

IImageType, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class ImageType
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageType, IXMLSerialize, IPersistStream, IPersist, Externalizable

The Image Type coclass contains information about the type of image to be generated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ImageType()
Constructs a ImageType using ArcGIS Engine.

ImageType(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ImageType theImageType = (ImageType) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getFormat() The image format.
int	getReturnType() The return type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setFormat(int imageFormat) The image format.
void	setReturnType(int returnType) The return type.
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

ImageType

public ImageType()
          throws IOException,
                 UnknownHostException

Constructs a ImageType using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ImageType

public ImageType(Object obj)
          throws IOException

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

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

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

getFormat

public int getFormat()
              throws IOException,
                     AutomationException

The image format.

Remarks

Supported image formats include: BMP, JPG, DIB, TIFF, PNG, PNG24, EMF, PS, PDF, AI, GIF, SVG and SVGZ. When a PNG24 image is requested from MapServer and in the same request specifies a transparent color, a 32-bit PNG is returned in order to support the transparency. The transparency is within the alpha channel and only supports only binary transparency.

Please note that optimized MapServices do not support the Adobe Illustrator (AI) format. However they additionally support the PNG32 image format with full alpha channel transparency support. PNG32 maintains transparency in the image that is set on the layer in the source map. To find out what image formats are supported by a map service, use the IMapServer2::ServiceConfigurationInfo property.

If SupportedImageFormatTypes is missing from ServiceConfigurationInfo, the MapService supports image formats mentioned in the first line.

The PNG32 image format is only supported by the ExportMapImage function on an optimized MapService. In order to maintain backward compatibility, the PNG32 format is not explicitly included in the esriImageFormat enum. To request the PNG32 format, cast the value 13 to type esriImageFormat in code section below.

Any export function, for both standard and optimized MapServer, that does not support PNG32 returns PNG24 when asked for this image type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFormat in interface IImageType

Returns:

A com.esri.arcgis.carto.esriImageFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormat

public void setFormat(int imageFormat)
               throws IOException,
                      AutomationException

The image format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFormat in interface IImageType

Parameters:

imageFormat - A com.esri.arcgis.carto.esriImageFormat constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReturnType

public int getReturnType()
                  throws IOException,
                         AutomationException

The return type.

Remarks

ReturnType includes URL and MimeData. If URL is specified the image is stored as a file at the specified location (Physical Output Directory) and can be accessed by internet clients through the Virtual Output Directory. If MIME is specified a stream of bytes is returned to the client.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReturnType in interface IImageType

Returns:

A com.esri.arcgis.carto.esriImageReturnType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnType

public void setReturnType(int returnType)
                   throws IOException,
                          AutomationException

The return type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReturnType in interface IImageType

Parameters:

returnType - A com.esri.arcgis.carto.esriImageReturnType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

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.

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