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 * Block.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 * 08-Feb-2005 : Added ID (DG);
039 * 20-Apr-2005 : Added a new draw() method that can accept params
040 *               and return results (DG);
041 *
042 */
043
044package org.jfree.chart.block;
045
046import java.awt.Graphics2D;
047import java.awt.geom.Rectangle2D;
048import org.jfree.chart.ui.Drawable;
049import org.jfree.chart.ui.Size2D;
050
051/**
052 * A block is an arbitrary item that can be drawn (in Java2D space) within a
053 * rectangular area, has a preferred size, and can be arranged by an
054 * {@link Arrangement} manager.
055 */
056public interface Block extends Drawable {
057
058    /**
059     * Returns an ID for the block.
060     *
061     * @return An ID.
062     */
063    public String getID();
064
065    /**
066     * Sets the ID for the block.
067     *
068     * @param id  the ID.
069     */
070    public void setID(String id);
071
072    /**
073     * Arranges the contents of the block, with no constraints, and returns
074     * the block size.
075     *
076     * @param g2  the graphics device.
077     *
078     * @return The size of the block.
079     */
080    public Size2D arrange(Graphics2D g2);
081
082    /**
083     * Arranges the contents of the block, within the given constraints, and
084     * returns the block size.
085     *
086     * @param g2  the graphics device.
087     * @param constraint  the constraint ({@code null} not permitted).
088     *
089     * @return The block size (in Java2D units, never {@code null}).
090     */
091    public Size2D arrange(Graphics2D g2, RectangleConstraint constraint);
092
093    /**
094     * Returns the current bounds of the block.
095     *
096     * @return The bounds.
097     */
098    public Rectangle2D getBounds();
099
100    /**
101     * Sets the bounds of the block.
102     *
103     * @param bounds  the bounds.
104     */
105    public void setBounds(Rectangle2D bounds);
106
107    /**
108     * Draws the block within the specified area.  Refer to the documentation
109     * for the implementing class for information about the {@code params}
110     * and return value supported.
111     *
112     * @param g2  the graphics device.
113     * @param area  the area.
114     * @param params  optional parameters ({@code null} permitted).
115     *
116     * @return An optional return value (possibly {@code null}).
117     */
118    public Object draw(Graphics2D g2, Rectangle2D area, Object params);
119
120}