com.esri.arcgis.carto
Class IReferenceSystemProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IReferenceSystemProxy

All Implemented Interfaces:

IReferenceSystem, Externalizable, Serializable

public class IReferenceSystemProxy
extends com.esri.arcgis.interop.Dispatch
implements IReferenceSystem, Serializable

Provides access to basic properties and methods provided by every reference system (grids, graticules, etc).

Product Availability

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

See Also:

Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	boundsChanged() Called when the extent of the parent map frame changes.
void	draw(IDisplay display, IMapFrame pMapFrame) Draws the map grid for a map frame to the given display.
void	generateGraphics(IMapFrame pMapFrame, IGraphicsContainer graphicsContainer) Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.
IGridLabel	getLabelFormat() The format for reference labels.
String	getName() The name of the map grid.
boolean	isVisible() Indicates if the map grid is visible.
void	prepareForOutput(int hDC, int dpi, tagRECT pixelBounds, IMapFrame pMapFrame) Prepares the map grid for output to a device.
void	queryBounds(IDisplay pDisplay, IMapFrame pMapFrame, IEnvelope bounds) The extent of the reference system in page space.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	setDefaults(IMapFrame pMapFrame) Sets the properties of the map grid to default values.
void	setLabelFormat(IGridLabel format) The format for reference labels.
void	setName(String gridName) The name of the map grid.
void	setVisible(boolean visible) Indicates if the map grid is visible.
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

IReferenceSystemProxy

public IReferenceSystemProxy()

IReferenceSystemProxy

public IReferenceSystemProxy(Object obj)
                      throws IOException

Throws:

IOException

IReferenceSystemProxy

protected IReferenceSystemProxy(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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the map grid.

Product Availability

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

Specified by:

getName in interface IReferenceSystem

Returns:

The gridName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String gridName)
             throws IOException,
                    AutomationException

The name of the map grid.

Product Availability

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

Specified by:

setName in interface IReferenceSystem

Parameters:

gridName - The gridName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the map grid is visible.

Product Availability

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

Specified by:

isVisible in interface IReferenceSystem

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the map grid is visible.

Product Availability

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

Specified by:

setVisible in interface IReferenceSystem

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelFormat

public IGridLabel getLabelFormat()
                          throws IOException,
                                 AutomationException

The format for reference labels.

Product Availability

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

Specified by:

getLabelFormat in interface IReferenceSystem

Returns:

A reference to a com.esri.arcgis.carto.IGridLabel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelFormat

public void setLabelFormat(IGridLabel format)
                    throws IOException,
                           AutomationException

The format for reference labels.

Product Availability

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

Specified by:

setLabelFormat in interface IReferenceSystem

Parameters:

format - A reference to a com.esri.arcgis.carto.IGridLabel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaults

public void setDefaults(IMapFrame pMapFrame)
                 throws IOException,
                        AutomationException

Sets the properties of the map grid to default values.

Product Availability

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

Specified by:

setDefaults in interface IReferenceSystem

Parameters:

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateGraphics

public void generateGraphics(IMapFrame pMapFrame,
                             IGraphicsContainer graphicsContainer)
                      throws IOException,
                             AutomationException

Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.

Product Availability

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

Specified by:

generateGraphics in interface IReferenceSystem

Parameters:

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

graphicsContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareForOutput

public void prepareForOutput(int hDC,
                             int dpi,
                             tagRECT pixelBounds,
                             IMapFrame pMapFrame)
                      throws IOException,
                             AutomationException

Prepares the map grid for output to a device.

Product Availability

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

Specified by:

prepareForOutput in interface IReferenceSystem

Parameters:

hDC - The hDC (A COM typedef) (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.display.tagRECT (in)

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 IMapFrame pMapFrame)
          throws IOException,
                 AutomationException

Draws the map grid for a map frame to the given display.

Product Availability

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

Specified by:

draw in interface IReferenceSystem

Parameters:

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

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBounds

public void queryBounds(IDisplay pDisplay,
                        IMapFrame pMapFrame,
                        IEnvelope bounds)
                 throws IOException,
                        AutomationException

The extent of the reference system in page space.

Product Availability

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

Specified by:

queryBounds in interface IReferenceSystem

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

boundsChanged

public void boundsChanged()
                   throws IOException,
                          AutomationException

Called when the extent of the parent map frame changes.

Product Availability

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

Specified by:

boundsChanged in interface IReferenceSystem

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

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