001/* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2020, by Object Refinery Limited and Contributors. 006 * 007 * Project Info: http://www.jfree.org/jfreechart/index.html 008 * 009 * This library is free software; you can redistribute it and/or modify it 010 * under the terms of the GNU Lesser General Public License as published by 011 * the Free Software Foundation; either version 2.1 of the License, or 012 * (at your option) any later version. 013 * 014 * This library is distributed in the hope that it will be useful, but 015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 017 * License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this library; if not, write to the Free Software 021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 022 * USA. 023 * 024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 025 * Other names may be trademarks of their respective owners.] 026 * 027 * --------------- 028 * EmptyBlock.java 029 * --------------- 030 * (C) Copyright 2004-2008, by Object Refinery Limited. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 * Changes: 036 * -------- 037 * 22-Oct-2004 : Version 1 (DG); 038 * 04-Feb-2005 : Now cloneable and serializable (DG); 039 * 20-Apr-2005 : Added new draw() method (DG); 040 * 08-Apr-2008 : Added support for margin and border (DG); 041 * 08-May-2008 : Updated arrange() method to recognise 042 * incoming constraint (DG); 043 * 044 */ 045 046package org.jfree.chart.block; 047 048import java.awt.Graphics2D; 049import java.awt.geom.Rectangle2D; 050import java.io.Serializable; 051import org.jfree.chart.ui.Size2D; 052import org.jfree.chart.util.PublicCloneable; 053 054/** 055 * An empty block with a fixed size. 056 */ 057public class EmptyBlock extends AbstractBlock 058 implements Block, Cloneable, PublicCloneable, Serializable { 059 060 /** For serialization. */ 061 private static final long serialVersionUID = -4083197869412648579L; 062 063 /** 064 * Creates a new block with the specified width and height. 065 * 066 * @param width the width. 067 * @param height the height. 068 */ 069 public EmptyBlock(double width, double height) { 070 setWidth(width); 071 setHeight(height); 072 } 073 074 /** 075 * Arranges the contents of the block, within the given constraints, and 076 * returns the block size. 077 * 078 * @param g2 the graphics device. 079 * @param constraint the constraint ({@code null} not permitted). 080 * 081 * @return The block size (in Java2D units, never {@code null}). 082 */ 083 @Override 084 public Size2D arrange(Graphics2D g2, RectangleConstraint constraint) { 085 Size2D base = new Size2D(calculateTotalWidth(getWidth()), 086 calculateTotalHeight(getHeight())); 087 return constraint.calculateConstrainedSize(base); 088 } 089 090 /** 091 * Draws the block. Since the block is empty, there is nothing to draw 092 * except the optional border. 093 * 094 * @param g2 the graphics device. 095 * @param area the area. 096 */ 097 @Override 098 public void draw(Graphics2D g2, Rectangle2D area) { 099 draw(g2, area, null); 100 } 101 102 /** 103 * Draws the block within the specified area. Since the block is empty, 104 * there is nothing to draw except the optional border. 105 * 106 * @param g2 the graphics device. 107 * @param area the area. 108 * @param params ignored ({@code null} permitted). 109 * 110 * @return Always {@code null}. 111 */ 112 @Override 113 public Object draw(Graphics2D g2, Rectangle2D area, Object params) { 114 area = trimMargin(area); 115 drawBorder(g2, area); 116 return null; 117 } 118 119 /** 120 * Returns a clone of the block. 121 * 122 * @return A clone. 123 * 124 * @throws CloneNotSupportedException if there is a problem cloning. 125 */ 126 @Override 127 public Object clone() throws CloneNotSupportedException { 128 return super.clone(); 129 } 130 131}