com.esri.arcgis.display
Class ScreenDisplay

java.lang.Object
  com.esri.arcgis.display.ScreenDisplay

All Implemented Interfaces:

IConnectionPointContainer, IDisplay, IDisplayFiltersControl, IDraw, IDynamicScreenDisplay, IScreenCacheManager, IScreenDisplay, IScreenDisplay2, IScreenDisplay3, IScreenDisplayBasemap, IScreenDisplayOverlays, IScreenDisplayZoom, IScreenInvalidate, ITimeDisplay, ITimeDisplay2, ITransformEvents, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class ScreenDisplay
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IScreenDisplay, IScreenDisplay2, IScreenDisplay3, IScreenDisplayBasemap, IScreenDisplayOverlays, IScreenCacheManager, IScreenInvalidate, IDisplay, IDraw, ITransformEvents, IConnectionPointContainer, IDynamicScreenDisplay, IScreenDisplayZoom, IDisplayFiltersControl, ITimeDisplay, ITimeDisplay2

COM Class 'ScreenDisplay'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'Display class for drawing to window.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.display.IScreenDisplay

IID, IIDe6bdb004_4d35_11d0_98be_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.display.IScreenDisplay3

IID, IIDe9c1afa9_087e_46d2_b864_f9c0b4dd1199, xxDummy

Fields inherited from interface com.esri.arcgis.display.IScreenDisplay2

IIDdc321087_108f_43ae_932a_dfc1f7c4529e

Fields inherited from interface com.esri.arcgis.display.IDisplay

IIDe6bdb002_4d35_11d0_98be_00805f7ced21

Fields inherited from interface com.esri.arcgis.display.IScreenDisplayBasemap

IID, IID5002adae_af04_42de_86c0_93ec8c6be487, xxDummy

Fields inherited from interface com.esri.arcgis.display.IScreenDisplayOverlays

IID, IID6701b79e_3bb2_4e01_8a21_f9b4b68ae3ab, xxDummy

Fields inherited from interface com.esri.arcgis.display.IScreenCacheManager

IID, IID7b3572f2_57a7_46b3_af86_9c9bca1c8f15, xxDummy

Fields inherited from interface com.esri.arcgis.display.IScreenInvalidate

IID, IIDc1ccbfc2_6722_49f0_9242_ba2f312e24bf, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDraw

IID, IID7ef23a93_f475_11d3_9f54_00c04f6bdf0d, xxDummy

Fields inherited from interface com.esri.arcgis.display.ITransformEvents

IID, IIDe6bdb001_4d35_11d0_98be_00805f7ced21, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDynamicScreenDisplay

IID, IIDd2da3ec1_da41_4629_9347_2cc09ce589fa, xxDummy

Fields inherited from interface com.esri.arcgis.display.IScreenDisplayZoom

IID, IIDf3093e1f_ec1f_4db7_9095_f2874b0ceed0, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayFiltersControl

IID, IID37cf5545_8233_4941_b171_e623f74a2a74, xxDummy

Fields inherited from interface com.esri.arcgis.display.ITimeDisplay2

IID, IIDdaad3027_1474_40e2_8908_e27cef24a526, xxDummy

Fields inherited from interface com.esri.arcgis.display.ITimeDisplay

IID2045f389_b48e_4cb6_a63b_d1232c1af39d

Constructor Summary

ScreenDisplay()
Constructs a ScreenDisplay using ArcGIS Engine.

ScreenDisplay(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ScreenDisplay theScreenDisplay = (ScreenDisplay) obj;

Method Summary

short	addCache() Creates a new cache and return its ID.
void	addIDisplayEventsListener(IDisplayEvents theListener) addIDisplayEventsListener.
void	addITimeDisplayEventsListener(ITimeDisplayEvents theListener) addITimeDisplayEventsListener.
void	boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent) Notifies clients when the bounds is updated.
void	deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent) Notifies clients when the device frame is updated.
void	doScroll(int xDelta, int yDelta, boolean updateScreen) Scrolls the screen by the specified amount.
void	draw(IGeometry geometry) Draws the specified shape.
void	drawCache(int hDC, short index, tagRECT deviceRect, tagRECT cacheRect) Draws the specified screen cache to the specified window device context.
void	drawMultipoint(IGeometry multipoint) Draws specified multipoint on the display.
void	drawPoint(IGeometry point) Draws specified point on the display.
void	drawPolygon(IGeometry polygon) Draws specified polygon on the display.
void	drawPolyline(IGeometry polyline) Draws specified line on the display.
void	drawRectangle(IEnvelope rectangle) Draws specified rectangle on the display.
void	drawText(IGeometry shape, java.lang.String text) Draws specified text on the display.
void	enableBasemapMode(boolean bYesNo) Enables basemap continuous navigation drawing mode when set to true, disables when set to false.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	finishDrawing() Completes drawing.
void	finishFeedback() Ends feedback drawing.
void	frameScrolled(int x, int y) Call on frame display when container is scrolled.
short	getActiveCache() Screen cache where drawing occurs.
int	getBackgroundRGB() The RGB value of the background color.
short	getCacheCount() Number of screen caches.
void	getCacheFlags(short cacheID, int[] flags) Get special properties of specified cache.
int	getCacheMemDC(short index) Memory device context for the specified screen cache.
short	getCacheOrder(short cacheID) Sets or returns the order of the specified cache.
ITrackCancel	getCancelTracker() Cancel tracker that is associated with the display.
IEnvelope	getClipEnvelope() The bounds of the invalid region.
ISet	getClipEnvelopes() The invalid region as a set of envelopes.
IGeometry	getClipGeometry() User-specified clip shape.
IGeometry	getClipRegion() Clipping region (polygon or envelope).
static java.lang.String	getClsid() getClsid.
IDisplayFilter	getCurrentFilter() Gets current Display filter.
java.lang.Object	getCustomProperty() Custom property.
IDisplayTransformation	getDisplayTransformation() The transformation used by the display.
void	getDrawingOffset(int[] x, int[] y) The offset between the device origin and the active cache origin.
IDisplayFilter	getFilter() Display filter.
int	getHDC() The device context that the display is currently drawing to.
int	getHPalette() Palette.
int	getHWnd() Associated window handle.
IIlluminationProps	getIlluminationProps() Illumination properties used by the display.
IArea	getInvalidArea() The bounds of the invalid region.
IEnvelope	getInvalidEnvelope() The bounds of the invalid region.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ITimeReference	getTimeReference() Time reference using which the data has to be displayed.
int	getTimeRelation() Time relation for the time query.
ITimeValue	getTimeValue() Time Extent for which the data has to be displayed.
int	getWindowDC() Device context for the associated window.
int	hashCode() the hashcode for this object
void	invalidate(IEnvelope rect, boolean erase, short cacheIndex) Cause the specified area of the specified cache to redraw.
void	invalidateShape(IGeometry pGeometry, double symbolSizePoints, boolean erase, short cacheIndex) Cause the specified area of the specified cache to redraw.
boolean	isBasemapDrawing() Indicates if basemap drawing mode is enabled.
boolean	isBasemapModeActivated() Indicated if basemap mode is activated and continuous navigation can be performed.
boolean	isCacheDirty(short cacheIndex) Indicates if the specified cache needs refreshing.
boolean	isDynamicDisplayEnabled() Indicates if dynamic display is turned on or off.
boolean	isEdgePanMode() Indicates if edgepan/roaming pan is enabled while in basemap mode.
boolean	isFirstCacheTransparent() Indicates if the bottom cache is transparent.
boolean	isFramed() Indicates if drawing occurs in a frame rather than on the whole window.
boolean	isFullRedraw() Indicates if this is a complete or a partial redraw.
boolean	isMousePanMode() Indicates if mouse pan is enabled while in basemap mode.
boolean	isNavigating() Indicates whether the cuser is currently navigating.
boolean	isScaleContents() Indicates if the contents of the screen scale when a resize occurs.
boolean	isShowOverlays() Indicates if overlays are visible or not.
boolean	isSuppressEvents() Indicates if display object suppresses events.
boolean	isSuppressResize() Indicates if display resizing is suppressed.
boolean	isUseScrollbars() Indicates if scrollbars should appear.
void	modifyCacheFlags(short cacheID, int flagsToAdd, int flagsToRemove) Set special properties of specified cache.
void	panMoveTo(IPoint mouseLocation) Pans to a new point.
void	panStart(IPoint mouseLocation) Prepares display for panning.
IEnvelope	panStop() Stops panning and returns new visible bounds.
void	popFilter() Pops last Display filter.
void	progress(int vertexCount) Call frequently during drawing process.
void	pushFilter(IDisplayFilter filter) Pushes and activates the Display filter.
void	putCacheOrder(short cacheID, short order) Sets or returns the order of the specified cache.
void	release() Release a ScreenDisplay.
void	removeAllCaches() Removes all caches.
void	removeCache(short cacheID) Removes the specified cache.
void	removeIDisplayEventsListener(IDisplayEvents theListener) removeIDisplayEventsListener.
void	removeITimeDisplayEventsListener(ITimeDisplayEvents theListener) removeITimeDisplayEventsListener.
void	resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent) Notifies clients when the resolution is updated.
void	rotateMoveTo(IPoint pPoint) Rotates to new point.
void	rotateStart(IPoint mousePt, IPoint centerPt) Prepares display for rotating.
double	rotateStop() Stops rotating and returns new angle.
void	rotateTimer() Draws the rotated display.
void	rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent) Notifies clients when the rotation angle is updated.
void	setActiveCache(short index) Screen cache where drawing occurs.
void	setBackgroundRGB(int rGB) The RGB value of the background color.
void	setCancelTrackerByRef(ITrackCancel cancelTracker) Cancel tracker that is associated with the display.
void	setClipGeometry(IGeometry geometry) User-specified clip shape.
void	setCustomProperty(java.lang.Object customProperty) Custom property.
void	setDisplayTransformation(IDisplayTransformation displayTransformation) The transformation used by the display.
void	setEdgePanMode(boolean bYesNo) Indicates if edgepan/roaming pan is enabled while in basemap mode.
void	setFilterByRef(IDisplayFilter filter) Display filter.
void	setHPalette(int hPalette) Palette.
void	setHWnd(int hWnd) Associated window handle.
void	setIlluminationProps(IIlluminationProps illuminationProps) Illumination properties used by the display.
void	setIsFirstCacheTransparent(boolean flag) Indicates if the bottom cache is transparent.
void	setIsFramed(boolean flag) Indicates if drawing occurs in a frame rather than on the whole window.
void	setMousePanMode(boolean bYesNo) Indicates if mouse pan is enabled while in basemap mode.
void	setOverlaysCallback(IScreenDisplayOverlaysCallback rhs1) Set the draw call back.
void	setScaleContents(boolean flag) Indicates if the contents of the screen scale when a resize occurs.
void	setScrollbarHandles(int hWndHorzScrollbar, int hWndVertScrollbar) Optionally specify application supplied scrollbars.
void	setShowOverlays(boolean bYesNo) Indicates if overlays are visible or not.
void	setSuppressEvents(boolean suppressEvents) Indicates if display object suppresses events.
void	setSuppressResize(boolean suppressResize) Indicates if display resizing is suppressed.
void	setSymbol(ISymbol sym) Sets the symbol used for drawing.
void	setTimeReference(ITimeReference timeReference) Time reference using which the data has to be displayed.
void	setTimeRelation(int relation) Time relation for the time query.
void	setTimeValue(ITimeValue timeExtent) Time Extent for which the data has to be displayed.
void	setUseScrollbars(boolean flag) Indicates if scrollbars should appear.
void	startDrawing(int hDC, short cacheID) Prepare the display for drawing.
void	startFeedback() Prepare the display for drawing selection/rubberbanding.
void	startRecording() Starts recording all output to the recording cache.
void	stopRecording() Stops recording to the recording cache.
void	trackPan() Interactively pans the screen.
void	trackRotate() Interactively rotates the screen.
void	trackZoom() Interactively Zooms the screen.
void	unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent) Notifies clients when the units are updated.
void	updateWindow() Forces a redraw.
void	validate(short cacheIndex) Clear dirty flag for specified cache.
void	visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent) Notifies clients when the visible bounds is updated.
void	zoomMoveTo(IPoint point) Zooms to a new extent.
void	zoomStart(IPoint point) Prepares display for zooming.
IEnvelope	zoomStop() Stops zooming and returns new visible bounds.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScreenDisplay

public ScreenDisplay()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a ScreenDisplay using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ScreenDisplay

public ScreenDisplay(java.lang.Object obj)
              throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ScreenDisplay theScreenDisplay = (ScreenDisplay) obj;

Construct a ScreenDisplay using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ScreenDisplay.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIDisplayEventsListener

public void addIDisplayEventsListener(IDisplayEvents theListener)
                               throws java.io.IOException

addIDisplayEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.display.IDisplayEvents interface.

Throws:

java.io.IOException - If there are communications problems.

removeIDisplayEventsListener

public void removeIDisplayEventsListener(IDisplayEvents theListener)
                                  throws java.io.IOException

removeIDisplayEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.display.IDisplayEvents interface.

Throws:

java.io.IOException - If there are communications problems.

addITimeDisplayEventsListener

public void addITimeDisplayEventsListener(ITimeDisplayEvents theListener)
                                   throws java.io.IOException

addITimeDisplayEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.display.ITimeDisplayEvents interface.

Throws:

java.io.IOException - If there are communications problems.

removeITimeDisplayEventsListener

public void removeITimeDisplayEventsListener(ITimeDisplayEvents theListener)
                                      throws java.io.IOException

removeITimeDisplayEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.display.ITimeDisplayEvents interface.

Throws:

java.io.IOException - If there are communications problems.

release

public void release()

Release a ScreenDisplay.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setHWnd

public void setHWnd(int hWnd)
             throws java.io.IOException,
                    AutomationException

Associated window handle.

Specified by:

setHWnd in interface IScreenDisplay

Specified by:

setHWnd in interface IScreenDisplay2

Parameters:

hWnd - The hWnd (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws java.io.IOException,
                   AutomationException

Associated window handle.

Specified by:

getHWnd in interface IScreenDisplay

Specified by:

getHWnd in interface IScreenDisplay2

Returns:

The hWnd (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWindowDC

public int getWindowDC()
                throws java.io.IOException,
                       AutomationException

Device context for the associated window. Only use this between calls to StartDrawing and FinishDrawing.

Specified by:

getWindowDC in interface IScreenDisplay

Specified by:

getWindowDC in interface IScreenDisplay2

Returns:

The hDC (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addCache

public short addCache()
               throws java.io.IOException,
                      AutomationException

Creates a new cache and return its ID. The ID can be specified to StartDrawing to direct output to the cache. It can also be used with a number of other methods such as DrawCache and Invalidate.

Specified by:

addCache in interface IScreenCacheManager

Specified by:

addCache in interface IScreenDisplay

Specified by:

addCache in interface IScreenDisplay2

Returns:

The cacheID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeCache

public void removeCache(short cacheID)
                 throws java.io.IOException,
                        AutomationException

Removes the specified cache.

Specified by:

removeCache in interface IScreenCacheManager

Specified by:

removeCache in interface IScreenDisplay

Specified by:

removeCache in interface IScreenDisplay2

Parameters:

cacheID - The cacheID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheCount

public short getCacheCount()
                    throws java.io.IOException,
                           AutomationException

Number of screen caches.

Specified by:

getCacheCount in interface IScreenCacheManager

Specified by:

getCacheCount in interface IScreenDisplay

Specified by:

getCacheCount in interface IScreenDisplay2

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllCaches

public void removeAllCaches()
                     throws java.io.IOException,
                            AutomationException

Removes all caches.

Specified by:

removeAllCaches in interface IScreenCacheManager

Specified by:

removeAllCaches in interface IScreenDisplay

Specified by:

removeAllCaches in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheMemDC

public int getCacheMemDC(short index)
                  throws java.io.IOException,
                         AutomationException

Memory device context for the specified screen cache.

Specified by:

getCacheMemDC in interface IScreenCacheManager

Specified by:

getCacheMemDC in interface IScreenDisplay

Specified by:

getCacheMemDC in interface IScreenDisplay2

Parameters:

index - The index (in)

Returns:

The hDC (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveCache

public void setActiveCache(short index)
                    throws java.io.IOException,
                           AutomationException

Screen cache where drawing occurs. Use rarely. Change cache inside StartDrawing/FinishDrawing sequence.

Specified by:

setActiveCache in interface IScreenCacheManager

Specified by:

setActiveCache in interface IScreenDisplay

Specified by:

setActiveCache in interface IScreenDisplay2

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveCache

public short getActiveCache()
                     throws java.io.IOException,
                            AutomationException

Screen cache where drawing occurs. Use rarely. Change cache inside StartDrawing/FinishDrawing sequence.

Specified by:

getActiveCache in interface IScreenCacheManager

Specified by:

getActiveCache in interface IScreenDisplay

Specified by:

getActiveCache in interface IScreenDisplay2

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsFirstCacheTransparent

public void setIsFirstCacheTransparent(boolean flag)
                                throws java.io.IOException,
                                       AutomationException

Indicates if the bottom cache is transparent.

Specified by:

setIsFirstCacheTransparent in interface IScreenCacheManager

Specified by:

setIsFirstCacheTransparent in interface IScreenDisplay

Specified by:

setIsFirstCacheTransparent in interface IScreenDisplay2

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFirstCacheTransparent

public boolean isFirstCacheTransparent()
                                throws java.io.IOException,
                                       AutomationException

Indicates if the bottom cache is transparent.

Specified by:

isFirstCacheTransparent in interface IScreenCacheManager

Specified by:

isFirstCacheTransparent in interface IScreenDisplay

Specified by:

isFirstCacheTransparent in interface IScreenDisplay2

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startRecording

public void startRecording()
                    throws java.io.IOException,
                           AutomationException

Starts recording all output to the recording cache.

Specified by:

startRecording in interface IScreenCacheManager

Specified by:

startRecording in interface IScreenDisplay

Specified by:

startRecording in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopRecording

public void stopRecording()
                   throws java.io.IOException,
                          AutomationException

Stops recording to the recording cache.

Specified by:

stopRecording in interface IScreenCacheManager

Specified by:

stopRecording in interface IScreenDisplay

Specified by:

stopRecording in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseScrollbars

public void setUseScrollbars(boolean flag)
                      throws java.io.IOException,
                             AutomationException

Indicates if scrollbars should appear.

Specified by:

setUseScrollbars in interface IScreenDisplay

Specified by:

setUseScrollbars in interface IScreenDisplay2

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseScrollbars

public boolean isUseScrollbars()
                        throws java.io.IOException,
                               AutomationException

Indicates if scrollbars should appear.

Specified by:

isUseScrollbars in interface IScreenDisplay

Specified by:

isUseScrollbars in interface IScreenDisplay2

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScrollbarHandles

public void setScrollbarHandles(int hWndHorzScrollbar,
                                int hWndVertScrollbar)
                         throws java.io.IOException,
                                AutomationException

Optionally specify application supplied scrollbars.

Specified by:

setScrollbarHandles in interface IScreenDisplay

Specified by:

setScrollbarHandles in interface IScreenDisplay2

Parameters:

hWndHorzScrollbar - The hWndHorzScrollbar (A COM typedef) (in)

hWndVertScrollbar - The hWndVertScrollbar (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScaleContents

public void setScaleContents(boolean flag)
                      throws java.io.IOException,
                             AutomationException

Indicates if the contents of the screen scale when a resize occurs. True means scale contents to fit new window size. False means contents stays the same with more or less of it showing.

Specified by:

setScaleContents in interface IScreenDisplay

Specified by:

setScaleContents in interface IScreenDisplay2

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isScaleContents

public boolean isScaleContents()
                        throws java.io.IOException,
                               AutomationException

Indicates if the contents of the screen scale when a resize occurs. True means scale contents to fit new window size. False means contents stays the same with more or less of it showing.

Specified by:

isScaleContents in interface IScreenDisplay

Specified by:

isScaleContents in interface IScreenDisplay2

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuppressResize

public void setSuppressResize(boolean suppressResize)
                       throws java.io.IOException,
                              AutomationException

Indicates if display resizing is suppressed. True means the display doesn't resize with the window. False ensures that the display is the same size as the window.

Specified by:

setSuppressResize in interface IScreenDisplay

Specified by:

setSuppressResize in interface IScreenDisplay2

Parameters:

suppressResize - The suppressResize (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSuppressResize

public boolean isSuppressResize()
                         throws java.io.IOException,
                                AutomationException

Indicates if display resizing is suppressed. True means the display doesn't resize with the window. False ensures that the display is the same size as the window.

Specified by:

isSuppressResize in interface IScreenDisplay

Specified by:

isSuppressResize in interface IScreenDisplay2

Returns:

The suppressResize

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFramed

public boolean isFramed()
                 throws java.io.IOException,
                        AutomationException

Indicates if drawing occurs in a frame rather than on the whole window.

Specified by:

isFramed in interface IScreenDisplay

Specified by:

isFramed in interface IScreenDisplay2

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsFramed

public void setIsFramed(boolean flag)
                 throws java.io.IOException,
                        AutomationException

Indicates if drawing occurs in a frame rather than on the whole window.

Specified by:

setIsFramed in interface IScreenDisplay

Specified by:

setIsFramed in interface IScreenDisplay2

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCancelTracker

public ITrackCancel getCancelTracker()
                              throws java.io.IOException,
                                     AutomationException

Cancel tracker that is associated with the display.

Specified by:

getCancelTracker in interface IScreenDisplay

Specified by:

getCancelTracker in interface IScreenDisplay2

Returns:

A reference to a com.esri.arcgis.system.ITrackCancel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelTrackerByRef

public void setCancelTrackerByRef(ITrackCancel cancelTracker)
                           throws java.io.IOException,
                                  AutomationException

Cancel tracker that is associated with the display.

Specified by:

setCancelTrackerByRef in interface IScreenDisplay

Specified by:

setCancelTrackerByRef in interface IScreenDisplay2

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

invalidate

public void invalidate(IEnvelope rect,
                       boolean erase,
                       short cacheIndex)
                throws java.io.IOException,
                       AutomationException

Cause the specified area of the specified cache to redraw.

Specified by:

invalidate in interface IScreenDisplay

Specified by:

invalidate in interface IScreenDisplay2

Specified by:

invalidate in interface IScreenInvalidate

Parameters:

rect - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

erase - The erase (in)

cacheIndex - The cacheIndex (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCacheDirty

public boolean isCacheDirty(short cacheIndex)
                     throws java.io.IOException,
                            AutomationException

Indicates if the specified cache needs refreshing.

Specified by:

isCacheDirty in interface IScreenCacheManager

Specified by:

isCacheDirty in interface IScreenDisplay

Specified by:

isCacheDirty in interface IScreenDisplay2

Parameters:

cacheIndex - The cacheIndex (in)

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawCache

public void drawCache(int hDC,
                      short index,
                      tagRECT deviceRect,
                      tagRECT cacheRect)
               throws java.io.IOException,
                      AutomationException

Draws the specified screen cache to the specified window device context. Pass an empty rectangle to copy the full bitmap to the DC origin.

Specified by:

drawCache in interface IScreenCacheManager

Specified by:

drawCache in interface IScreenDisplay

Specified by:

drawCache in interface IScreenDisplay2

Parameters:

hDC - The hDC (A COM typedef) (in)

index - The index (in)

deviceRect - A Structure: com.esri.arcgis.system.tagRECT (in)

cacheRect - A Structure: com.esri.arcgis.system.tagRECT (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doScroll

public void doScroll(int xDelta,
                     int yDelta,
                     boolean updateScreen)
              throws java.io.IOException,
                     AutomationException

Scrolls the screen by the specified amount.

Specified by:

doScroll in interface IScreenDisplay

Specified by:

doScroll in interface IScreenDisplay2

Parameters:

xDelta - The xDelta (in)

yDelta - The yDelta (in)

updateScreen - The updateScreen (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

trackPan

public void trackPan()
              throws java.io.IOException,
                     AutomationException

Interactively pans the screen.

Specified by:

trackPan in interface IScreenDisplay

Specified by:

trackPan in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

panStart

public void panStart(IPoint mouseLocation)
              throws java.io.IOException,
                     AutomationException

Prepares display for panning.

Specified by:

panStart in interface IScreenDisplay

Specified by:

panStart in interface IScreenDisplay2

Parameters:

mouseLocation - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

panMoveTo

public void panMoveTo(IPoint mouseLocation)
               throws java.io.IOException,
                      AutomationException

Pans to a new point.

Specified by:

panMoveTo in interface IScreenDisplay

Specified by:

panMoveTo in interface IScreenDisplay2

Parameters:

mouseLocation - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

panStop

public IEnvelope panStop()
                  throws java.io.IOException,
                         AutomationException

Stops panning and returns new visible bounds.

Specified by:

panStop in interface IScreenDisplay

Specified by:

panStop in interface IScreenDisplay2

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

trackRotate

public void trackRotate()
                 throws java.io.IOException,
                        AutomationException

Interactively rotates the screen.

Specified by:

trackRotate in interface IScreenDisplay

Specified by:

trackRotate in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotateStart

public void rotateStart(IPoint mousePt,
                        IPoint centerPt)
                 throws java.io.IOException,
                        AutomationException

Prepares display for rotating. If centerPt is NULL, the center of the visible bounds is used.

Specified by:

rotateStart in interface IScreenDisplay

Specified by:

rotateStart in interface IScreenDisplay2

Parameters:

mousePt - A reference to a com.esri.arcgis.geometry.IPoint (in)

centerPt - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotateMoveTo

public void rotateMoveTo(IPoint pPoint)
                  throws java.io.IOException,
                         AutomationException

Rotates to new point.

Specified by:

rotateMoveTo in interface IScreenDisplay

Specified by:

rotateMoveTo in interface IScreenDisplay2

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotateTimer

public void rotateTimer()
                 throws java.io.IOException,
                        AutomationException

Draws the rotated display. Call in response to WM_TIMER.

Specified by:

rotateTimer in interface IScreenDisplay

Specified by:

rotateTimer in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotateStop

public double rotateStop()
                  throws java.io.IOException,
                         AutomationException

Stops rotating and returns new angle.

Specified by:

rotateStop in interface IScreenDisplay

Specified by:

rotateStop in interface IScreenDisplay2

Returns:

The degrees

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateWindow

public void updateWindow()
                  throws java.io.IOException,
                         AutomationException

Forces a redraw.

Specified by:

updateWindow in interface IScreenDisplay

Specified by:

updateWindow in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayTransformation

public IDisplayTransformation getDisplayTransformation()
                                                throws java.io.IOException,
                                                       AutomationException

The transformation used by the display.

Specified by:

getDisplayTransformation in interface IDisplay

Returns:

A reference to a com.esri.arcgis.display.IDisplayTransformation

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayTransformation

public void setDisplayTransformation(IDisplayTransformation displayTransformation)
                              throws java.io.IOException,
                                     AutomationException

The transformation used by the display.

Specified by:

setDisplayTransformation in interface IDisplay

Parameters:

displayTransformation - A reference to a com.esri.arcgis.display.IDisplayTransformation (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClipEnvelope

public IEnvelope getClipEnvelope()
                          throws java.io.IOException,
                                 AutomationException

The bounds of the invalid region. Use after StartDrawing and before FinishDrawing.

Specified by:

getClipEnvelope in interface IDisplay

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClipEnvelopes

public ISet getClipEnvelopes()
                      throws java.io.IOException,
                             AutomationException

The invalid region as a set of envelopes. Use after StartDrawing and before FinishDrawing.

Specified by:

getClipEnvelopes in interface IDisplay

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClipGeometry

public IGeometry getClipGeometry()
                          throws java.io.IOException,
                                 AutomationException

User-specified clip shape. This shape is merged with the invalid region to arrive at the actual clip region. Must be specified before StartDrawing.

Specified by:

getClipGeometry in interface IDisplay

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipGeometry

public void setClipGeometry(IGeometry geometry)
                     throws java.io.IOException,
                            AutomationException

User-specified clip shape. This shape is merged with the invalid region to arrive at the actual clip region. Must be specified before StartDrawing.

Specified by:

setClipGeometry in interface IDisplay

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSuppressEvents

public boolean isSuppressEvents()
                         throws java.io.IOException,
                                AutomationException

Indicates if display object suppresses events.

Specified by:

isSuppressEvents in interface IDisplay

Returns:

The suppressEvents

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuppressEvents

public void setSuppressEvents(boolean suppressEvents)
                       throws java.io.IOException,
                              AutomationException

Indicates if display object suppresses events.

Specified by:

setSuppressEvents in interface IDisplay

Parameters:

suppressEvents - The suppressEvents (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilter

public IDisplayFilter getFilter()
                         throws java.io.IOException,
                                AutomationException

Display filter. Must call while in a StartDrawing-FinishDrawing sequence. Set Filter to 0 to resume normal drawing.

Specified by:

getFilter in interface IDisplay

Returns:

A reference to a com.esri.arcgis.display.IDisplayFilter

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilterByRef

public void setFilterByRef(IDisplayFilter filter)
                    throws java.io.IOException,
                           AutomationException

Display filter. Must call while in a StartDrawing-FinishDrawing sequence. Set Filter to 0 to resume normal drawing.

Specified by:

setFilterByRef in interface IDisplay

Parameters:

filter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHPalette

public int getHPalette()
                throws java.io.IOException,
                       AutomationException

Palette.

Specified by:

getHPalette in interface IDisplay

Returns:

The hPalette (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHPalette

public void setHPalette(int hPalette)
                 throws java.io.IOException,
                        AutomationException

Palette.

Specified by:

setHPalette in interface IDisplay

Parameters:

hPalette - The hPalette (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startDrawing

public void startDrawing(int hDC,
                         short cacheID)
                  throws java.io.IOException,
                         AutomationException

Prepare the display for drawing. Specify the device context and the cache to draw to (normally esriNoScreenCache). The ScreenDisplay coclass will automatically create a window device context if you specify hdc = 0.

Specified by:

startDrawing in interface IDisplay

Specified by:

startDrawing in interface IDraw

Parameters:

hDC - The hDC (A COM typedef) (in)

cacheID - The cacheID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHDC

public int getHDC()
           throws java.io.IOException,
                  AutomationException

The device context that the display is currently drawing to. Only valid between calls to StartDrawing and FinishDrawing.

Specified by:

getHDC in interface IDisplay

Returns:

The hDC (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishDrawing

public void finishDrawing()
                   throws java.io.IOException,
                          AutomationException

Completes drawing.

Specified by:

finishDrawing in interface IDisplay

Specified by:

finishDrawing in interface IDraw

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

progress

public void progress(int vertexCount)
              throws java.io.IOException,
                     AutomationException

Call frequently during drawing process.

Specified by:

progress in interface IDisplay

Parameters:

vertexCount - The vertexCount (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawPoint

public void drawPoint(IGeometry point)
               throws java.io.IOException,
                      AutomationException

Draws specified point on the display.

Specified by:

drawPoint in interface IDisplay

Parameters:

point - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawMultipoint

public void drawMultipoint(IGeometry multipoint)
                    throws java.io.IOException,
                           AutomationException

Draws specified multipoint on the display.

Specified by:

drawMultipoint in interface IDisplay

Parameters:

multipoint - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawRectangle

public void drawRectangle(IEnvelope rectangle)
                   throws java.io.IOException,
                          AutomationException

Draws specified rectangle on the display.

Specified by:

drawRectangle in interface IDisplay

Parameters:

rectangle - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawPolyline

public void drawPolyline(IGeometry polyline)
                  throws java.io.IOException,
                         AutomationException

Draws specified line on the display.

Specified by:

drawPolyline in interface IDisplay

Parameters:

polyline - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawPolygon

public void drawPolygon(IGeometry polygon)
                 throws java.io.IOException,
                        AutomationException

Draws specified polygon on the display.

Specified by:

drawPolygon in interface IDisplay

Parameters:

polygon - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawText

public void drawText(IGeometry shape,
                     java.lang.String text)
              throws java.io.IOException,
                     AutomationException

Draws specified text on the display.

Specified by:

drawText in interface IDisplay

Parameters:

shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

text - The text (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(ISymbol sym)
               throws java.io.IOException,
                      AutomationException

Sets the symbol used for drawing. Four different symbols can be specified simultaneously: Marker, Line, Fill, Text.

Specified by:

setSymbol in interface IDisplay

Specified by:

setSymbol in interface IDraw

Parameters:

sym - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIlluminationProps

public IIlluminationProps getIlluminationProps()
                                        throws java.io.IOException,
                                               AutomationException

Illumination properties used by the display.

Specified by:

getIlluminationProps in interface IDisplay

Returns:

A reference to a com.esri.arcgis.display.IIlluminationProps

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIlluminationProps

public void setIlluminationProps(IIlluminationProps illuminationProps)
                          throws java.io.IOException,
                                 AutomationException

Illumination properties used by the display.

Specified by:

setIlluminationProps in interface IDisplay

Parameters:

illuminationProps - A reference to a com.esri.arcgis.display.IIlluminationProps (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundRGB

public void setBackgroundRGB(int rGB)
                      throws java.io.IOException,
                             AutomationException

The RGB value of the background color. This color only appears on the screen, not on output.

Specified by:

setBackgroundRGB in interface IScreenDisplay2

Parameters:

rGB - The rGB (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundRGB

public int getBackgroundRGB()
                     throws java.io.IOException,
                            AutomationException

The RGB value of the background color. This color only appears on the screen, not on output.

Specified by:

getBackgroundRGB in interface IScreenDisplay2

Returns:

The rGB (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDrawingOffset

public void getDrawingOffset(int[] x,
                             int[] y)
                      throws java.io.IOException,
                             AutomationException

The offset between the device origin and the active cache origin.

Specified by:

getDrawingOffset in interface IScreenDisplay2

Parameters:

x - The x (out: use single element array)

y - The y (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validate

public void validate(short cacheIndex)
              throws java.io.IOException,
                     AutomationException

Clear dirty flag for specified cache.

Specified by:

validate in interface IScreenDisplay2

Specified by:

validate in interface IScreenInvalidate

Parameters:

cacheIndex - The cacheIndex (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startFeedback

public void startFeedback()
                   throws java.io.IOException,
                          AutomationException

Prepare the display for drawing selection/rubberbanding. Drawing isn't clipped or zoomed with page. Must match with a call to FinishFeedback.

Specified by:

startFeedback in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishFeedback

public void finishFeedback()
                    throws java.io.IOException,
                           AutomationException

Ends feedback drawing.

Specified by:

finishFeedback in interface IScreenDisplay2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

frameScrolled

public void frameScrolled(int x,
                          int y)
                   throws java.io.IOException,
                          AutomationException

Call on frame display when container is scrolled.

Specified by:

frameScrolled in interface IScreenDisplay2

Parameters:

x - The x (in)

y - The y (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNavigating

public boolean isNavigating()
                     throws java.io.IOException,
                            AutomationException

Indicates whether the cuser is currently navigating.

Specified by:

isNavigating in interface IScreenDisplay3

Returns:

The navigating

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFullRedraw

public boolean isFullRedraw()
                     throws java.io.IOException,
                            AutomationException

Indicates if this is a complete or a partial redraw.

Specified by:

isFullRedraw in interface IScreenDisplay3

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMousePanMode

public boolean isMousePanMode()
                       throws java.io.IOException,
                              AutomationException

Indicates if mouse pan is enabled while in basemap mode.

Specified by:

isMousePanMode in interface IScreenDisplayBasemap

Returns:

The bYesNo

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMousePanMode

public void setMousePanMode(boolean bYesNo)
                     throws java.io.IOException,
                            AutomationException

Indicates if mouse pan is enabled while in basemap mode.

Specified by:

setMousePanMode in interface IScreenDisplayBasemap

Parameters:

bYesNo - The bYesNo (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEdgePanMode

public boolean isEdgePanMode()
                      throws java.io.IOException,
                             AutomationException

Indicates if edgepan/roaming pan is enabled while in basemap mode.

Specified by:

isEdgePanMode in interface IScreenDisplayBasemap

Returns:

The bYesNo

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEdgePanMode

public void setEdgePanMode(boolean bYesNo)
                    throws java.io.IOException,
                           AutomationException

Indicates if edgepan/roaming pan is enabled while in basemap mode.

Specified by:

setEdgePanMode in interface IScreenDisplayBasemap

Parameters:

bYesNo - The bYesNo (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBasemapDrawing

public boolean isBasemapDrawing()
                         throws java.io.IOException,
                                AutomationException

Indicates if basemap drawing mode is enabled.

Specified by:

isBasemapDrawing in interface IScreenDisplayBasemap

Returns:

The bYesNo

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableBasemapMode

public void enableBasemapMode(boolean bYesNo)
                       throws java.io.IOException,
                              AutomationException

Enables basemap continuous navigation drawing mode when set to true, disables when set to false.

Specified by:

enableBasemapMode in interface IScreenDisplayBasemap

Parameters:

bYesNo - The bYesNo (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBasemapModeActivated

public boolean isBasemapModeActivated()
                               throws java.io.IOException,
                                      AutomationException

Indicated if basemap mode is activated and continuous navigation can be performed.

Specified by:

isBasemapModeActivated in interface IScreenDisplayBasemap

Returns:

The bYesNo

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowOverlays

public void setShowOverlays(boolean bYesNo)
                     throws java.io.IOException,
                            AutomationException

Indicates if overlays are visible or not.

Specified by:

setShowOverlays in interface IScreenDisplayOverlays

Parameters:

bYesNo - The bYesNo (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowOverlays

public boolean isShowOverlays()
                       throws java.io.IOException,
                              AutomationException

Indicates if overlays are visible or not.

Specified by:

isShowOverlays in interface IScreenDisplayOverlays

Returns:

The bYesNo

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverlaysCallback

public void setOverlaysCallback(IScreenDisplayOverlaysCallback rhs1)
                         throws java.io.IOException,
                                AutomationException

Set the draw call back.

Specified by:

setOverlaysCallback in interface IScreenDisplayOverlays

Parameters:

rhs1 - A reference to a com.esri.arcgis.display.IScreenDisplayOverlaysCallback (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheFlags

public void getCacheFlags(short cacheID,
                          int[] flags)
                   throws java.io.IOException,
                          AutomationException

Get special properties of specified cache.

Specified by:

getCacheFlags in interface IScreenCacheManager

Parameters:

cacheID - The cacheID (in)

flags - A com.esri.arcgis.display.esriDisplayCacheFlags constant (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

modifyCacheFlags

public void modifyCacheFlags(short cacheID,
                             int flagsToAdd,
                             int flagsToRemove)
                      throws java.io.IOException,
                             AutomationException

Set special properties of specified cache.

Specified by:

modifyCacheFlags in interface IScreenCacheManager

Parameters:

cacheID - The cacheID (in)

flagsToAdd - A com.esri.arcgis.display.esriDisplayCacheFlags constant (in)

flagsToRemove - A com.esri.arcgis.display.esriDisplayCacheFlags constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCacheOrder

public void putCacheOrder(short cacheID,
                          short order)
                   throws java.io.IOException,
                          AutomationException

Sets or returns the order of the specified cache. Client's that use multiple caches may assign an order to them. Bottom cache is 0 and top cache is n.

Specified by:

putCacheOrder in interface IScreenCacheManager

Parameters:

cacheID - The cacheID (in)

order - The order (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheOrder

public short getCacheOrder(short cacheID)
                    throws java.io.IOException,
                           AutomationException

Sets or returns the order of the specified cache. Client's that use multiple caches can assign an order to them. Bottom cache is 0 and top cache is n.

Specified by:

getCacheOrder in interface IScreenCacheManager

Parameters:

cacheID - The cacheID (in)

Returns:

The order

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidEnvelope

public IEnvelope getInvalidEnvelope()
                             throws java.io.IOException,
                                    AutomationException

The bounds of the invalid region.

Specified by:

getInvalidEnvelope in interface IScreenInvalidate

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidArea

public IArea getInvalidArea()
                     throws java.io.IOException,
                            AutomationException

The bounds of the invalid region.

Specified by:

getInvalidArea in interface IScreenInvalidate

Returns:

A reference to a com.esri.arcgis.geometry.IArea

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

invalidateShape

public void invalidateShape(IGeometry pGeometry,
                            double symbolSizePoints,
                            boolean erase,
                            short cacheIndex)
                     throws java.io.IOException,
                            AutomationException

Cause the specified area of the specified cache to redraw. Use symbolSizePoints to specify point sizes and line widths.

Specified by:

invalidateShape in interface IScreenInvalidate

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

symbolSizePoints - The symbolSizePoints (in)

erase - The erase (in)

cacheIndex - The cacheIndex (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IGeometry geometry)
          throws java.io.IOException,
                 AutomationException

Draws the specified shape.

Specified by:

draw in interface IDraw

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

Custom property.

Specified by:

getCustomProperty in interface IDraw

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object customProperty)
                       throws java.io.IOException,
                              AutomationException

Custom property.

Specified by:

setCustomProperty in interface IDraw

Parameters:

customProperty - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClipRegion

public IGeometry getClipRegion()
                        throws java.io.IOException,
                               AutomationException

Clipping region (polygon or envelope). Use after StartDrawing and before FinishDrawing.

Specified by:

getClipRegion in interface IDraw

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

boundsUpdated

public void boundsUpdated(ITransformEventsBoundsUpdatedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Notifies clients when the bounds is updated.

Specified by:

boundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

visibleBoundsUpdated

public void visibleBoundsUpdated(ITransformEventsVisibleBoundsUpdatedEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException

Notifies clients when the visible bounds is updated.

Specified by:

visibleBoundsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deviceFrameUpdated

public void deviceFrameUpdated(ITransformEventsDeviceFrameUpdatedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Notifies clients when the device frame is updated.

Specified by:

deviceFrameUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolutionUpdated

public void resolutionUpdated(ITransformEventsResolutionUpdatedEvent theEvent)
                       throws java.io.IOException,
                              AutomationException

Notifies clients when the resolution is updated.

Specified by:

resolutionUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotationUpdated

public void rotationUpdated(ITransformEventsRotationUpdatedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Notifies clients when the rotation angle is updated.

Specified by:

rotationUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unitsUpdated

public void unitsUpdated(ITransformEventsUnitsUpdatedEvent theEvent)
                  throws java.io.IOException,
                         AutomationException

Notifies clients when the units are updated.

Specified by:

unitsUpdated in interface ITransformEvents

Parameters:

theEvent - The event

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDynamicDisplayEnabled

public boolean isDynamicDisplayEnabled()
                                throws java.io.IOException,
                                       AutomationException

Indicates if dynamic display is turned on or off.

Specified by:

isDynamicDisplayEnabled in interface IDynamicScreenDisplay

Returns:

The isEnable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomStart

public void zoomStart(IPoint point)
               throws java.io.IOException,
                      AutomationException

Prepares display for zooming.

Specified by:

zoomStart in interface IScreenDisplayZoom

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomMoveTo

public void zoomMoveTo(IPoint point)
                throws java.io.IOException,
                       AutomationException

Zooms to a new extent.

Specified by:

zoomMoveTo in interface IScreenDisplayZoom

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomStop

public IEnvelope zoomStop()
                   throws java.io.IOException,
                          AutomationException

Stops zooming and returns new visible bounds.

Specified by:

zoomStop in interface IScreenDisplayZoom

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

trackZoom

public void trackZoom()
               throws java.io.IOException,
                      AutomationException

Interactively Zooms the screen.

Specified by:

trackZoom in interface IScreenDisplayZoom

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pushFilter

public void pushFilter(IDisplayFilter filter)
                throws java.io.IOException,
                       AutomationException

Pushes and activates the Display filter. Must call while in a StartDrawing-FinishDrawing sequence.

Specified by:

pushFilter in interface IDisplayFiltersControl

Parameters:

filter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

popFilter

public void popFilter()
               throws java.io.IOException,
                      AutomationException

Pops last Display filter. Must call while in a StartDrawing-FinishDrawing sequence.

Specified by:

popFilter in interface IDisplayFiltersControl

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentFilter

public IDisplayFilter getCurrentFilter()
                                throws java.io.IOException,
                                       AutomationException

Gets current Display filter. Must call while in a StartDrawing-FinishDrawing sequence.

Specified by:

getCurrentFilter in interface IDisplayFiltersControl

Returns:

A reference to a com.esri.arcgis.display.IDisplayFilter

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeValue

public ITimeValue getTimeValue()
                        throws java.io.IOException,
                               AutomationException

Time Extent for which the data has to be displayed.

Specified by:

getTimeValue in interface ITimeDisplay

Returns:

A reference to a com.esri.arcgis.system.ITimeValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValue

public void setTimeValue(ITimeValue timeExtent)
                  throws java.io.IOException,
                         AutomationException

Time Extent for which the data has to be displayed.

Specified by:

setTimeValue in interface ITimeDisplay

Parameters:

timeExtent - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException

Time reference using which the data has to be displayed.

Specified by:

getTimeReference in interface ITimeDisplay

Returns:

A reference to a com.esri.arcgis.system.ITimeReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReference

public void setTimeReference(ITimeReference timeReference)
                      throws java.io.IOException,
                             AutomationException

Time reference using which the data has to be displayed.

Specified by:

setTimeReference in interface ITimeDisplay

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeRelation

public int getTimeRelation()
                    throws java.io.IOException,
                           AutomationException

Time relation for the time query.

Specified by:

getTimeRelation in interface ITimeDisplay2

Returns:

A com.esri.arcgis.system.esriTimeRelation constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeRelation

public void setTimeRelation(int relation)
                     throws java.io.IOException,
                            AutomationException

Time relation for the time query.

Specified by:

setTimeRelation in interface ITimeDisplay2

Parameters:

relation - A com.esri.arcgis.system.esriTimeRelation constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.