com.esri.arcgis.arcmapui
Class AppDisplay

java.lang.Object
  com.esri.arcgis.arcmapui.AppDisplay

All Implemented Interfaces:

IAppDisplay, IDisplay, IDraw, IScreenDisplay, IScreenDisplay2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class AppDisplay
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAppDisplay, IScreenDisplay, IScreenDisplay2, IDisplay, IDraw

COM Class 'AppDisplay'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description 'Esri Display.' 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.IAppDisplay

IID, IID534e08d6_e65a_11d0_8681_0000f8751720, xxDummy

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

IIDe6bdb004_4d35_11d0_98be_00805f7ced21

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

IIDe6bdb002_4d35_11d0_98be_00805f7ced21

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

IID, IIDdc321087_108f_43ae_932a_dfc1f7c4529e, xxDummy

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

IID, IID7ef23a93_f475_11d3_9f54_00c04f6bdf0d, xxDummy

Constructor Summary

AppDisplay()
Constructs a AppDisplay using ArcGIS Engine.

AppDisplay(java.lang.Object obj)
Construct a AppDisplay using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

short	addCache() Creates a new cache and return its ID.
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.
boolean	equals(java.lang.Object o) Compare this object with another
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.
int	getCacheMemDC(short index) Memory device context for the specified screen 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.
int	getCount() The number of ScreenDisplays associated with the application.
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.
IScreenDisplay	getFocusScreen() The ScreenDisplay associated with the window the mouse is over.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IScreenDisplay	getMainScreen() The ScreenDisplay associated with the main application window.
IScreenDisplay	getScreenDisplay(int idx) The nth ScreenDisplay associated with the application.
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.
boolean	isCacheDirty(short cacheIndex) Indicates if the specified cache needs refreshing.
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	isScaleContents() Indicates if the contents of the screen scale when a resize occurs.
boolean	isSuppressEvents() Indicates if display object suppresses events.
boolean	isSuppressResize() Indicates if display resizing is suppressed.
boolean	isUseScrollbars() Indicates if scrollbars should appear.
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	progress(int vertexCount) Call frequently during drawing process.
void	release() Release a AppDisplay.
void	removeAllCaches() Removes all caches.
void	removeCache(short cacheID) Removes the specified cache.
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	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	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	setMainScreenByRef(IScreenDisplay mainScreen) The ScreenDisplay associated with the main application window.
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	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	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	updateWindow() Forces a redraw.
void	validate(short cacheIndex) Clear dirty flag for specified cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppDisplay

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

Constructs a AppDisplay using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AppDisplay

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems AppDisplay theAppDisplay = (AppDisplay) obj;

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

release

public void release()

Release a AppDisplay.

Specified by:

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

setMainScreenByRef

public void setMainScreenByRef(IScreenDisplay mainScreen)
                        throws java.io.IOException,
                               AutomationException

The ScreenDisplay associated with the main application window. Set this property before using the other properties and methods.

Specified by:

setMainScreenByRef in interface IAppDisplay

Parameters:

mainScreen - A reference to a com.esri.arcgis.display.IScreenDisplay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMainScreen

public IScreenDisplay getMainScreen()
                             throws java.io.IOException,
                                    AutomationException

The ScreenDisplay associated with the main application window. Set this property before using the other properties and methods.

Specified by:

getMainScreen in interface IAppDisplay

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFocusScreen

public IScreenDisplay getFocusScreen()
                              throws java.io.IOException,
                                     AutomationException

The ScreenDisplay associated with the window the mouse is over. May be a lens window or the main window.

Specified by:

getFocusScreen in interface IAppDisplay

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

The number of ScreenDisplays associated with the application.

Specified by:

getCount in interface IAppDisplay

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScreenDisplay

public IScreenDisplay getScreenDisplay(int idx)
                                throws java.io.IOException,
                                       AutomationException

The nth ScreenDisplay associated with the application.

Specified by:

getScreenDisplay in interface IAppDisplay

Parameters:

idx - The idx (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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 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 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 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 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 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 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 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 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 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 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 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

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 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 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

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.

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.