|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.arcmapui.ImageInsetWindow
public class ImageInsetWindow
Window to display ImageInsets.
Constructor Summary | |
---|---|
ImageInsetWindow(Object obj)
Construct a ImageInsetWindow using a reference to such an object returned from ArcGIS Engine or Server. |
Method Summary | |
---|---|
void |
activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent)
Fired when the active view changes. |
void |
addIDataWindowEventsListener(IDataWindowEvents theListener)
addIDataWindowEventsListener. |
void |
afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
Fired after the specified phase is drawn. |
void |
afterDraw(IMapSurroundEventsAfterDrawEvent theEvent)
Fired after drawing completes. |
void |
afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
Fired after an individual view item is drawn. |
boolean |
beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent)
Fired before a document is closed. |
void |
beforeDraw(IMapSurroundEventsBeforeDrawEvent theEvent)
Fired before drawing starts. |
void |
closeDocument(IDocumentEventsCloseDocumentEvent theEvent)
Fired when a document is closed. |
void |
contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
Fired when the contents of the view changes. |
void |
contentsChanged(IMapSurroundEventsContentsChangedEvent theEvent)
Fired when the contents of the map surround changes. |
void |
contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
Fired when the contents of the view is cleared. |
void |
destroy()
Close and destroy the window. |
boolean |
equals(Object o)
Compare this object with another |
void |
flashLocation()
Draw leader lines from the inset to the location on the map shown by the inset. |
void |
focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
Fired when a new map is made active. |
void |
getClassID(GUID[] pClassID)
getClassID |
int |
getHWnd()
The window's handle. |
IMapInset |
getMapInset()
The MapInset used by this window. |
IScreenDisplay |
getScreenDisplay()
The screen display used by this window. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
String |
getTag()
For developer use. |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
boolean |
isDockable()
Indicates if the window is dockable. |
boolean |
isEnableContextMenu()
Indicates if the context menu should be enabled. |
boolean |
isLive()
Indicates if the window shows a live view of what's under it or a snapshot. |
boolean |
isUpdateWhileDragging()
Indicates if the window is redrawn as it's moved or not. |
boolean |
isVisible()
Indicates if the window is visible. |
void |
itemAdded(IActiveViewEventsItemAddedEvent theEvent)
Fired when an item is added to the view. |
void |
itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
Fired when an item is deleted from the view. |
void |
itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
Fired when a view item is reordered. |
void |
load(IStream pstm)
load |
void |
mapsChanged(IDocumentEventsMapsChangedEvent theEvent)
Fired when a change is made to the map collection. |
void |
newDocument(IDocumentEventsNewDocumentEvent theEvent)
Fired when a new document is created. |
void |
onContextMenu(IDocumentEventsOnContextMenuEvent theEvent)
Indicates if a context menu should be displayed at the given xy location. |
void |
openDocument(IDocumentEventsOpenDocumentEvent theEvent)
Fired when a document is opened. |
void |
putPosition(int left,
int top,
int right,
int bottom)
The window's position in screen pixels. |
void |
queryPosition(int[] left,
int[] top,
int[] right,
int[] bottom)
The window's position in screen pixels. |
void |
readExternal(ObjectInput in)
|
void |
refresh()
Cause the window to redraw. |
void |
removeIDataWindowEventsListener(IDataWindowEvents theListener)
removeIDataWindowEventsListener. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
Call this function to fire the selection changed event. |
void |
setApplicationByRef(Object rhs1)
Provides the window with a reference to the application. |
void |
setEnableContextMenu(boolean enable)
Indicates if the context menu should be enabled. |
void |
setIsLive(boolean isLive)
Indicates if the window shows a live view of what's under it or a snapshot. |
void |
setMapInsetByRef(IMapInset mapInset)
The MapInset used by this window. |
void |
setTag(String tag)
For developer use. |
void |
setUpdateWhileDragging(boolean updateWhileDragging)
Indicates if the window is redrawn as it's moved or not. |
void |
show(boolean show)
Indicates if the window is shown. |
void |
spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
Fired when the spatial reference is changed. |
void |
viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
Fired when view is refreshed before draw happens. |
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 ImageInsetWindow(Object obj) throws IOException
obj
to ImageInsetWindow
. *
ImageInsetWindow o = (ImageInsetWindow)obj; // will not work
ImageInsetWindow o = new ImageInsetWindow(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
IOException
- if there are interop problems
ImageInsetWindow theImageInsetWindow = (ImageInsetWindow) obj;
Method Detail |
---|
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void addIDataWindowEventsListener(IDataWindowEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.arcmapui.IDataWindowEvents interface.
IOException
- If there are communications problems.public void removeIDataWindowEventsListener(IDataWindowEvents theListener) throws IOException
theListener
- An object that implements the com.esri.arcgis.arcmapui.IDataWindowEvents interface.
IOException
- If there are communications problems.public IMapInset getMapInset() throws IOException, AutomationException
getMapInset
in interface IMapInsetWindow
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapInsetByRef(IMapInset mapInset) throws IOException, AutomationException
setMapInsetByRef
in interface IMapInsetWindow
mapInset
- A reference to a com.esri.arcgis.carto.IMapInset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void flashLocation() throws IOException, AutomationException
flashLocation
in interface IMapInsetWindow
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IScreenDisplay getScreenDisplay() throws IOException, AutomationException
getScreenDisplay
in interface ILensWindow
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUpdateWhileDragging() throws IOException, AutomationException
isUpdateWhileDragging
in interface ILensWindow
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUpdateWhileDragging(boolean updateWhileDragging) throws IOException, AutomationException
setUpdateWhileDragging
in interface ILensWindow
updateWhileDragging
- The updateWhileDragging (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isLive() throws IOException, AutomationException
isLive
in interface ILensWindow
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setIsLive(boolean isLive) throws IOException, AutomationException
setIsLive
in interface ILensWindow
isLive
- The isLive (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setApplicationByRef(Object rhs1) throws IOException, AutomationException
setApplicationByRef
in interface IDataWindow
setApplicationByRef
in interface IDataWindow2
rhs1
- A reference to another Automation Object (IDispatch) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getHWnd() throws IOException, AutomationException
getHWnd
in interface IDataWindow
getHWnd
in interface IDataWindow2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void queryPosition(int[] left, int[] top, int[] right, int[] bottom) throws IOException, AutomationException
queryPosition
in interface IDataWindow
queryPosition
in interface IDataWindow2
left
- The left (out: use single element array)top
- The top (out: use single element array)right
- The right (out: use single element array)bottom
- The bottom (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void putPosition(int left, int top, int right, int bottom) throws IOException, AutomationException
putPosition
in interface IDataWindow
putPosition
in interface IDataWindow2
left
- The left (in)top
- The top (in)right
- The right (in)bottom
- The bottom (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVisible() throws IOException, AutomationException
isVisible
in interface IDataWindow
isVisible
in interface IDataWindow2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDockable() throws IOException, AutomationException
isDockable
in interface IDataWindow
isDockable
in interface IDataWindow2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void show(boolean show) throws IOException, AutomationException
Show specifies whether the data window should be shown or hidden. Use True to show the window and False to hide the window.
show
in interface IDataWindow
show
in interface IDataWindow2
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void refresh() throws IOException, AutomationException
refresh
in interface IDataWindow
refresh
in interface IDataWindow2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTag() throws IOException, AutomationException
getTag
in interface IDataWindow2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTag(String tag) throws IOException, AutomationException
setTag
in interface IDataWindow2
tag
- The tag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEnableContextMenu() throws IOException, AutomationException
isEnableContextMenu
in interface IDataWindow2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setEnableContextMenu(boolean enable) throws IOException, AutomationException
setEnableContextMenu
in interface IDataWindow2
enable
- The enable (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void destroy() throws IOException, AutomationException
destroy
in interface IDataWindow2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent) throws IOException, AutomationException
activeViewChanged
in interface IDocumentEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void mapsChanged(IDocumentEventsMapsChangedEvent theEvent) throws IOException, AutomationException
mapsChanged
in interface IDocumentEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onContextMenu(IDocumentEventsOnContextMenuEvent theEvent) throws IOException, AutomationException
onContextMenu
in interface IDocumentEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void newDocument(IDocumentEventsNewDocumentEvent theEvent) throws IOException, AutomationException
newDocument
in interface IDocumentEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void openDocument(IDocumentEventsOpenDocumentEvent theEvent) throws IOException, AutomationException
openDocument
in interface IDocumentEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent) throws IOException, AutomationException
beforeCloseDocument
in interface IDocumentEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void closeDocument(IDocumentEventsCloseDocumentEvent theEvent) throws IOException, AutomationException
closeDocument
in interface IDocumentEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent) throws IOException, AutomationException
The Map object fires this event when a new document is loaded. Adding a new layer to a Map does not trigger this event.
The PageLayout object fires the event when IGraphicsContainer::DeleteAllElements in called and when a new document is loaded.
contentsChanged
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IActiveView.contentsChanged()
public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent) throws IOException, AutomationException
contentsCleared
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void itemAdded(IActiveViewEventsItemAddedEvent theEvent) throws IOException, AutomationException
The Map fires the event every time a new layer is added.
The PageLayout fires this event whenever a new element is added to the layout. Elements include not only graphics but data frames as well.
itemAdded
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent) throws IOException, AutomationException
The PageLayout object fires this event whenever elements are deleted from the layout.
The Map object fires this event when a layer is removed.
itemDeleted
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent) throws IOException, AutomationException
The Map objects only fire this event whenever IMap::MoveLayer is called. In the ArcMap application, this occurs when you reorder layers in the table of contents. The Map will also fire this event when new layers are added.
The PageLayout object fires this event when changing the order of graphics. For example, IGraphicsContainer::BringToFront, PutElementOrder, SendToBack, SendBackward, and BringForward all fire this event. These functions are on ArcMap's Drawing menu under the Order pull right menu. Although the Map object is also a graphics container, it does not fire this event when its graphics are reordered.
itemReordered
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent) throws IOException, AutomationException
selectionChanged
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent) throws IOException, AutomationException
Method that gets fired in response to IActiveView::Refresh and IActiveView::PartialRefresh.
This event is useful in the case where you're watching for something to change in the view and there aren't any specific events for that change (e.g. ContentsChanged, ItemAdded). You can always listen for this method as a last resort. Care must be taken however to be very efficient in your implementation of this event because it will be called quite often.
The event parameters directly coincide with the arguments to IActiveView::PartialRefresh. For additional information about the arguments, see the help for that method.
If the event object connects to both the layout and a map, then the view parameter tells you which object initiated the event.
In an implementation of this method you typically want to check the phase and respond to only one. Otherwise, your code will execute multiple times per drawing sequence.
viewRefreshed
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent) throws IOException, AutomationException
afterDraw
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent) throws IOException, AutomationException
AfterItemDraw can be used to execute after each individual item has drawn. Event firing can be an expensive operation (time consuming) when there are many layers in a map, however. As a result, the AfterItemDraw event is only fired when the IViewManger::VerboseEvents property is set to True. By default this property is False.
afterItemDraw
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent) throws IOException, AutomationException
focusMapChanged
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent) throws IOException, AutomationException
spatialReferenceChanged
in interface IActiveViewEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void contentsChanged(IMapSurroundEventsContentsChangedEvent theEvent) throws IOException, AutomationException
contentsChanged
in interface IMapSurroundEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void beforeDraw(IMapSurroundEventsBeforeDrawEvent theEvent) throws IOException, AutomationException
beforeDraw
in interface IMapSurroundEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void afterDraw(IMapSurroundEventsAfterDrawEvent theEvent) throws IOException, AutomationException
afterDraw
in interface IMapSurroundEvents
theEvent
- The event
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 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 |