View Javadoc

1   /*
2    * Copyright (c) 2003-2008 by Cosylab d. d.
3    *
4    * This file is part of CosyBeans-Common.
5    *
6    * CosyBeans-Common is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation, either version 3 of the License, or
9    * (at your option) any later version.
10   *
11   * CosyBeans-Common is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with CosyBeans-Common.  If not, see <http://www.gnu.org/licenses/>.
18   */
19  
20  package com.cosylab.gui.components.range2;
21  
22  /**
23   * TickCalculator calculates ticks for the displayer. The returned Ticks 
24   * should be ready to be drawn on the displayer.
25   *   
26   * @author <a href="mailto:jaka.bobnar@cosylab.com">Jaka Bobnar</a>
27   * @version $Id: TickCalculator.java,v 1.3 2008-04-22 12:28:40 jbobnar Exp $
28   *
29   */
30  public interface TickCalculator {
31  
32  	/**
33  	 * Calculates ticks using some default TickParameters.
34  	 * 
35  	 * @param length the available space for ticks in the displayer
36  	 * @param range range which provides transformation to absolute/relative values
37  	 * @param rangedValue the value bounds
38  	 * @return
39  	 */
40  	Tick[] calculateTicks(int length, Range range, RangedValue rangedValue);
41  	
42  	/**
43  	 * Calculates ticks using the given TickParameters.
44  	 * 
45  	 * @param length the available space for ticks in the displayer
46  	 * @param measurer TickParameters used to measure ticks
47  	 * @param range range which provides transformation to absolute/relative values
48  	 * @param rangedValue the value bounds
49  	 * @return
50  	 */
51  	Tick[] calculateTicks(int length, TickParameters measurer, Range range, RangedValue rangedValue);
52  }