|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.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 problemspublic 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 problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public 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 IOverview
getAoiFillSymbol
in interface IOverview2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAoiFillSymbol(IFillSymbol symbol) throws IOException, AutomationException
setAoiFillSymbol
in interface IOverview
setAoiFillSymbol
in interface IOverview2
symbol
- 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 IOverview
getOverlayGridLayer
in interface IOverview2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOverlayGridLayer(ILayer layer) throws IOException, AutomationException
setOverlayGridLayer
in interface IOverview
setOverlayGridLayer
in interface IOverview2
layer
- 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 IOverview
getOverlayGridLabelSymbol
in interface IOverview2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOverlayGridLabelSymbol(ITextSymbol symbol) throws IOException, AutomationException
setOverlayGridLabelSymbol
in interface IOverview
setOverlayGridLabelSymbol
in interface IOverview2
symbol
- 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 IOverview
setOverlayGridCell
in interface IOverview2
gridLayerFid
- 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 IOverview
updateDisplay
in interface IOverview2
windowWidth
- 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 IMapSurround
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapByRef(IMap map) throws IOException, AutomationException
setMapByRef
in interface IMapSurround
map
- 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 IMapSurround
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface IMapSurround
name
- 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 IMapSurround
IOException
- 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 IMapSurround
display
- 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 IMapSurround
display
- 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 IMapSurround
delay
- 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 IMapSurround
IOException
- 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 IMapSurround
display
- 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 IOverview2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBackgroundColor(IColor color) throws IOException, AutomationException
setBackgroundColor
in interface IOverview2
color
- 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 IQuerySize
widthPoints
- 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 IBoundsProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFixedAspectRatio(boolean flag) throws IOException, AutomationException
setFixedAspectRatio
in interface IBoundsProperties
flag
- 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 IBoundsProperties
IOException
- 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 IConnectionPointContainer
ppEnum
- 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 IConnectionPointContainer
riid
- 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 IPersistStream
IOException
- 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 IPersistStream
pstm
- 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 IPersistStream
pstm
- 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 IPersistStream
pcbSize
- 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 IPersist
pClassID
- 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 IClone
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws IOException, AutomationException
assign
in interface IClone
src
- 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 IClone
other
- 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 IClone
other
- 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 Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |