/* ===========================================================
 
* JFreeChart : a free chart library for the Java(tm) platform
 
* ===========================================================
 
*
 
* (C) Copyright 2000-2016, by Object Refinery Limited and Contributors.
 
*
 
* Project Info:
  
http://www.jfree.org/jfreechart/index.html
 
*
 
* This library is free software; you can redistribute it and/or modify it
 
* under the terms of the GNU Lesser General Public License as published by
 
* the Free Software Foundation; either version 2.1 of the License, or
 
* (at your option) any later version.
 
*
 
* This library 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 Lesser General Public
 
* License for more details.
 
*
 
* You should have received a copy of the GNU Lesser General Public
 
* License along with this library; if not, write to the Free Software
 
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  
02110-1301,
 
* USA.
 
*
 
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 
* Other names may be trademarks of their respective owners.]
 
*
 
* ---------------
 
* ColorBlock.java
 
* ---------------
 
* (C) Copyright 2004-2016, by Object Refinery Limited.
 
*
 
* Original Author:
  
David Gilbert (for Object Refinery Limited);
 
* Contributor(s):
   
-;
 
*
 
* Changes:
 
* --------
 
* 22-Oct-2004 : Version 1 (DG);
 
* 20-Apr-2005 : Added new draw() method (DG);
 
* ------------- JFREECHART 1.0.x ---------------------------------------------
 
* 16-Mar-2007 : Implemented equals() and fixed serialization (DG);
 
* 08-Apr-2008 : Added code for margin, border and padding in draw()
 
*
               
method (DG);
 
* 02-Jul-2013 : Use ParamChecks (DG);
 
*
 
*/

package org.jfree.chart.block;

import java.awt.Graphics2D;
import java.awt.Paint;
import java.awt.geom.Rectangle2D;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import org.jfree.chart.ui.Size2D;
import org.jfree.chart.util.PaintUtils;
import org.jfree.chart.util.Args;
import org.jfree.chart.util.SerialUtils;

/**
 
* A block that is filled with a single color.
 
*/
public class ColorBlock extends AbstractBlock implements Block {

    
/** For serialization. */
    
static final long serialVersionUID = 3383866145634010865L;

    
/** The paint. */
    
private transient Paint paint;

    
/**
     
* Creates a new block.
     
*
     
* @param paint
  
the paint ({@code null} not permitted).
     
* @param width
  
the width.
     
* @param height
  
the height.
     
*/

    
public ColorBlock(Paint paint, double width, double height) {
        
Args.nullNotPermitted(paint, "paint");
        
this.paint = paint;
        
setWidth(width);
        
setHeight(height);
    
}

    
/**
     
* Returns the paint.
     
*
     
* @return The paint (never {@code null}).
     
*
     
* @since 1.0.5
     
*/

    
public Paint getPaint() {
        
return this.paint;
    
}

    
/**
     
* Arranges the contents of the block, within the given constraints, and
     
* returns the block size.
     
*
     
* @param g2
  
the graphics device.
     
* @param constraint
  
the constraint ({@code null} not permitted).
     
*
     
* @return The block size (in Java2D units, never {@code null}).
     
*/

    
@Override
    
public Size2D arrange(Graphics2D g2, RectangleConstraint constraint) {
        
return new Size2D(calculateTotalWidth(getWidth()),
                
calculateTotalHeight(getHeight()));
    
}

    
/**
     
* Draws the block.
     
*
     
* @param g2
  
the graphics device.
     
* @param area
  
the area.
     
*/

    
@Override
    
public void draw(Graphics2D g2, Rectangle2D area) {
        
area = trimMargin(area);
        
drawBorder(g2, area);
        
area = trimBorder(area);
        
area = trimPadding(area);
        
g2.setPaint(this.paint);
        
g2.fill(area);
    
}

    
/**
     
* Draws the block within the specified area.
     
*
     
* @param g2
  
the graphics device.
     
* @param area
  
the area.
     
* @param params
  
ignored ({@code null} permitted).
     
*
     
* @return Always {@code null}.
     
*/

    
@Override
    
public Object draw(Graphics2D g2, Rectangle2D area, Object params) {
        
draw(g2, area);
        
return null;
    
}

    
/**
     
* Tests this block for equality with an arbitrary object.
     
*
     
* @param obj
  
the object ({@code null} permitted).
     
*
     
* @return A boolean.
     
*/

    
@Override
    
public boolean equals(Object obj) {
        
if (obj == this) {
            
return true;
        
}
        
if (!(obj instanceof ColorBlock)) {
            
return false;
        
}
        
ColorBlock that = (ColorBlock) obj;
        
if (!PaintUtils.equal(this.paint, that.paint)) {
            
return false;
        
}
        
return super.equals(obj);
    
}

    
/**
     
* Provides serialization support.
     
*
     
* @param stream
  
the output stream.
     
*
     
* @throws IOException if there is an I/O error.
     
*/

    
private void writeObject(ObjectOutputStream stream) throws IOException {
        
stream.defaultWriteObject();
        
SerialUtils.writePaint(this.paint, stream);
    
}

    
/**
     
* Provides serialization support.
     
*
     
* @param stream
  
the input stream.
     
*
     
* @throws IOException
  
if there is an I/O error.
     
* @throws ClassNotFoundException
  
if there is a classpath problem.
     
*/

    
private void readObject(ObjectInputStream stream)
        
throws IOException, ClassNotFoundException {
        
stream.defaultReadObject();
        
this.paint = SerialUtils.readPaint(stream);
    
}

}