com.esri.arcgis.schematic
Class INgRasterImageProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.schematic.INgRasterImageProxy

All Implemented Interfaces:

INgRasterImage, Externalizable, Serializable

public class INgRasterImageProxy
extends com.esri.arcgis.interop.Dispatch
implements INgRasterImage, Serializable

Provides access to members that control the raster image.

Description

A raster image is a BMP format image placed in a view background.

Product Availability

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

See Also:

INgVectorImage, Serialized Form

Field Summary

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

	INgRasterImageProxy()
	INgRasterImageProxy(Object obj)
protected	INgRasterImageProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	delete() Removes the raster image.
Object	getEffect(int effect) Returns the effect 'effect' set for the raster image (see esriNgRasterImageEffect).
String	getName() Name of the raster image.
INgView	getView() View the raster image is associated with.
boolean	isEffectSet(int effect) Indicates if the effect 'effect' related to the raster image is set (see esriNgRasterImageEffect).
void	move(double x, double y, int moveMode) Moves the raster image to the (x,y) relative or absolute position.
void	readExternal(ObjectInput in)
void	removeEffect(int effect) Restores the default effect 'effect' set for the raster image.
void	removeListener(String iidStr, Object theListener)
void	setEffect(int effect, Object effValue) Modifies the effect 'effect' set for the raster image (see esriNgRasterImageEffect).
void	writeExternal(ObjectOutput out)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

INgRasterImageProxy

public INgRasterImageProxy()

INgRasterImageProxy

public INgRasterImageProxy(Object obj)
                    throws IOException

Throws:

IOException

INgRasterImageProxy

protected INgRasterImageProxy(Object obj,
                              String iid)
                       throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getView

public INgView getView()
                throws IOException,
                       AutomationException

View the raster image is associated with.

Description

This view is set when the raster image is created using the INgView CreateRasterImage method in the project code or when the predefined ViewRasterImages 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 INgRasterImage

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.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the raster image.

Description

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

Product Availability

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

Specified by:

getName in interface INgRasterImage

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

getEffect

public Object getEffect(int effect)
                 throws IOException,
                        AutomationException

Returns the effect 'effect' set for the raster image (see esriNgRasterImageEffect).

Product Availability

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

Specified by:

getEffect in interface INgRasterImage

Parameters:

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

setEffect

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

Modifies the effect 'effect' set for the raster image (see esriNgRasterImageEffect).

Product Availability

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

Specified by:

setEffect in interface INgRasterImage

Parameters:

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

effValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

removeEffect

public void removeEffect(int effect)
                  throws IOException,
                         AutomationException

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

Description

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

Product Availability

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

Specified by:

removeEffect in interface INgRasterImage

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

delete

public void delete()
            throws IOException,
                   AutomationException

Removes the raster image.

Product Availability

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

Specified by:

delete in interface INgRasterImage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgRasterImage.move(double, double, int), INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

isEffectSet

public boolean isEffectSet(int effect)
                    throws IOException,
                           AutomationException

Indicates if the effect 'effect' related to the raster image is set (see esriNgRasterImageEffect).

Description

By default, Schematics automatically sets default values for some raster image effects (see the List of the INgRasterImage effect default 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 INgRasterImage effect default values

esriNgRasterImageVisibility: esriNgVisible

esriNgRasterImagePriority: 0

esriNgRasterImageHeight: the image's height

esriNgRasterImageWidth: the image's width

For more details, see Raster Image Effects Definitions

Product Availability

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

Specified by:

isEffectSet in interface INgRasterImage

Parameters:

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

Returns:

The isSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

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

move

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

Moves the raster 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 raster 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 INgRasterImage

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:

INgRasterImage.delete(), INgView.createRasterImage(String, String, com.esri.arcgis.schematic.INgPoint, com.esri.arcgis.schematic.INgPoint)

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

ClassNotFoundException