java.awt
Class AlphaComposite

java.lang.Object
  extended by java.awt.AlphaComposite
All Implemented Interfaces:
Composite

public final class AlphaComposite
extends Object
implements Composite

Since:
1.3
See Also:
Composite, CompositeContext

Field Summary
static AlphaComposite Clear
           
static int CLEAR
           
static AlphaComposite Dst
           
static int DST
           
static int DST_ATOP
           
static int DST_IN
           
static int DST_OUT
           
static int DST_OVER
           
static AlphaComposite DstAtop
           
static AlphaComposite DstIn
           
static AlphaComposite DstOut
           
static AlphaComposite DstOver
           
static AlphaComposite Src
           
static int SRC
           
static int SRC_ATOP
           
static int SRC_IN
           
static int SRC_OUT
           
static int SRC_OVER
           
static AlphaComposite SrcAtop
           
static AlphaComposite SrcIn
           
static AlphaComposite SrcOut
           
static AlphaComposite SrcOver
           
static AlphaComposite Xor
           
static int XOR
           
 
Method Summary
 CompositeContext createContext(ColorModel srcColorModel, ColorModel dstColorModel, RenderingHints hints)
          Creates a CompositeContext that can be used to perform compositing operations according to this AlphaComposite settings.
 boolean equals(Object o)
          Determine whether this Object is semantically equal to another Object.
 float getAlpha()
           
static AlphaComposite getInstance(int rule)
          Creates an AlphaComposite object with the specified rule.
static AlphaComposite getInstance(int rule, float alpha)
          Creates an AlphaComposite object with the specified rule and the constant alpha to multiply with the alpha of the source.
 int getRule()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLEAR

public static final int CLEAR
See Also:
Constant Field Values

SRC

public static final int SRC
See Also:
Constant Field Values

DST

public static final int DST
See Also:
Constant Field Values

SRC_OVER

public static final int SRC_OVER
See Also:
Constant Field Values

DST_OVER

public static final int DST_OVER
See Also:
Constant Field Values

SRC_IN

public static final int SRC_IN
See Also:
Constant Field Values

DST_IN

public static final int DST_IN
See Also:
Constant Field Values

SRC_OUT

public static final int SRC_OUT
See Also:
Constant Field Values

DST_OUT

public static final int DST_OUT
See Also:
Constant Field Values

SRC_ATOP

public static final int SRC_ATOP
See Also:
Constant Field Values

DST_ATOP

public static final int DST_ATOP
See Also:
Constant Field Values

XOR

public static final int XOR
See Also:
Constant Field Values

Clear

public static final AlphaComposite Clear

Src

public static final AlphaComposite Src

Dst

public static final AlphaComposite Dst

SrcOver

public static final AlphaComposite SrcOver

DstOver

public static final AlphaComposite DstOver

SrcIn

public static final AlphaComposite SrcIn

DstIn

public static final AlphaComposite DstIn

SrcOut

public static final AlphaComposite SrcOut

DstOut

public static final AlphaComposite DstOut

SrcAtop

public static final AlphaComposite SrcAtop

DstAtop

public static final AlphaComposite DstAtop

Xor

public static final AlphaComposite Xor
Method Detail

getInstance

public static AlphaComposite getInstance(int rule)
Creates an AlphaComposite object with the specified rule.

Parameters:
rule - The compositing rule.
Throws:
IllegalArgumentException - If rule is not one of the following: CLEAR, SRC, DST, SRC_OVER, DST_OVER, SRC_IN, DST_IN, SRC_OUT, DST_OUT, SRC_ATOP, DST_ATOP, or XOR.

getInstance

public static AlphaComposite getInstance(int rule,
                                         float alpha)
Creates an AlphaComposite object with the specified rule and the constant alpha to multiply with the alpha of the source. The source is multiplied with the specified alpha before being composited with the destination.

Parameters:
rule - The compositing rule.
Throws:
IllegalArgumentException - If rule is not one of the following: CLEAR, SRC, DST, SRC_OVER, DST_OVER, SRC_IN, DST_IN, SRC_OUT, DST_OUT, SRC_ATOP, DST_ATOP, or XOR.

createContext

public CompositeContext createContext(ColorModel srcColorModel,
                                      ColorModel dstColorModel,
                                      RenderingHints hints)
Creates a CompositeContext that can be used to perform compositing operations according to this AlphaComposite settings.

Specified by:
createContext in interface Composite
Parameters:
srcColorModel - the color model of the source raster
dstColorModel - the color model of the destination raster
hints - the rendering hints to use
Returns:
a CompositeContext that can be used to perform compositing operations according to this AlphaComposite settings

getAlpha

public float getAlpha()

getRule

public int getRule()

hashCode

public int hashCode()
Description copied from class: Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in class Object
Returns:
the hash code for this Object
See Also:
Object.equals(Object), System.identityHashCode(Object)

equals

public boolean equals(Object o)
Description copied from class: Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in class Object
Parameters:
o - the Object to compare to
Returns:
whether this Object is semantically equal to another
See Also:
Object.hashCode()