|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.CustomOverlayGrid
public class CustomOverlayGrid
COM Class 'CustomOverlayGrid'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'
Description 'A custom 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 long |
serialVersionUID
|
Fields inherited from interface com.esri.arcgis.carto.ICustomOverlayGrid |
---|
IID, IIDff501c89_d74b_11d2_9f43_00c04f6bc78e, xxDummy |
Fields inherited from interface com.esri.arcgis.carto.IMapGrid |
---|
IID03762c8b_f4d0_11d1_ade8_080009ec732a |
Fields inherited from interface com.esri.arcgis.system.IPersistStream |
---|
IID, IID00000109_0000_0000_c000_000000000046, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersist |
---|
IID0000010c_0000_0000_c000_000000000046 |
Fields inherited from interface com.esri.arcgis.system.IClone |
---|
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy |
Fields inherited from interface com.esri.arcgis.carto.IGraphicsComposite |
---|
IID, IID969cde4a_82d4_11d2_87dd_0000f8751720, xxDummy |
Fields inherited from interface com.esri.arcgis.carto.IReferenceSystem |
---|
IID, IID53b979cb_9576_40dd_8b7b_f445e5b1bac9, xxDummy |
Constructor Summary | |
---|---|
CustomOverlayGrid()
Constructs a CustomOverlayGrid using ArcGIS Engine. |
|
CustomOverlayGrid(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. CustomOverlayGrid theCustomOverlayGrid = (CustomOverlayGrid) obj; |
Method Summary | |
---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
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. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
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. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
IFeatureClass |
getDataSource()
The data source containing the grid cells. |
double |
getExteriorWidth(IDisplay pDisplay,
IMapFrame pMapFrame)
The width (in display units) of the portion of the grid that is outside of the frame. |
IEnumElement |
getGraphics(IDisplay display,
java.lang.Object data)
Graphic elements that are used to render this object. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
java.lang.String |
getLabelField()
The name of the field used to label the grid. |
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. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
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. |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isVisible()
Indicates if the map grid is visible. |
void |
load(IStream pstm)
load |
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 |
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 |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a CustomOverlayGrid. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setBorder(IMapGridBorder gridBorder)
The map grid border. |
void |
setDataSource(IFeatureClass featureClass)
The data source containing the grid cells. |
void |
setDefaults(IMapFrame pMapFrame)
Sets the properties of the map grid to default values. |
void |
setLabelField(java.lang.String fieldName)
The name of the field used to label the grid. |
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. |
void |
writeExternal(java.io.ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long serialVersionUID
Constructor Detail |
---|
public CustomOverlayGrid() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic CustomOverlayGrid(java.lang.Object obj) throws java.io.IOException
CustomOverlayGrid theCustomOverlayGrid = (CustomOverlayGrid) obj;
obj
to CustomOverlayGrid
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public IFeatureClass getDataSource() throws java.io.IOException, AutomationException
getDataSource
in interface ICustomOverlayGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDataSource(IFeatureClass featureClass) throws java.io.IOException, AutomationException
setDataSource
in interface ICustomOverlayGrid
featureClass
- A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getLabelField() throws java.io.IOException, AutomationException
getLabelField
in interface ICustomOverlayGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLabelField(java.lang.String fieldName) throws java.io.IOException, AutomationException
setLabelField
in interface ICustomOverlayGrid
fieldName
- The fieldName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getName() throws java.io.IOException, AutomationException
getName
in interface IMapGrid
getName
in interface IReferenceSystem
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(java.lang.String gridName) throws java.io.IOException, AutomationException
setName
in interface IMapGrid
setName
in interface IReferenceSystem
gridName
- The gridName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILineSymbol getLineSymbol() throws java.io.IOException, AutomationException
getLineSymbol
in interface IMapGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLineSymbol(ILineSymbol symbol) throws java.io.IOException, AutomationException
setLineSymbol
in interface IMapGrid
symbol
- A reference to a com.esri.arcgis.display.ILineSymbol (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMarkerSymbol getTickMarkSymbol() throws java.io.IOException, AutomationException
getTickMarkSymbol
in interface IMapGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTickMarkSymbol(IMarkerSymbol symbol) throws java.io.IOException, AutomationException
setTickMarkSymbol
in interface IMapGrid
symbol
- A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGridLabel getLabelFormat() throws java.io.IOException, AutomationException
getLabelFormat
in interface IMapGrid
getLabelFormat
in interface IReferenceSystem
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLabelFormat(IGridLabel format) throws java.io.IOException, AutomationException
setLabelFormat
in interface IMapGrid
setLabelFormat
in interface IReferenceSystem
format
- A reference to a com.esri.arcgis.carto.IGridLabel (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILineSymbol getTickLineSymbol() throws java.io.IOException, AutomationException
getTickLineSymbol
in interface IMapGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTickLineSymbol(ILineSymbol symbol) throws java.io.IOException, AutomationException
setTickLineSymbol
in interface IMapGrid
symbol
- A reference to a com.esri.arcgis.display.ILineSymbol (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getTickLength() throws java.io.IOException, AutomationException
getTickLength
in interface IMapGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTickLength(double lengthPoints) throws java.io.IOException, AutomationException
setTickLength
in interface IMapGrid
lengthPoints
- The lengthPoints (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getSubTickCount() throws java.io.IOException, AutomationException
getSubTickCount
in interface IMapGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSubTickCount(short count) throws java.io.IOException, AutomationException
setSubTickCount
in interface IMapGrid
count
- The count (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILineSymbol getSubTickLineSymbol() throws java.io.IOException, AutomationException
getSubTickLineSymbol
in interface IMapGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSubTickLineSymbol(ILineSymbol symbol) throws java.io.IOException, AutomationException
setSubTickLineSymbol
in interface IMapGrid
symbol
- A reference to a com.esri.arcgis.display.ILineSymbol (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getSubTickLength() throws java.io.IOException, AutomationException
getSubTickLength
in interface IMapGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSubTickLength(double lengthPoints) throws java.io.IOException, AutomationException
setSubTickLength
in interface IMapGrid
lengthPoints
- The lengthPoints (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMapGridBorder getBorder() throws java.io.IOException, AutomationException
getBorder
in interface IMapGrid
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBorder(IMapGridBorder gridBorder) throws java.io.IOException, AutomationException
setBorder
in interface IMapGrid
gridBorder
- A reference to a com.esri.arcgis.carto.IMapGridBorder (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVisible() throws java.io.IOException, AutomationException
isVisible
in interface IMapGrid
isVisible
in interface IReferenceSystem
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVisible(boolean visible) throws java.io.IOException, AutomationException
setVisible
in interface IMapGrid
setVisible
in interface IReferenceSystem
visible
- The visible (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryLabelVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) throws java.io.IOException, AutomationException
queryLabelVisibility
in interface IMapGrid
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLabelVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) throws java.io.IOException, AutomationException
setLabelVisibility
in interface IMapGrid
leftVis
- The leftVis (in)topVis
- The topVis (in)rightVis
- The rightVis (in)bottomVis
- The bottomVis (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) throws java.io.IOException, AutomationException
queryTickVisibility
in interface IMapGrid
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) throws java.io.IOException, AutomationException
setTickVisibility
in interface IMapGrid
leftVis
- The leftVis (in)topVis
- The topVis (in)rightVis
- The rightVis (in)bottomVis
- The bottomVis (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void querySubTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) throws java.io.IOException, AutomationException
querySubTickVisibility
in interface IMapGrid
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSubTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) throws java.io.IOException, AutomationException
setSubTickVisibility
in interface IMapGrid
leftVis
- The leftVis (in)topVis
- The topVis (in)rightVis
- The rightVis (in)bottomVis
- The bottomVis (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDefaults(IMapFrame pMapFrame) throws java.io.IOException, AutomationException
setDefaults
in interface IMapGrid
setDefaults
in interface IReferenceSystem
pMapFrame
- A reference to a com.esri.arcgis.carto.IMapFrame (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void generateGraphics(IMapFrame pMapFrame, IGraphicsContainer graphicsContainer) throws java.io.IOException, AutomationException
generateGraphics
in interface IMapGrid
generateGraphics
in interface IReferenceSystem
pMapFrame
- A reference to a com.esri.arcgis.carto.IMapFrame (in)graphicsContainer
- A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void prepareForOutput(int hDC, int dpi, tagRECT pixelBounds, IMapFrame pMapFrame) throws java.io.IOException, AutomationException
prepareForOutput
in interface IMapGrid
prepareForOutput
in interface IReferenceSystem
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(IDisplay display, IMapFrame pMapFrame) throws java.io.IOException, AutomationException
draw
in interface IMapGrid
draw
in interface IReferenceSystem
display
- A reference to a com.esri.arcgis.display.IDisplay (in)pMapFrame
- A reference to a com.esri.arcgis.carto.IMapFrame (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getExteriorWidth(IDisplay pDisplay, IMapFrame pMapFrame) throws java.io.IOException, AutomationException
getExteriorWidth
in interface IMapGrid
pDisplay
- A reference to a com.esri.arcgis.display.IDisplay (in)pMapFrame
- A reference to a com.esri.arcgis.carto.IMapFrame (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws java.io.IOException, AutomationException
isDirty
in interface IPersistStream
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws java.io.IOException, AutomationException
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws java.io.IOException, AutomationException
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws java.io.IOException, AutomationException
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws java.io.IOException, AutomationException
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws java.io.IOException, AutomationException
esri_clone
in interface IClone
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws java.io.IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws java.io.IOException, AutomationException
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws java.io.IOException, AutomationException
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumElement getGraphics(IDisplay display, java.lang.Object data) throws java.io.IOException, AutomationException
getGraphics
in interface IGraphicsComposite
display
- A reference to a com.esri.arcgis.display.IDisplay (in)data
- A reference to another Object (IUnknown) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryBounds(IDisplay pDisplay, IMapFrame pMapFrame, IEnvelope bounds) throws java.io.IOException, AutomationException
queryBounds
in interface IReferenceSystem
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void boundsChanged() throws java.io.IOException, AutomationException
boundsChanged
in interface IReferenceSystem
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |