|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.carto.Overview
public class Overview
A map surround for displaying an overview.
| Constructor Summary | |
|---|---|
Overview()
Constructs a Overview using ArcGIS Engine. |
|
Overview(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Overview theOverview = (Overview) obj; |
|
| Method Summary | |
|---|---|
void |
addIMapSurroundEventsListener(IMapSurroundEvents theListener)
addIMapSurroundEventsListener. |
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
void |
delayEvents(boolean delay)
Used to batch operations together to minimize notifications. |
void |
draw(IDisplay display,
ITrackCancel trackCancel,
IEnvelope bounds)
Draws the map surround into the specified display bounds. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
void |
fitToBounds(IDisplay display,
IEnvelope bounds,
boolean[] changed)
Adjusts the map surround to fit the bounds. |
IFillSymbol |
getAoiFillSymbol()
Fill symbol used to display the area of interest. |
IColor |
getBackgroundColor()
Background color of the overview. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
int |
getIcon()
Icon used to represent the map surround. |
IMap |
getMap()
The parent map. |
String |
getName()
Name of the map surround. |
ITextSymbol |
getOverlayGridLabelSymbol()
Text symbol used to label overlay grid cells with the layer's display field. |
ILayer |
getOverlayGridLayer()
Overlay grid layer for the overview. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
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 |
isFixedAspectRatio()
Indicates if the bounds has a fixed aspect ratio. |
boolean |
isFixedSize()
Indicates if size is determined by some other property like the symbol. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
void |
load(IStream pstm)
load |
void |
queryBounds(IDisplay display,
IEnvelope oldBounds,
IEnvelope newBounds)
Returns the bounds of the map surround. |
void |
querySize(double[] widthPoints,
double[] heightPoints)
Get the size in points. |
void |
readExternal(ObjectInput in)
|
void |
refresh()
Makes sure the latest updates are refected the next time the Map Surround is drawn. |
void |
removeIMapSurroundEventsListener(IMapSurroundEvents theListener)
removeIMapSurroundEventsListener. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setAoiFillSymbol(IFillSymbol symbol)
Fill symbol used to display the area of interest. |
void |
setBackgroundColor(IColor color)
Background color of the overview. |
void |
setFixedAspectRatio(boolean flag)
Indicates if the bounds has a fixed aspect ratio. |
void |
setMapByRef(IMap map)
The parent map. |
void |
setName(String name)
Name of the map surround. |
void |
setOverlayGridCell(int gridLayerFid)
Sets the extent of the associated map to the specified overlay grid cell. |
void |
setOverlayGridLabelSymbol(ITextSymbol symbol)
Text symbol used to label overlay grid cells with the layer's display field. |
void |
setOverlayGridLayer(ILayer layer)
Overlay grid layer for the overview. |
void |
updateDisplay(int windowWidth,
int windowHeight)
Updates the display of the overview based upon the associated map's current settings. |
void |
writeExternal(ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public Overview()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public Overview(Object obj)
throws IOException
Overview theOverview = (Overview) obj;
obj to Overview.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void addIMapSurroundEventsListener(IMapSurroundEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IMapSurroundEvents interface.
IOException - If there are communications problems.
public void removeIMapSurroundEventsListener(IMapSurroundEvents theListener)
throws IOException
theListener - An object that implements the com.esri.arcgis.carto.IMapSurroundEvents interface.
IOException - If there are communications problems.
public IFillSymbol getAoiFillSymbol()
throws IOException,
AutomationException
getAoiFillSymbol in interface IOverviewgetAoiFillSymbol in interface IOverview2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAoiFillSymbol(IFillSymbol symbol)
throws IOException,
AutomationException
setAoiFillSymbol in interface IOverviewsetAoiFillSymbol in interface IOverview2symbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILayer getOverlayGridLayer()
throws IOException,
AutomationException
getOverlayGridLayer in interface IOverviewgetOverlayGridLayer in interface IOverview2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOverlayGridLayer(ILayer layer)
throws IOException,
AutomationException
setOverlayGridLayer in interface IOverviewsetOverlayGridLayer in interface IOverview2layer - A reference to a com.esri.arcgis.carto.ILayer (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITextSymbol getOverlayGridLabelSymbol()
throws IOException,
AutomationException
getOverlayGridLabelSymbol in interface IOverviewgetOverlayGridLabelSymbol in interface IOverview2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOverlayGridLabelSymbol(ITextSymbol symbol)
throws IOException,
AutomationException
setOverlayGridLabelSymbol in interface IOverviewsetOverlayGridLabelSymbol in interface IOverview2symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOverlayGridCell(int gridLayerFid)
throws IOException,
AutomationException
setOverlayGridCell in interface IOverviewsetOverlayGridCell in interface IOverview2gridLayerFid - The gridLayerFid (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void updateDisplay(int windowWidth,
int windowHeight)
throws IOException,
AutomationException
updateDisplay in interface IOverviewupdateDisplay in interface IOverview2windowWidth - The windowWidth (in)windowHeight - The windowHeight (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IMap getMap()
throws IOException,
AutomationException
getMap in interface IMapSurroundIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMapByRef(IMap map)
throws IOException,
AutomationException
setMapByRef in interface IMapSurroundmap - A reference to a com.esri.arcgis.carto.IMap (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getName()
throws IOException,
AutomationException
getName in interface IMapSurroundIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(String name)
throws IOException,
AutomationException
setName in interface IMapSurroundname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getIcon()
throws IOException,
AutomationException
getIcon in interface IMapSurroundIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryBounds(IDisplay display,
IEnvelope oldBounds,
IEnvelope newBounds)
throws IOException,
AutomationException
queryBounds in interface IMapSurrounddisplay - A reference to a com.esri.arcgis.display.IDisplay (in)oldBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)newBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void fitToBounds(IDisplay display,
IEnvelope bounds,
boolean[] changed)
throws IOException,
AutomationException
fitToBounds in interface IMapSurrounddisplay - A reference to a com.esri.arcgis.display.IDisplay (in)bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)changed - The changed (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void delayEvents(boolean delay)
throws IOException,
AutomationException
delayEvents in interface IMapSurrounddelay - The delay (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void refresh()
throws IOException,
AutomationException
refresh in interface IMapSurroundIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void draw(IDisplay display,
ITrackCancel trackCancel,
IEnvelope bounds)
throws IOException,
AutomationException
draw in interface IMapSurrounddisplay - A reference to a com.esri.arcgis.display.IDisplay (in)trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IColor getBackgroundColor()
throws IOException,
AutomationException
getBackgroundColor in interface IOverview2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBackgroundColor(IColor color)
throws IOException,
AutomationException
setBackgroundColor in interface IOverview2color - A reference to a com.esri.arcgis.display.IColor (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void querySize(double[] widthPoints,
double[] heightPoints)
throws IOException,
AutomationException
querySize in interface IQuerySizewidthPoints - The widthPoints (in/out: use single element array)heightPoints - The heightPoints (in/out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isFixedAspectRatio()
throws IOException,
AutomationException
isFixedAspectRatio in interface IBoundsPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFixedAspectRatio(boolean flag)
throws IOException,
AutomationException
setFixedAspectRatio in interface IBoundsPropertiesflag - The flag (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isFixedSize()
throws IOException,
AutomationException
isFixedSize in interface IBoundsPropertiesIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints in interface IConnectionPointContainerppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint in interface IConnectionPointContainerriid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClone esri_clone()
throws IOException,
AutomationException
esri_clone in interface ICloneIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws IOException,
AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws IOException,
AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||