Source for org.jfree.chart.block.BlockParams

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * ----------------
  28:  * BlockParams.java
  29:  * ----------------
  30:  * (C) Copyright 2005, 2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes:
  36:  * --------
  37:  * 19-Apr-2005 : Version 1 (DG);
  38:  *
  39:  */
  40: 
  41: package org.jfree.chart.block;
  42: 
  43: /**
  44:  * A standard parameter object that can be passed to the draw() method defined
  45:  * by the {@link Block} class.
  46:  */
  47: public class BlockParams implements EntityBlockParams {
  48:     
  49:     /** 
  50:      * A flag that controls whether or not the block should generate and 
  51:      * return chart entities for the items it draws.
  52:      */
  53:     private boolean generateEntities;
  54:     
  55:     /** 
  56:      * The x-translation (used to enable chart entities to use global 
  57:      * coordinates rather than coordinates that are local to the container
  58:      * they are within).
  59:      */
  60:     private double translateX;
  61:     
  62:     /** 
  63:      * The y-translation (used to enable chart entities to use global 
  64:      * coordinates rather than coordinates that are local to the container
  65:      * they are within).
  66:      */
  67:     private double translateY;
  68:     
  69:     /**
  70:      * Creates a new instance.
  71:      */
  72:     public BlockParams() {
  73:         this.translateX = 0.0;
  74:         this.translateY = 0.0;
  75:         this.generateEntities = false;    
  76:     }
  77:     
  78:     /**
  79:      * Returns the flag that controls whether or not chart entities are 
  80:      * generated.
  81:      * 
  82:      * @return A boolean.
  83:      */
  84:     public boolean getGenerateEntities() {
  85:         return this.generateEntities;   
  86:     }
  87:     
  88:     /**
  89:      * Sets the flag that controls whether or not chart entities are generated.
  90:      * 
  91:      * @param generate  the flag.
  92:      */
  93:     public void setGenerateEntities(boolean generate) {
  94:         this.generateEntities = generate;   
  95:     }
  96:     
  97:     /**
  98:      * Returns the translation required to convert local x-coordinates back to
  99:      * the coordinate space of the container.
 100:      * 
 101:      * @return The x-translation amount.
 102:      */
 103:     public double getTranslateX() {
 104:         return this.translateX;   
 105:     }
 106:     
 107:     /**
 108:      * Sets the translation required to convert local x-coordinates into the
 109:      * coordinate space of the container.
 110:      * 
 111:      * @param x  the x-translation amount.
 112:      */
 113:     public void setTranslateX(double x) {
 114:         this.translateX = x;   
 115:     }
 116:     
 117:     /**
 118:      * Returns the translation required to convert local y-coordinates back to
 119:      * the coordinate space of the container.
 120:      * 
 121:      * @return The y-translation amount.
 122:      */
 123:     public double getTranslateY() {
 124:         return this.translateY;   
 125:     }
 126:     
 127:     /**
 128:      * Sets the translation required to convert local y-coordinates into the
 129:      * coordinate space of the container.
 130:      * 
 131:      * @param y  the y-translation amount.
 132:      */
 133:     public void setTranslateY(double y) {
 134:         this.translateY = y;   
 135:     }
 136: 
 137: }