com.esri.arcgis.display
Interface IScreenDisplay2

All Superinterfaces:

IDisplay, java.io.Serializable

All Known Subinterfaces:

IScreenDisplay3

All Known Implementing Classes:

AppDisplay, IScreenDisplay2Proxy, IScreenDisplay3Proxy, SceneGraph, ScreenDisplay

public interface IScreenDisplay2
extends IDisplay, java.io.Serializable

COM Interface 'IScreenDisplay2'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to additional members that control the Screen 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDdc321087_108f_43ae_932a_dfc1f7c4529e
static int	xxDummy Deprecated. Internal use only

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

IIDe6bdb002_4d35_11d0_98be_00805f7ced21

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	drawCache(int hDC, short index, tagRECT deviceRect, tagRECT cacheRect) Draws the specified screen cache to the specified window device context.
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.
void	getDrawingOffset(int[] x, int[] y) The offset between the device origin and the active cache origin.
int	getHWnd() Associated window handle.
int	getWindowDC() Device context for the associated window.
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	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	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	setHWnd(int hWnd) Associated window handle.
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	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	setSuppressResize(boolean suppressResize) Indicates if display resizing is suppressed.
void	setUseScrollbars(boolean flag) Indicates if scrollbars should appear.
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 interface com.esri.arcgis.display.IDisplay

drawMultipoint, drawPoint, drawPolygon, drawPolyline, drawRectangle, drawText, finishDrawing, getClipEnvelope, getClipEnvelopes, getClipGeometry, getDisplayTransformation, getFilter, getHDC, getHPalette, getIlluminationProps, isSuppressEvents, progress, setClipGeometry, setDisplayTransformation, setFilterByRef, setHPalette, setIlluminationProps, setSuppressEvents, setSymbol, startDrawing

Field Detail

IIDdc321087_108f_43ae_932a_dfc1f7c4529e

static final int IIDdc321087_108f_43ae_932a_dfc1f7c4529e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setHWnd

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

Associated window handle.

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

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

Associated window handle.

Returns:

The hWnd (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWindowDC

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

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

Returns:

The hDC (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addCache

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.

Returns:

The cacheID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeCache

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

Removes the specified cache.

Parameters:

cacheID - The cacheID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheCount

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

Number of screen caches.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllCaches

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

Removes all caches.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheMemDC

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

Memory device context for the specified screen cache.

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

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

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

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveCache

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

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

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsFirstCacheTransparent

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

Indicates if the bottom cache is transparent.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFirstCacheTransparent

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

Indicates if the bottom cache is transparent.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startRecording

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

Starts recording all output to the recording cache.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopRecording

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

Stops recording to the recording cache.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseScrollbars

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

Indicates if scrollbars should appear.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseScrollbars

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

Indicates if scrollbars should appear.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScrollbarHandles

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

Optionally specify application supplied scrollbars.

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

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.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isScaleContents

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.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSuppressResize

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.

Parameters:

suppressResize - The suppressResize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSuppressResize

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.

Returns:

The suppressResize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFramed

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

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

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsFramed

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

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

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCancelTracker

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

Cancel tracker that is associated with the display.

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

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

Cancel tracker that is associated with the display.

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

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

Cause the specified area of the specified cache to redraw.

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

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

Indicates if the specified cache needs refreshing.

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

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.

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

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

Scrolls the screen by the specified amount.

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

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

Interactively pans the screen.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

panStart

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

Prepares display for panning.

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

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

Pans to a new point.

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

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

Stops panning and returns new visible bounds.

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

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

Interactively rotates the screen.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rotateStart

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.

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

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

Rotates to new point.

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

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

Draws the rotated display. Call in response to WM_TIMER.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rotateStop

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

Stops rotating and returns new angle.

Returns:

The degrees

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateWindow

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

Forces a redraw.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundRGB

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.

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

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

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

Returns:

The rGB (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDrawingOffset

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

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

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

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

Clear dirty flag for specified cache.

Parameters:

cacheIndex - The cacheIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startFeedback

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.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

finishFeedback

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

Ends feedback drawing.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

frameScrolled

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

Call on frame display when container is scrolled.

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.