java.awt

Class AlphaComposite

Implemented Interfaces:
Composite

public final class AlphaComposite
extends Object
implements Composite

Since:
1.3
See Also:
Composite, CompositeContext

Field Summary

static int
CLEAR
static AlphaComposite
Clear
static int
DST
static int
DST_ATOP
static int
DST_IN
static int
DST_OUT
static int
DST_OVER
static AlphaComposite
Dst
static AlphaComposite
DstAtop
static AlphaComposite
DstIn
static AlphaComposite
DstOut
static AlphaComposite
DstOver
static int
SRC
static int
SRC_ATOP
static int
SRC_IN
static int
SRC_OUT
static int
SRC_OVER
static AlphaComposite
Src
static AlphaComposite
SrcAtop
static AlphaComposite
SrcIn
static AlphaComposite
SrcOut
static AlphaComposite
SrcOver
static int
XOR
static AlphaComposite
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, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CLEAR

public static final int CLEAR
Field Value:
1

Clear

public static final AlphaComposite Clear

DST

public static final int DST
Field Value:
9

DST_ATOP

public static final int DST_ATOP
Field Value:
11

DST_IN

public static final int DST_IN
Field Value:
6

DST_OUT

public static final int DST_OUT
Field Value:
8

DST_OVER

public static final int DST_OVER
Field Value:
4

Dst

public static final AlphaComposite Dst

DstAtop

public static final AlphaComposite DstAtop

DstIn

public static final AlphaComposite DstIn

DstOut

public static final AlphaComposite DstOut

DstOver

public static final AlphaComposite DstOver

SRC

public static final int SRC
Field Value:
2

SRC_ATOP

public static final int SRC_ATOP
Field Value:
10

SRC_IN

public static final int SRC_IN
Field Value:
5

SRC_OUT

public static final int SRC_OUT
Field Value:
7

SRC_OVER

public static final int SRC_OVER
Field Value:
3

Src

public static final AlphaComposite Src

SrcAtop

public static final AlphaComposite SrcAtop

SrcIn

public static final AlphaComposite SrcIn

SrcOut

public static final AlphaComposite SrcOut

SrcOver

public static final AlphaComposite SrcOver

XOR

public static final int XOR
Field Value:
12

Xor

public static final AlphaComposite Xor

Method Details

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

equals

public boolean equals(Object o)
Determine whether this Object is semantically equal to another Object.

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

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

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 interface Object
Parameters:
Returns:
whether this Object is semantically equal to another

getAlpha

public float getAlpha()

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.

getRule

public int getRule()

hashCode

public int hashCode()
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:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

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 interface Object
Returns:
the hash code for this Object

AlphaComposite.java -- provides a context for performing alpha compositing Copyright (C) 2002, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.