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   * Defines callback interface that is called when determining optimal tick
24   * position.
25   *
26   * @author <a href="mailto:ales.pucelj@cosylab.com">Ales Pucelj</a>
27   * @version $id$
28   */
29  public interface TickParameters
30  {
31  	/**
32  	 * Returns size of tick label in pixels. Size is determined as distance
33  	 * between maximum extent of the label along the tick axis.
34  	 *
35  	 * @param position relative position of the tick on 0..1.
36  	 * @param text label to display, may be empty string or null.
37  	 *
38  	 * @return size of tick in pixels.
39  	 */
40  	int measureTick(double position, String text);
41  	
42  	
43  	/**
44  	 * Formats the input value to a specific print format. If return value
45  	 * is null use internal format specified by the caller of this method.
46  	 * 
47  	 * @param value double to be formatted
48  	 * @return formatted value
49  	 */
50  	String formatNumber(double value);
51  }
52  
53  /* __oOo__ */