001/* Paint.java -- generate colors for Graphics2D operations
002   Copyright (C) 2000, 2002 Free Software Foundation
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt;
040
041import java.awt.geom.AffineTransform;
042import java.awt.geom.Rectangle2D;
043import java.awt.image.ColorModel;
044
045/**
046 * Defines how color patterns are generated for Graphics2D operations. This
047 * is used to perform the <code>draw</code> and <code>fill</code> methods
048 * of the graphics object. Instances must be immutable, because the graphics
049 * object does not clone them.
050 *
051 * @author Warren Levy (warrenl@cygnus.com)
052 * @see PaintContext
053 * @see Color
054 * @see GradientPaint
055 * @see TexturePaint
056 * @see Graphics2D#setPaint(Paint)
057 * @since 1.1
058 * @status updated to 1.4
059 */
060public interface Paint extends Transparency
061{
062  /**
063   * Create the context necessary for performing the color pattern generation.
064   * The color model is a hint, and may be null for Classpath implementations;
065   * however some legacy code may throw a NullPointerException when passed a
066   * null. Leaving the color model null provides the most efficiency and leeway
067   * in the generation of the color pattern.
068   *
069   * @param cm the color model, used as a hint
070   * @param deviceBounds the device space bounding box of the painted area
071   * @param userBounds the user space bounding box of the painted area
072   * @param xform the transformation from user space to device space
073   * @param hints any hints for choosing between rendering alternatives
074   * @return the context for performing the paint
075   */
076  PaintContext createContext(ColorModel cm, Rectangle deviceBounds,
077                             Rectangle2D userBounds, AffineTransform xform,
078                             RenderingHints hints);
079} // interface Paint