View Javadoc

1   /*
2    *  File: IMarkerRenderer.java 
3    *  Copyright (c) 2004-2009  Peter Kliem (Peter.Kliem@jaret.de)
4    *  A commercial license is available, see http://www.jaret.de.
5    *
6    *  This program 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 2 of the License, or
9    *  (at your option) any later version.
10   *
11   *  This program 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 this program; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package de.jaret.util.ui.timebars.swing.renderer;
21  
22  import java.awt.Graphics;
23  
24  import de.jaret.util.ui.timebars.TimeBarMarker;
25  import de.jaret.util.ui.timebars.TimeBarViewerDelegate;
26  
27  /**
28   * Interface describing a marker renderer.
29   * 
30   * @author kliem
31   * @version $Id: IMarkerRenderer.java 839 2009-02-15 19:51:37Z kliem $
32   */
33  public interface IMarkerRenderer {
34      /**
35       * Draw a marker.
36       * 
37       * @param delegate the delegate
38       * @param graphics the GRaphics to draw with
39       * @param marker the marker to draw
40       * @param x the x coordinate of the marker
41       * @param isDragged true if the markeris currently beeing dragged
42       */
43      void renderMarker(TimeBarViewerDelegate delegate, Graphics graphics, TimeBarMarker marker, int x, boolean isDragged);
44  
45      /**
46       * Retrieve the width of a specific marker.
47       * 
48       * @param marker the marker
49       * @return the width in pixel
50       */
51      int getMarkerWidth(TimeBarMarker marker);
52  
53  }