com.esri.arcgis.display
Interface IScreenCacheManager

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IScreenCacheManagerProxy, ScreenDisplay

public interface IScreenCacheManager
extends java.io.Serializable

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

Description: 'Provides access to a ScreenDisplay's caches.' 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	IID7b3572f2_57a7_46b3_af86_9c9bca1c8f15
static int	xxDummy Deprecated. Internal use only

Method Summary

short	addCache() Creates a new cache and return its ID.
void	drawCache(int hDC, short index, tagRECT deviceRect, tagRECT cacheRect) Draws the specified screen cache to the specified window device context.
short	getActiveCache() Screen cache where drawing occurs.
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.
boolean	isCacheDirty(short cacheIndex) Indicates if the specified cache needs refreshing.
boolean	isFirstCacheTransparent() Indicates if the bottom cache is transparent.
void	modifyCacheFlags(short cacheID, int flagsToAdd, int flagsToRemove) Set special properties of specified cache.
void	putCacheOrder(short cacheID, short order) Sets or returns the order of the specified cache.
void	removeAllCaches() Removes all caches.
void	removeCache(short cacheID) Removes the specified cache.
void	setActiveCache(short index) Screen cache where drawing occurs.
void	setIsFirstCacheTransparent(boolean flag) Indicates if the bottom cache is transparent.
void	startRecording() Starts recording all output to the recording cache.
void	stopRecording() Stops recording to the recording cache.

Field Detail

IID7b3572f2_57a7_46b3_af86_9c9bca1c8f15

static final int IID7b3572f2_57a7_46b3_af86_9c9bca1c8f15

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

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.

getCacheFlags

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

Get special properties of specified cache.

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

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

Set special properties of specified cache.

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

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.

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

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.

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.

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.

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.