com.esri.arcgis.display
Class DimDisplayFilter

java.lang.Object
  extended by com.esri.arcgis.display.DimDisplayFilter
All Implemented Interfaces:
IDimDisplayFilter, IDisplayFilter, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class DimDisplayFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDimDisplayFilter, IDisplayFilter, IPersistStream, IPersist, IClone, java.io.Externalizable

COM Class 'DimDisplayFilter'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'Esri Dim Display Filter.' 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.display.IDimDisplayFilter
IID, IID673c151a_d04f_440b_80db_183395e9d83f, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayFilter
IID19f85377_1387_11d3_b89c_00600802e603
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Constructor Summary
DimDisplayFilter()
          Constructs a DimDisplayFilter using ArcGIS Engine.
DimDisplayFilter(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DimDisplayFilter theDimDisplayFilter = (DimDisplayFilter) obj;
 
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.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 int getBackgroundRGB()
          RGB value of the filter background color.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 short getDimValue()
          Dim value (0-255).
 int getFlags()
          Filter flags.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 short getOpacity()
          Opacity value (0-255).
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a DimDisplayFilter.
 void save(IStream pstm, int fClearDirty)
          save
 void setBackgroundRGB(int rGB)
          RGB value of the filter background color.
 void setDimValue(short dim)
          Dim value (0-255).
 void setFlags(int flags)
          Filter flags.
 void setOpacity(short alpha)
          Opacity value (0-255).
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

DimDisplayFilter

public DimDisplayFilter()
                 throws java.io.IOException,
                        java.net.UnknownHostException
Constructs a DimDisplayFilter using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

DimDisplayFilter

public DimDisplayFilter(java.lang.Object obj)
                 throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DimDisplayFilter theDimDisplayFilter = (DimDisplayFilter) obj;

Construct a DimDisplayFilter using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DimDisplayFilter.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a DimDisplayFilter.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setDimValue

public void setDimValue(short dim)
                 throws java.io.IOException,
                        AutomationException
Dim value (0-255).

Specified by:
setDimValue in interface IDimDisplayFilter
Parameters:
dim - The dim (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDimValue

public short getDimValue()
                  throws java.io.IOException,
                         AutomationException
Dim value (0-255).

Specified by:
getDimValue in interface IDimDisplayFilter
Returns:
The dim
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOpacity

public void setOpacity(short alpha)
                throws java.io.IOException,
                       AutomationException
Opacity value (0-255).

Specified by:
setOpacity in interface IDimDisplayFilter
Parameters:
alpha - The alpha (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOpacity

public short getOpacity()
                 throws java.io.IOException,
                        AutomationException
Opacity value (0-255).

Specified by:
getOpacity in interface IDimDisplayFilter
Returns:
The alpha
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundRGB

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

Specified by:
setBackgroundRGB in interface IDisplayFilter
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.

Specified by:
getBackgroundRGB in interface IDisplayFilter
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.

Specified by:
setFlags in interface IDisplayFilter
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.

Specified by:
getFlags in interface IDisplayFilter
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.

Specified by:
apply in interface IDisplayFilter
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.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException