com.esri.arcgis.carto
Class ImageDisplay

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

All Implemented Interfaces:

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

public class ImageDisplay
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IImageDisplay, IXMLSerialize, IPersistStream, IPersist, IImageDisplay2, Externalizable

The Image Display coclass contains the display characteristics of the 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

ImageDisplay()
Constructs a ImageDisplay using ArcGIS Engine.

ImageDisplay(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ImageDisplay theImageDisplay = (ImageDisplay) 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.
double	getDeviceResolution() The device resolution of the image (dots per inch).
int	getHeight() The height of the image in pixels.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IColor	getTransparentColor() Transparent color for image types that support transparent color.
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(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setDeviceResolution(double dpi) The device resolution of the image (dots per inch).
void	setHeight(int imageHeight) The height of the image in pixels.
void	setTransparentColor(IColor ppTransparentColor) Transparent color for image types that support transparent color.
void	setWidth(int imageWidth) The width of the image in pixels.
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

ImageDisplay

public ImageDisplay()
             throws IOException,
                    UnknownHostException

Constructs a ImageDisplay using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ImageDisplay

public ImageDisplay(Object obj)
             throws IOException

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

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

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

getHeight

public int getHeight()
              throws IOException,
                     AutomationException

The height of the image in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHeight in interface IImageDisplay

Specified by:

getHeight in interface IImageDisplay2

Returns:

The imageHeight

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int imageHeight)
               throws IOException,
                      AutomationException

The height of the image in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHeight in interface IImageDisplay

Specified by:

setHeight in interface IImageDisplay2

Parameters:

imageHeight - The imageHeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException

The width of the image in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface IImageDisplay

Specified by:

getWidth in interface IImageDisplay2

Returns:

The imageWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int imageWidth)
              throws IOException,
                     AutomationException

The width of the image in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWidth in interface IImageDisplay

Specified by:

setWidth in interface IImageDisplay2

Parameters:

imageWidth - The imageWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDeviceResolution

public double getDeviceResolution()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDeviceResolution in interface IImageDisplay

Specified by:

getDeviceResolution in interface IImageDisplay2

Returns:

The dpi

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeviceResolution

public void setDeviceResolution(double dpi)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDeviceResolution in interface IImageDisplay

Specified by:

setDeviceResolution in interface IImageDisplay2

Parameters:

dpi - The dpi (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.

getTransparentColor

public IColor getTransparentColor()
                           throws IOException,
                                  AutomationException

Transparent color for image types that support transparent color.

Remarks

Use this property to make a specified color transparent. This is most commonly done to make the background transparent. This can done on any MapServer function that takes an ImageDisplay as a parameter.

Setting a transparent color is valid only for formats that support transparency. These include: png, png24 and gif.

When using ExportMapImage if different colors are set as transparent in the MapDescription (TransparentColor) and in the ImageDisplay, the color set in the ImageDisplay takes precedence over the one set in the MapDescription..

To make background of the image transparent set the ImageDisplay2 TransparentColor equal to the BackgroundColor specified in IMapServerInfo2 .

Product Availability

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

Specified by:

getTransparentColor in interface IImageDisplay2

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparentColor

public void setTransparentColor(IColor ppTransparentColor)
                         throws IOException,
                                AutomationException

Transparent color for image types that support transparent color.

Product Availability

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

Specified by:

setTransparentColor in interface IImageDisplay2

Parameters:

ppTransparentColor - A reference to a com.esri.arcgis.display.IColor (in)

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