com.esri.arcgis.arcweb
Class ArcWebMapImageOptions

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebMapImageOptions

All Implemented Interfaces:

IArcWebMapImageOptions, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebMapImageOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebMapImageOptions

A set of parameters used in finding routes and generating map images.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebMapImageOptions()
Constructs a ArcWebMapImageOptions using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
IColor	getBackgroundColor() The background color of the map image (default is Red).
static String	getClsid() getClsid.
int	getHeight() The height of the map image in pixels.
int	getWidth() The width of the map image in pixels.
int	hashCode() the hashcode for this object
void	setBackgroundColorByRef(IColor backgroundColor) The background color of the map image (default is Red).
void	setHeight(int height) The height of the map image in pixels.
void	setWidth(int width) The width of the map image in pixels.

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

ArcWebMapImageOptions

public ArcWebMapImageOptions()
                      throws IOException,
                             UnknownHostException

Constructs a ArcWebMapImageOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebMapImageOptions

public ArcWebMapImageOptions(Object obj)
                      throws IOException

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

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

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

getBackgroundColor

public IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

The background color of the map image (default is Red).

Product Availability

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

Specified by:

getBackgroundColor in interface IArcWebMapImageOptions

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.

setBackgroundColorByRef

public void setBackgroundColorByRef(IColor backgroundColor)
                             throws IOException,
                                    AutomationException

The background color of the map image (default is Red).

Product Availability

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

Specified by:

setBackgroundColorByRef in interface IArcWebMapImageOptions

Parameters:

backgroundColor - 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.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException

The height of the map image in pixels.

Product Availability

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

Specified by:

getHeight in interface IArcWebMapImageOptions

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int height)
               throws IOException,
                      AutomationException

The height of the map image in pixels.

Product Availability

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

Specified by:

setHeight in interface IArcWebMapImageOptions

Parameters:

height - The height (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 map image in pixels.

Product Availability

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

Specified by:

getWidth in interface IArcWebMapImageOptions

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int width)
              throws IOException,
                     AutomationException

The width of the map image in pixels.

Product Availability

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

Specified by:

setWidth in interface IArcWebMapImageOptions

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.