/*

   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

 */
package org.apache.batik.gvt;

import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.Shape;
import java.awt.geom.Rectangle2D;
import java.awt.geom.Point2D;

A shape painter that can be used to fill a shape.
Author:
Thierry Kormann
Version:
$Id: FillShapePainter.java 1733416 2016-03-03 07:07:13Z gadams $/**
 * A shape painter that can be used to fill a shape.
 *
 * @author <a href="mailto:Thierry.Kormann@sophia.inria.fr">Thierry Kormann</a>
 * @version $Id: FillShapePainter.java 1733416 2016-03-03 07:07:13Z gadams $
 */
public class FillShapePainter implements ShapePainter {

    
The Shape to be painted.
/** 
     * The Shape to be painted.
     */
    protected Shape shape;

    
The paint attribute used to fill the shape.
/** 
     * The paint attribute used to fill the shape.
     */
    protected Paint paint;

    
Constructs a new FillShapePainter that can be used to fill
a Shape.
Params:
shape – Shape to be painted by this painter
Should not be null./**
     * Constructs a new <code>FillShapePainter</code> that can be used to fill
     * a <code>Shape</code>.
     *
     * @param shape Shape to be painted by this painter
     * Should not be null.  
     */
    public FillShapePainter(Shape shape) {
        if (shape == null)
            throw new IllegalArgumentException("Shape can not be null!");

        this.shape = shape;
    }

    
Sets the paint used to fill a shape.
Params:
newPaint – the paint object used to fill the shape/**
     * Sets the paint used to fill a shape.
     *
     * @param newPaint the paint object used to fill the shape
     */
    public void setPaint(Paint newPaint) {
        this.paint = newPaint;
    }

    
Gets the paint used to draw the outline of the shape.
/**
     * Gets the paint used to draw the outline of the shape.
     */
    public Paint getPaint() {
        return paint;
    }

    
Paints the specified shape using the specified Graphics2D.
Params:
g2d – the Graphics2D to use/**
     * Paints the specified shape using the specified Graphics2D.
     *
     * @param g2d the Graphics2D to use
     */
    public void paint(Graphics2D g2d) {
        if (paint != null) {
            g2d.setPaint(paint);
            g2d.fill(shape);
        }
    }

    
Returns the area painted by this shape painter.
/**
     * Returns the area painted by this shape painter.
     */
    public Shape getPaintedArea(){
        if (paint == null)
            return null;
        return shape;
    }

    
Returns the bounds of the area painted by this shape painter
/**
     * Returns the bounds of the area painted by this shape painter
     */
    public Rectangle2D getPaintedBounds2D(){
        if ((paint == null) || (shape == null))
            return  null;

        return shape.getBounds2D();
    }

    
Returns true if pt is in the area painted by this shape painter
/**
     * Returns true if pt is in the area painted by this shape painter
     */
    public boolean inPaintedArea(Point2D pt){
        if ((paint == null) || (shape == null))
            return  false;

        return shape.contains(pt);
    }

    
Returns the area covered by this shape painter (even if not painted).
/**
     * Returns the area covered by this shape painter (even if not painted).
     * 
     */
    public Shape getSensitiveArea(){
        return shape;
    }

    
Returns the bounds of the area covered by this shape painte
(even if not painted).
/**
     * Returns the bounds of the area covered by this shape painte
     * (even if not painted).
     */
    public Rectangle2D getSensitiveBounds2D() {
        if (shape == null)
            return  null;
        return shape.getBounds2D();
    }

    
Returns true if pt is in the area painted by this shape painter
/**
     * Returns true if pt is in the area painted by this shape painter
     */
    public boolean inSensitiveArea(Point2D pt){
        if (shape == null)
            return  false;
        return shape.contains(pt);
    }

    
Sets the Shape this shape painter is associated with.
Params:
shape – new shape this painter should be associated with.
Should not be null./**
     * Sets the Shape this shape painter is associated with.
     *
     * @param shape new shape this painter should be associated with.
     * Should not be null.  
     */
    public void setShape(Shape shape){
        if (shape == null) {
            throw new IllegalArgumentException();
        }
        this.shape = shape;
    }

    
Gets the Shape this shape painter is associated with.
Returns:
shape associated with this Painter./**
     * Gets the Shape this shape painter is associated with.
     *
     * @return shape associated with this Painter.
     */
    public Shape getShape(){
        return shape;
    }
}