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 * AxisState.java 029 * -------------- 030 * (C) Copyright 2003-2008, by Object Refinery Limited and Contributors. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 * Changes 036 * ------- 037 * 03-Nov-2003 : Added standard header (DG); 038 * 07-Nov-2003 : Added 'max' attribute (DG); 039 * 040 */ 041 042package org.jfree.chart.axis; 043 044import java.util.List; 045import org.jfree.chart.ui.RectangleEdge; 046 047/** 048 * Instances of this class are used to carry state information for an axis 049 * during the drawing process. By retaining this information in a separate 050 * object, it is possible for multiple threads to draw the same axis to 051 * different output targets (each drawing will maintain separate state 052 * information). 053 */ 054public class AxisState { 055 056 /** The cursor position. */ 057 private double cursor; 058 059 /** The axis ticks. */ 060 private List ticks; 061 062 /** The maximum width/height. */ 063 private double max; 064 065 /** 066 * Creates a new axis state. 067 */ 068 public AxisState() { 069 this(0.0); 070 } 071 072 /** 073 * Creates a new axis state. 074 * 075 * @param cursor the cursor. 076 */ 077 public AxisState(double cursor) { 078 this.cursor = cursor; 079 this.ticks = new java.util.ArrayList(); 080 } 081 082 /** 083 * Returns the cursor position. 084 * 085 * @return The cursor position. 086 */ 087 public double getCursor() { 088 return this.cursor; 089 } 090 091 /** 092 * Sets the cursor position. 093 * 094 * @param cursor the cursor position. 095 */ 096 public void setCursor(double cursor) { 097 this.cursor = cursor; 098 } 099 100 /** 101 * Moves the cursor outwards by the specified number of units. 102 * 103 * @param units the units. 104 * @param edge the edge. 105 */ 106 public void moveCursor(double units, RectangleEdge edge) { 107 if (edge == RectangleEdge.TOP) { 108 cursorUp(units); 109 } 110 else if (edge == RectangleEdge.BOTTOM) { 111 cursorDown(units); 112 } 113 else if (edge == RectangleEdge.LEFT) { 114 cursorLeft(units); 115 } 116 else if (edge == RectangleEdge.RIGHT) { 117 cursorRight(units); 118 } 119 } 120 121 /** 122 * Moves the cursor up by the specified number of Java 2D units. 123 * 124 * @param units the units. 125 */ 126 public void cursorUp(double units) { 127 this.cursor = this.cursor - units; 128 } 129 130 /** 131 * Moves the cursor down by the specified number of Java 2D units. 132 * 133 * @param units the units. 134 */ 135 public void cursorDown(double units) { 136 this.cursor = this.cursor + units; 137 } 138 139 /** 140 * Moves the cursor left by the specified number of Java 2D units. 141 * 142 * @param units the units. 143 */ 144 public void cursorLeft(double units) { 145 this.cursor = this.cursor - units; 146 } 147 148 /** 149 * Moves the cursor right by the specified number of Java 2D units. 150 * 151 * @param units the units. 152 */ 153 public void cursorRight(double units) { 154 this.cursor = this.cursor + units; 155 } 156 157 /** 158 * Returns the list of ticks. 159 * 160 * @return The list of ticks. 161 */ 162 public List getTicks() { 163 return this.ticks; 164 } 165 166 /** 167 * Sets the list of ticks. 168 * 169 * @param ticks the ticks. 170 */ 171 public void setTicks(List ticks) { 172 this.ticks = ticks; 173 } 174 175 /** 176 * Returns the maximum width/height. 177 * 178 * @return The maximum width/height. 179 */ 180 public double getMax() { 181 return this.max; 182 } 183 184 /** 185 * Sets the maximum width/height. 186 * 187 * @param max the maximum width/height. 188 */ 189 public void setMax(double max) { 190 this.max = max; 191 } 192}