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