com.esri.arcgis.carto
Interface IMapGrid

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ICustomOverlayGrid, IGraticule, IIndexGrid
All Known Implementing Classes:
CustomOverlayGrid, Graticule, ICustomOverlayGridProxy, IGraticuleProxy, IIndexGridProxy, IMapGridProxy, IndexGrid, MeasuredGrid, MgrsGrid

public interface IMapGrid
extends java.io.Serializable

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

Description: 'Provides access to members that control a map grid.' 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 IID03762c8b_f4d0_11d1_ade8_080009ec732a
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 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.
 IMapGridBorder getBorder()
          The map grid border.
 double getExteriorWidth(IDisplay pDisplay, IMapFrame pMapFrame)
          The width (in display units) of the portion of the grid that is outside of the frame.
 IGridLabel getLabelFormat()
          The label format for map grid labels.
 ILineSymbol getLineSymbol()
          The symbol used to draw grid lines - null will draw no lines.
 java.lang.String getName()
          The name of the map grid.
 short getSubTickCount()
          The number of subticks to draw between the major ticks.
 double getSubTickLength()
          The length of the subticks in points.
 ILineSymbol getSubTickLineSymbol()
          The symbol used to draw the subtick lines.
 double getTickLength()
          The length of the major ticks in points.
 ILineSymbol getTickLineSymbol()
          The line symbol used to draw the major ticks.
 IMarkerSymbol getTickMarkSymbol()
          The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.
 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 queryLabelVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis)
          Returns the visibility of the labels along all four sides of the map grid.
 void querySubTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis)
          Returns the visibility of the subticks along all four sides of the map grid.
 void queryTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis)
          Returns the visibility of the ticks along all four sides of the map grid.
 void setBorder(IMapGridBorder gridBorder)
          The map grid border.
 void setDefaults(IMapFrame pMapFrame)
          Sets the properties of the map grid to default values.
 void setLabelFormat(IGridLabel format)
          The label format for map grid labels.
 void setLabelVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis)
          Sets the visibility of the labels along all four sides of the map grid.
 void setLineSymbol(ILineSymbol symbol)
          The symbol used to draw grid lines - null will draw no lines.
 void setName(java.lang.String gridName)
          The name of the map grid.
 void setSubTickCount(short count)
          The number of subticks to draw between the major ticks.
 void setSubTickLength(double lengthPoints)
          The length of the subticks in points.
 void setSubTickLineSymbol(ILineSymbol symbol)
          The symbol used to draw the subtick lines.
 void setSubTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis)
          Sets the visibility of the subticks along all four sides of the map grid.
 void setTickLength(double lengthPoints)
          The length of the major ticks in points.
 void setTickLineSymbol(ILineSymbol symbol)
          The line symbol used to draw the major ticks.
 void setTickMarkSymbol(IMarkerSymbol symbol)
          The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.
 void setTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis)
          Sets the visibility of the ticks along all four sides of the map grid.
 void setVisible(boolean visible)
          Indicates if the map grid is visible.
 

Field Detail

IID03762c8b_f4d0_11d1_ade8_080009ec732a

static final int IID03762c8b_f4d0_11d1_ade8_080009ec732a
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.

getLineSymbol

ILineSymbol getLineSymbol()
                          throws java.io.IOException,
                                 AutomationException
The symbol used to draw grid lines - null will draw no lines.

Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLineSymbol

void setLineSymbol(ILineSymbol symbol)
                   throws java.io.IOException,
                          AutomationException
The symbol used to draw grid lines - null will draw no lines.

Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTickMarkSymbol

IMarkerSymbol getTickMarkSymbol()
                                throws java.io.IOException,
                                       AutomationException
The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.

Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTickMarkSymbol

void setTickMarkSymbol(IMarkerSymbol symbol)
                       throws java.io.IOException,
                              AutomationException
The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.

Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (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 label format for map grid 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 label format for map grid 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.

getTickLineSymbol

ILineSymbol getTickLineSymbol()
                              throws java.io.IOException,
                                     AutomationException
The line symbol used to draw the major ticks.

Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTickLineSymbol

void setTickLineSymbol(ILineSymbol symbol)
                       throws java.io.IOException,
                              AutomationException
The line symbol used to draw the major ticks.

Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTickLength

double getTickLength()
                     throws java.io.IOException,
                            AutomationException
The length of the major ticks in points.

Returns:
The lengthPoints
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTickLength

void setTickLength(double lengthPoints)
                   throws java.io.IOException,
                          AutomationException
The length of the major ticks in points.

Parameters:
lengthPoints - The lengthPoints (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubTickCount

short getSubTickCount()
                      throws java.io.IOException,
                             AutomationException
The number of subticks to draw between the major ticks.

Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickCount

void setSubTickCount(short count)
                     throws java.io.IOException,
                            AutomationException
The number of subticks to draw between the major ticks.

Parameters:
count - The count (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubTickLineSymbol

ILineSymbol getSubTickLineSymbol()
                                 throws java.io.IOException,
                                        AutomationException
The symbol used to draw the subtick lines.

Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickLineSymbol

void setSubTickLineSymbol(ILineSymbol symbol)
                          throws java.io.IOException,
                                 AutomationException
The symbol used to draw the subtick lines.

Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubTickLength

double getSubTickLength()
                        throws java.io.IOException,
                               AutomationException
The length of the subticks in points.

Returns:
The lengthPoints
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickLength

void setSubTickLength(double lengthPoints)
                      throws java.io.IOException,
                             AutomationException
The length of the subticks in points.

Parameters:
lengthPoints - The lengthPoints (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorder

IMapGridBorder getBorder()
                         throws java.io.IOException,
                                AutomationException
The map grid border.

Returns:
A reference to a com.esri.arcgis.carto.IMapGridBorder
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorder

void setBorder(IMapGridBorder gridBorder)
               throws java.io.IOException,
                      AutomationException
The map grid border.

Parameters:
gridBorder - A reference to a com.esri.arcgis.carto.IMapGridBorder (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.

queryLabelVisibility

void queryLabelVisibility(boolean[] leftVis,
                          boolean[] topVis,
                          boolean[] rightVis,
                          boolean[] bottomVis)
                          throws java.io.IOException,
                                 AutomationException
Returns the visibility of the labels along all four sides of the map grid.

Parameters:
leftVis - The leftVis (in/out: use single element array)
topVis - The topVis (in/out: use single element array)
rightVis - The rightVis (in/out: use single element array)
bottomVis - The bottomVis (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelVisibility

void setLabelVisibility(boolean leftVis,
                        boolean topVis,
                        boolean rightVis,
                        boolean bottomVis)
                        throws java.io.IOException,
                               AutomationException
Sets the visibility of the labels along all four sides of the map grid.

Parameters:
leftVis - The leftVis (in)
topVis - The topVis (in)
rightVis - The rightVis (in)
bottomVis - The bottomVis (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTickVisibility

void queryTickVisibility(boolean[] leftVis,
                         boolean[] topVis,
                         boolean[] rightVis,
                         boolean[] bottomVis)
                         throws java.io.IOException,
                                AutomationException
Returns the visibility of the ticks along all four sides of the map grid.

Parameters:
leftVis - The leftVis (in/out: use single element array)
topVis - The topVis (in/out: use single element array)
rightVis - The rightVis (in/out: use single element array)
bottomVis - The bottomVis (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTickVisibility

void setTickVisibility(boolean leftVis,
                       boolean topVis,
                       boolean rightVis,
                       boolean bottomVis)
                       throws java.io.IOException,
                              AutomationException
Sets the visibility of the ticks along all four sides of the map grid.

Parameters:
leftVis - The leftVis (in)
topVis - The topVis (in)
rightVis - The rightVis (in)
bottomVis - The bottomVis (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

querySubTickVisibility

void querySubTickVisibility(boolean[] leftVis,
                            boolean[] topVis,
                            boolean[] rightVis,
                            boolean[] bottomVis)
                            throws java.io.IOException,
                                   AutomationException
Returns the visibility of the subticks along all four sides of the map grid.

Parameters:
leftVis - The leftVis (in/out: use single element array)
topVis - The topVis (in/out: use single element array)
rightVis - The rightVis (in/out: use single element array)
bottomVis - The bottomVis (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickVisibility

void setSubTickVisibility(boolean leftVis,
                          boolean topVis,
                          boolean rightVis,
                          boolean bottomVis)
                          throws java.io.IOException,
                                 AutomationException
Sets the visibility of the subticks along all four sides of the map grid.

Parameters:
leftVis - The leftVis (in)
topVis - The topVis (in)
rightVis - The rightVis (in)
bottomVis - The bottomVis (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.

getExteriorWidth

double getExteriorWidth(IDisplay pDisplay,
                        IMapFrame pMapFrame)
                        throws java.io.IOException,
                               AutomationException
The width (in display units) of the portion of the grid that is outside of the frame.

Parameters:
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Returns:
The pWidth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.