com.esri.arcgis.display
Interface IDisplayEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

IDisplayEventsAdapter, IDisplayEventsProxy, Map, MapFrame, TADynamicDisplayRefreshController

public interface IDisplayEvents
extends EventListener, Serializable

Provides access to members that control Display Events.

When To Use

Use this interface to trap for specific events occurring inside a display. For example, you may wish to know whenever a particular display is scrolled. This is the case for the Map object which needs to perform some redrawing operations whenever its screen display is scrolled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	displayFinished(IDisplayEventsDisplayFinishedEvent theEvent) Notifies clients when drawing completes.
void	displayInvalidated(IDisplayEventsDisplayInvalidatedEvent theEvent) Notifies clients when display is invalidated.
void	displayScrolled(IDisplayEventsDisplayScrolledEvent theEvent) Notifies clients when display is scrolled.
void	displayStarted(IDisplayEventsDisplayStartedEvent theEvent) Notifies clients when drawing starts.

Method Detail

displayStarted

void displayStarted(IDisplayEventsDisplayStartedEvent theEvent)
                    throws IOException,
                           AutomationException

Notifies clients when drawing starts.

Remarks

IDisplay::StartDrawing fires this event to notify clients that drawing has started. The display where drawing was initiated is returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

displayFinished

void displayFinished(IDisplayEventsDisplayFinishedEvent theEvent)
                     throws IOException,
                            AutomationException

Notifies clients when drawing completes.

Remarks

IDisplay::FinishDrawing fires this event to notify clients that drawing has completed. The display where drawing has completed is returned to the client.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

displayInvalidated

void displayInvalidated(IDisplayEventsDisplayInvalidatedEvent theEvent)
                        throws IOException,
                               AutomationException

Notifies clients when display is invalidated.

Remarks

IScreenDisplay::Invalidate fires this event to notify all clients a display has been invalidated. The display, the area invalidated, the erase setting, and the cacheID are all returned to clients listening to this event.

The Map object is one client that listens for this event and it may in turn fire the IActiveViewEvenets::ViewRefreshed event.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

displayScrolled

void displayScrolled(IDisplayEventsDisplayScrolledEvent theEvent)
                     throws IOException,
                            AutomationException

Notifies clients when display is scrolled.

Remarks

IScreenDisplay::DoScroll fires this event to notify all clients that the display has scrolled. For example, the Map object listens for this event because it needs to perform some drawing operations whenever its display is scrolled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.