com.esri.arcgis.carto
Class IMapGridProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IMapGridProxy
All Implemented Interfaces:
IMapGrid, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
ICustomOverlayGridProxy, IGraticuleProxy, IIndexGridProxy

Deprecated. Internal use only. Proxy for 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 =

public class IMapGridProxy
extends com.esri.arcgis.interop.Dispatch
implements IMapGrid, java.io.Serializable

Internal use class

See Also:
Serialized Form

Field Summary
 boolean noncastable
          Deprecated.  
static java.lang.Class targetClass
          Deprecated.  
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.carto.IMapGrid
IID, IID03762c8b_f4d0_11d1_ade8_080009ec732a
 
Constructor Summary
  IMapGridProxy()
          Deprecated. For internal use only
  IMapGridProxy(java.lang.Object obj)
          Deprecated.  
protected IMapGridProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  IMapGridProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected IMapGridProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Deprecated.  
 void draw(IDisplay display, IMapFrame pMapFrame)
          Deprecated. Draws the map grid for a map frame to the given display.
 void generateGraphics(IMapFrame pMapFrame, IGraphicsContainer graphicsContainer)
          Deprecated. Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.
 IMapGridBorder getBorder()
          Deprecated. The map grid border.
 double getExteriorWidth(IDisplay pDisplay, IMapFrame pMapFrame)
          Deprecated. The width (in display units) of the portion of the grid that is outside of the frame.
 IGridLabel getLabelFormat()
          Deprecated. The label format for map grid labels.
 ILineSymbol getLineSymbol()
          Deprecated. The symbol used to draw grid lines - null will draw no lines.
 java.lang.String getName()
          Deprecated. The name of the map grid.
 short getSubTickCount()
          Deprecated. The number of subticks to draw between the major ticks.
 double getSubTickLength()
          Deprecated. The length of the subticks in points.
 ILineSymbol getSubTickLineSymbol()
          Deprecated. The symbol used to draw the subtick lines.
 double getTickLength()
          Deprecated. The length of the major ticks in points.
 ILineSymbol getTickLineSymbol()
          Deprecated. The line symbol used to draw the major ticks.
 IMarkerSymbol getTickMarkSymbol()
          Deprecated. The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.
 boolean isVisible()
          Deprecated. Indicates if the map grid is visible.
 void prepareForOutput(int hDC, int dpi, tagRECT pixelBounds, IMapFrame pMapFrame)
          Deprecated. Prepares the map grid for output to a device.
 void queryLabelVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis)
          Deprecated. Returns the visibility of the labels along all four sides of the map grid.
 void querySubTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis)
          Deprecated. Returns the visibility of the subticks along all four sides of the map grid.
 void queryTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis)
          Deprecated. Returns the visibility of the ticks along all four sides of the map grid.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void setBorder(IMapGridBorder gridBorder)
          Deprecated. The map grid border.
 void setDefaults(IMapFrame pMapFrame)
          Deprecated. Sets the properties of the map grid to default values.
 void setLabelFormat(IGridLabel format)
          Deprecated. The label format for map grid labels.
 void setLabelVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis)
          Deprecated. Sets the visibility of the labels along all four sides of the map grid.
 void setLineSymbol(ILineSymbol symbol)
          Deprecated. The symbol used to draw grid lines - null will draw no lines.
 void setName(java.lang.String gridName)
          Deprecated. The name of the map grid.
 void setSubTickCount(short count)
          Deprecated. The number of subticks to draw between the major ticks.
 void setSubTickLength(double lengthPoints)
          Deprecated. The length of the subticks in points.
 void setSubTickLineSymbol(ILineSymbol symbol)
          Deprecated. The symbol used to draw the subtick lines.
 void setSubTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis)
          Deprecated. Sets the visibility of the subticks along all four sides of the map grid.
 void setTickLength(double lengthPoints)
          Deprecated. The length of the major ticks in points.
 void setTickLineSymbol(ILineSymbol symbol)
          Deprecated. The line symbol used to draw the major ticks.
 void setTickMarkSymbol(IMarkerSymbol symbol)
          Deprecated. 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)
          Deprecated. Sets the visibility of the ticks along all four sides of the map grid.
 void setVisible(boolean visible)
          Deprecated. Indicates if the map grid is visible.
 
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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Deprecated. 

noncastable

public boolean noncastable
Deprecated. 
Constructor Detail

IMapGridProxy

public IMapGridProxy(java.lang.String CLSID,
                     java.lang.String host,
                     com.esri.arcgis.interop.AuthInfo authInfo)
              throws java.net.UnknownHostException,
                     java.io.IOException
Deprecated. 
Throws:
java.net.UnknownHostException
java.io.IOException

IMapGridProxy

public IMapGridProxy()
Deprecated. 
For internal use only


IMapGridProxy

public IMapGridProxy(java.lang.Object obj)
              throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IMapGridProxy

protected IMapGridProxy(java.lang.Object obj,
                        java.lang.String iid)
                 throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IMapGridProxy

protected IMapGridProxy(java.lang.String CLSID,
                        java.lang.String iid,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Deprecated. 
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Deprecated. 
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Deprecated. 
The name of the map grid.

Specified by:
getName in interface IMapGrid
Returns:
The gridName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String gridName)
             throws java.io.IOException,
                    AutomationException
Deprecated. 
The name of the map grid.

Specified by:
setName in interface IMapGrid
Parameters:
gridName - The gridName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLineSymbol

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

Specified by:
getLineSymbol in interface IMapGrid
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

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

Specified by:
setLineSymbol in interface IMapGrid
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

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

Specified by:
getTickMarkSymbol in interface IMapGrid
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

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

Specified by:
setTickMarkSymbol in interface IMapGrid
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

public IGridLabel getLabelFormat()
                          throws java.io.IOException,
                                 AutomationException
Deprecated. 
The label format for map grid labels.

Specified by:
getLabelFormat in interface IMapGrid
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

public void setLabelFormat(IGridLabel format)
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
The label format for map grid labels.

Specified by:
setLabelFormat in interface IMapGrid
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

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

Specified by:
getTickLineSymbol in interface IMapGrid
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

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

Specified by:
setTickLineSymbol in interface IMapGrid
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

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

Specified by:
getTickLength in interface IMapGrid
Returns:
The lengthPoints
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTickLength

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

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

getSubTickCount

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

Specified by:
getSubTickCount in interface IMapGrid
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickCount

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

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

getSubTickLineSymbol

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

Specified by:
getSubTickLineSymbol in interface IMapGrid
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

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

Specified by:
setSubTickLineSymbol in interface IMapGrid
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

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

Specified by:
getSubTickLength in interface IMapGrid
Returns:
The lengthPoints
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubTickLength

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

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

getBorder

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

Specified by:
getBorder in interface IMapGrid
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

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

Specified by:
setBorder in interface IMapGrid
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

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
Indicates if the map grid is visible.

Specified by:
isVisible in interface IMapGrid
Returns:
The visible
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException
Deprecated. 
Indicates if the map grid is visible.

Specified by:
setVisible in interface IMapGrid
Parameters:
visible - The visible (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLabelVisibility

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

Specified by:
queryLabelVisibility in interface IMapGrid
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

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

Specified by:
setLabelVisibility in interface IMapGrid
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

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

Specified by:
queryTickVisibility in interface IMapGrid
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

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

Specified by:
setTickVisibility in interface IMapGrid
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

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

Specified by:
querySubTickVisibility in interface IMapGrid
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

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

Specified by:
setSubTickVisibility in interface IMapGrid
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

public void setDefaults(IMapFrame pMapFrame)
                 throws java.io.IOException,
                        AutomationException
Deprecated. 
Sets the properties of the map grid to default values.

Specified by:
setDefaults in interface IMapGrid
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

public void generateGraphics(IMapFrame pMapFrame,
                             IGraphicsContainer graphicsContainer)
                      throws java.io.IOException,
                             AutomationException
Deprecated. 
Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.

Specified by:
generateGraphics in interface IMapGrid
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

public void prepareForOutput(int hDC,
                             int dpi,
                             tagRECT pixelBounds,
                             IMapFrame pMapFrame)
                      throws java.io.IOException,
                             AutomationException
Deprecated. 
Prepares the map grid for output to a device.

Specified by:
prepareForOutput in interface IMapGrid
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

public void draw(IDisplay display,
                 IMapFrame pMapFrame)
          throws java.io.IOException,
                 AutomationException
Deprecated. 
Draws the map grid for a map frame to the given display.

Specified by:
draw in interface IMapGrid
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

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

Specified by:
getExteriorWidth in interface IMapGrid
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.