com.esri.arcgis.schematic
Class NgVectorImage

java.lang.Object
  com.esri.arcgis.schematic.NgVectorImage

All Implemented Interfaces:

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

public class NgVectorImage
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgVectorImage

Graphic vector image object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NgVectorImage(Object obj)
Construct a NgVectorImage using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	delete() Removes the vector image.
boolean	equals(Object o) Compare this object with another
Object	getEffect(int effect) Returns the effect 'effect' set for the vector image (see esriNgVectorImageEffect).
String	getName() Name of the vector image.
INgView	getView() View the vector image is associated with.
int	hashCode() the hashcode for this object
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the vector image is set (see esriNgVectorImageEffect).
void	move(double x, double y, int moveMode) Moves the vector image to the (x,y) relative or absolute position.
void	removeEffect(int effect) Restores the default effect 'effect' set for the vector image.
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' set for the vector image (see esriNgVectorImageEffect).

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

NgVectorImage

public NgVectorImage(Object obj)
              throws IOException

Construct a NgVectorImage using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgVectorImage.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NgVectorImage o = (NgVectorImage)obj; // will not work

NgVectorImage o = new NgVectorImage(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems NgVectorImage theNgVectorImage = (NgVectorImage) obj;

Method Detail

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

getView

public INgView getView()
                throws IOException,
                       AutomationException

View the vector image is associated with.

Description

This view is set when the vector image is created using the INgView CreateVectorImage method in the project code or when the predefined ViewVectorImages attribute for the diagram type related to this view has been defined.

Product Availability

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

Specified by:

getView in interface INgVectorImage

Returns:

A reference to a com.esri.arcgis.schematic.INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.createVectorImage(String, String)

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the vector image.

Description

It is the name given to the vector image when it is created.

Product Availability

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

Specified by:

getName in interface INgVectorImage

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEffect

public Object getEffect(int effect)
                 throws IOException,
                        AutomationException

Returns the effect 'effect' set for the vector image (see esriNgVectorImageEffect).

Product Availability

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

Specified by:

getEffect in interface INgVectorImage

Parameters:

effect - A com.esri.arcgis.schematic.esriNgVectorImageEffect constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgVectorImage.isEffectSet(int), INgVectorImage.removeEffect(int), INgVectorImage.setEffect(int, java.lang.Object)

setEffect

public void setEffect(int effect,
                      Object effValue)
               throws IOException,
                      AutomationException

Modifies the effect 'effect' set for the vector image (see esriNgVectorImageEffect).

Product Availability

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

Specified by:

setEffect in interface INgVectorImage

Parameters:

effect - A com.esri.arcgis.schematic.esriNgVectorImageEffect constant (in)

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgVectorImage.isEffectSet(int), INgVectorImage.removeEffect(int), INgVectorImage.getEffect(int)

removeEffect

public void removeEffect(int effect)
                  throws IOException,
                         AutomationException

Restores the default effect 'effect' set for the vector image.

Description

Note that when removing an effect that is always set, the vector image default effect value is automatically restored; and removing an effect that is not set by default, really removes the vector image effect.

Product Availability

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

Specified by:

removeEffect in interface INgVectorImage

Parameters:

effect - A com.esri.arcgis.schematic.esriNgVectorImageEffect constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgVectorImage.isEffectSet(int), INgVectorImage.setEffect(int, java.lang.Object), INgVectorImage.getEffect(int)

delete

public void delete()
            throws IOException,
                   AutomationException

Removes the vector image.

Product Availability

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

Specified by:

delete in interface INgVectorImage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgVectorImage.move(double, double, int), INgView.createVectorImage(String, String)

move

public void move(double x,
                 double y,
                 int moveMode)
          throws IOException,
                 AutomationException

Moves the vector image to the (x,y) relative or absolute position.

Description

The values taken by the moveMode parameter are detailed in the esriNgMoveMode list.

The default value for moveMode is esriNgAbsoluteMove, which means that, by default, the background vector image is moved to the (X,Y) absolute position.

Product Availability

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

Specified by:

move in interface INgVectorImage

Parameters:

x - The x (in)

y - The y (in)

moveMode - A com.esri.arcgis.schematic.esriNgMoveMode constant (in, optional, pass 2085 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.createVectorImage(String, String), INgVectorImage.delete()

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the vector image is set (see esriNgVectorImageEffect).

Description

By default, Schematics automatically sets default values for some vector image effects (see the List of the INgVectorImage default effects values, below). For all these effects, the IsEffectSet method returns True.

For the others effects (those that are not automatically set by default), the IsEffectSet method returns True only if the effect has been set by calling the SetEffect method in the project.

List of the INgVectorImage effect default values

esriNgVectorImageVisibility: esriNgVisible

esriNgVectorImagePriority: 0

For more details, see Vector Image Effects Definitions.

Product Availability

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

Specified by:

isEffectSet in interface INgVectorImage

Parameters:

effect - A com.esri.arcgis.schematic.esriNgVectorImageEffect constant (in)

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgVectorImage.removeEffect(int), INgVectorImage.setEffect(int, java.lang.Object), INgVectorImage.getEffect(int)