com.esri.arcgis.display
Interface IDisplayFilter

All Superinterfaces:
Serializable
All Known Subinterfaces:
ITransparencyDisplayFilter
All Known Implementing Classes:
TransparencyDisplayFilter

public interface IDisplayFilter
extends Serializable

Provides access to members that control the display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void apply(int backgroundHDC, int foregroundHDC, int destinationHDC, int clipLeft, int clipTop, int clipRight, int clipBottom, int destinationLeft, int destinationTop)
          Takes the latest drawing found in the foreground bitmap and applies it to the background bitmap, sending the results to the destination bitmap.
 int getBackgroundRGB()
          RGB value of the filter background color.
 int getFlags()
          Filter flags.
 void setBackgroundRGB(int rGB)
          RGB value of the filter background color.
 void setFlags(int flags)
          Filter flags.
 

Method Detail

setBackgroundRGB

void setBackgroundRGB(int rGB)
                      throws IOException,
                             AutomationException
RGB value of the filter background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBackgroundRGB

int getBackgroundRGB()
                     throws IOException,
                            AutomationException
RGB value of the filter background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFlags

void setFlags(int flags)
              throws IOException,
                     AutomationException
Filter flags. Multiple flags may be applied at the same time.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flags - A com.esri.arcgis.display.esriDisplayFilterFlags constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFlags

int getFlags()
             throws IOException,
                    AutomationException
Filter flags. Multiple flags may be applied at the same time.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.display.esriDisplayFilterFlags constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

void apply(int backgroundHDC,
           int foregroundHDC,
           int destinationHDC,
           int clipLeft,
           int clipTop,
           int clipRight,
           int clipBottom,
           int destinationLeft,
           int destinationTop)
           throws IOException,
                  AutomationException
Takes the latest drawing found in the foreground bitmap and applies it to the background bitmap, sending the results to the destination bitmap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
backgroundHDC - The backgroundHDC (A COM typedef) (in)
foregroundHDC - The foregroundHDC (A COM typedef) (in)
destinationHDC - The destinationHDC (A COM typedef) (in)
clipLeft - The clipLeft (in)
clipTop - The clipTop (in)
clipRight - The clipRight (in)
clipBottom - The clipBottom (in)
destinationLeft - The destinationLeft (in)
destinationTop - The destinationTop (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.