com.esri.arcgis.display
Interface IDisplayFilter

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ITransparencyDisplayFilter

All Known Implementing Classes:

IDisplayFilterProxy, ITransparencyDisplayFilterProxy, TransparencyDisplayFilter

public interface IDisplayFilter

extends java.io.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

public void setBackgroundRGB(int rGB)
                      throws java.io.IOException,
                             AutomationException

RGB value of the filter background color.

Supported Platforms

Windows, Solaris, Linux

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

RGB value of the filter background color.

Supported Platforms

Windows, Solaris, Linux

Returns:

The rGB (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFlags

public void setFlags(int flags)
              throws java.io.IOException,
                     AutomationException

Filter flags. Multiple flags may be applied at the same time.

Supported Platforms

Windows, Solaris, Linux

Parameters:

flags - A com.esri.arcgis.display.esriDisplayFilterFlags constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFlags

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

Filter flags. Multiple flags may be applied at the same time.

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriDisplayFilterFlags constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

apply

public void apply(int backgroundHDC,
                  int foregroundHDC,
                  int destinationHDC,
                  int clipLeft,
                  int clipTop,
                  int clipRight,
                  int clipBottom,
                  int destinationLeft,
                  int destinationTop)
           throws java.io.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.

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:

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

AutomationException - If the ArcObject component throws an exception.