com.esri.arcgis.display
Interface IScreenCacheManager

All Superinterfaces:
Serializable
All Known Implementing Classes:
ScreenDisplay

public interface IScreenCacheManager
extends Serializable

Provides access to a ScreenDisplay's caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


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.
 

Method Detail

addCache

short addCache()
               throws 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The cacheID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeCache

void removeCache(short cacheID)
                 throws IOException,
                        AutomationException
Removes the specified cache.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
cacheID - The cacheID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheCount

short getCacheCount()
                    throws IOException,
                           AutomationException
Number of screen caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAllCaches

void removeAllCaches()
                     throws IOException,
                            AutomationException
Removes all caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheMemDC

int getCacheMemDC(short index)
                  throws IOException,
                         AutomationException
Memory device context for the specified screen cache.

Product Availability

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

Parameters:
index - The index (in)
Returns:
The hDC (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActiveCache

void setActiveCache(short index)
                    throws IOException,
                           AutomationException
Screen cache where drawing occurs. Use rarely. Change cache inside StartDrawing/FinishDrawing sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveCache

short getActiveCache()
                     throws IOException,
                            AutomationException
Screen cache where drawing occurs. Use rarely. Change cache inside StartDrawing/FinishDrawing sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsFirstCacheTransparent

void setIsFirstCacheTransparent(boolean flag)
                                throws IOException,
                                       AutomationException
Indicates if the bottom cache is transparent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFirstCacheTransparent

boolean isFirstCacheTransparent()
                                throws IOException,
                                       AutomationException
Indicates if the bottom cache is transparent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheFlags

void getCacheFlags(short cacheID,
                   int[] flags)
                   throws IOException,
                          AutomationException
Get special properties of specified cache.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
cacheID - The cacheID (in)
flags - A com.esri.arcgis.display.esriDisplayCacheFlags constant (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

modifyCacheFlags

void modifyCacheFlags(short cacheID,
                      int flagsToAdd,
                      int flagsToRemove)
                      throws IOException,
                             AutomationException
Set special properties of specified cache.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
cacheID - The cacheID (in)
flagsToAdd - A com.esri.arcgis.display.esriDisplayCacheFlags constant (in)
flagsToRemove - A com.esri.arcgis.display.esriDisplayCacheFlags constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putCacheOrder

void putCacheOrder(short cacheID,
                   short order)
                   throws 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
cacheID - The cacheID (in)
order - The order (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheOrder

short getCacheOrder(short cacheID)
                    throws 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
cacheID - The cacheID (in)
Returns:
The order
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startRecording

void startRecording()
                    throws IOException,
                           AutomationException
Starts recording all output to the recording cache.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stopRecording

void stopRecording()
                   throws IOException,
                          AutomationException
Stops recording to the recording cache.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCacheDirty

boolean isCacheDirty(short cacheIndex)
                     throws IOException,
                            AutomationException
Indicates if the specified cache needs refreshing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
cacheIndex - The cacheIndex (in)
Returns:
The flag
Throws:
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 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
hDC - The hDC (A COM typedef) (in)
index - The index (in)
deviceRect - A Structure: com.esri.arcgis.display.tagRECT (in)
cacheRect - A Structure: com.esri.arcgis.display.tagRECT (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.