com.esri.arcgis.carto
Interface IReferenceSystem

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CustomOverlayGrid, Graticule, IndexGrid, IReferenceSystemProxy, MeasuredGrid, MgrsGrid

public interface IReferenceSystem
extends java.io.Serializable

COM Interface 'IReferenceSystem'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to basic properties and methods provided by every reference system (grids, graticules, etc).' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID53b979cb_9576_40dd_8b7b_f445e5b1bac9
static int	xxDummy Deprecated. Internal use only

Method Summary

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.
java.lang.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	setDefaults(IMapFrame pMapFrame) Sets the properties of the map grid to default values.
void	setLabelFormat(IGridLabel format) The format for reference labels.
void	setName(java.lang.String gridName) The name of the map grid.
void	setVisible(boolean visible) Indicates if the map grid is visible.

Field Detail

IID53b979cb_9576_40dd_8b7b_f445e5b1bac9

static final int IID53b979cb_9576_40dd_8b7b_f445e5b1bac9

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the map grid.

Returns:

The gridName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String gridName)
             throws java.io.IOException,
                    AutomationException

The name of the map grid.

Parameters:

gridName - The gridName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the map grid is visible.

Returns:

The visible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the map grid is visible.

Parameters:

visible - The visible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelFormat

IGridLabel getLabelFormat()
                          throws java.io.IOException,
                                 AutomationException

The format for reference labels.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelFormat

void setLabelFormat(IGridLabel format)
                    throws java.io.IOException,
                           AutomationException

The format for reference labels.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaults

void setDefaults(IMapFrame pMapFrame)
                 throws java.io.IOException,
                        AutomationException

Sets the properties of the map grid to default values.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateGraphics

void generateGraphics(IMapFrame pMapFrame,
                      IGraphicsContainer graphicsContainer)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareForOutput

void prepareForOutput(int hDC,
                      int dpi,
                      tagRECT pixelBounds,
                      IMapFrame pMapFrame)
                      throws java.io.IOException,
                             AutomationException

Prepares the map grid for output to a device.

Parameters:

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

dpi - The dpi (in)

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IMapFrame pMapFrame)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBounds

void queryBounds(IDisplay pDisplay,
                 IMapFrame pMapFrame,
                 IEnvelope bounds)
                 throws java.io.IOException,
                        AutomationException

The extent of the reference system in page space.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

boundsChanged

void boundsChanged()
                   throws java.io.IOException,
                          AutomationException

Called when the extent of the parent map frame changes.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.