com.esri.arcgis.arcweb
Class ArcWebRouteDisplayOptions

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

All Implemented Interfaces:

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

public class ArcWebRouteDisplayOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebRouteDisplayOptions

A set of parameters describing the way a route is displayed.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebRouteDisplayOptions()
Constructs a ArcWebRouteDisplayOptions using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IColor	getColor() The color of the route line (default is Red).
int	getThickness() The thickness of the route line in pixels 1-20 (default is 7).
double	getTransparency() The transparency of the route line 0.1-1.0 (default is 0.5 and less then 0.1 is reset to 0.5).
int	hashCode() the hashcode for this object
void	setColorByRef(IColor color) The color of the route line (default is Red).
void	setThickness(int thickness) The thickness of the route line in pixels 1-20 (default is 7).
void	setTransparency(double transpanency) The transparency of the route line 0.1-1.0 (default is 0.5 and less then 0.1 is reset to 0.5).

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

ArcWebRouteDisplayOptions

public ArcWebRouteDisplayOptions()
                          throws IOException,
                                 UnknownHostException

Constructs a ArcWebRouteDisplayOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebRouteDisplayOptions

public ArcWebRouteDisplayOptions(Object obj)
                          throws IOException

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

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

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

getColor

public IColor getColor()
                throws IOException,
                       AutomationException

The color of the route line (default is Red).

Product Availability

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

Specified by:

getColor in interface IArcWebRouteDisplayOptions

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.

setColorByRef

public void setColorByRef(IColor color)
                   throws IOException,
                          AutomationException

The color of the route line (default is Red).

Product Availability

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

Specified by:

setColorByRef in interface IArcWebRouteDisplayOptions

Parameters:

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

getThickness

public int getThickness()
                 throws IOException,
                        AutomationException

The thickness of the route line in pixels 1-20 (default is 7).

Product Availability

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

Specified by:

getThickness in interface IArcWebRouteDisplayOptions

Returns:

The thickness

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThickness

public void setThickness(int thickness)
                  throws IOException,
                         AutomationException

The thickness of the route line in pixels 1-20 (default is 7).

Product Availability

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

Specified by:

setThickness in interface IArcWebRouteDisplayOptions

Parameters:

thickness - The thickness (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

public double getTransparency()
                       throws IOException,
                              AutomationException

The transparency of the route line 0.1-1.0 (default is 0.5 and less then 0.1 is reset to 0.5).

Product Availability

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

Specified by:

getTransparency in interface IArcWebRouteDisplayOptions

Returns:

The transpanency

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(double transpanency)
                     throws IOException,
                            AutomationException

The transparency of the route line 0.1-1.0 (default is 0.5 and less then 0.1 is reset to 0.5).

Product Availability

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

Specified by:

setTransparency in interface IArcWebRouteDisplayOptions

Parameters:

transpanency - The transpanency (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.