View Javadoc

1   /*
2    *  File: GlobalAssistantRenderer.java 
3    *  Copyright (c) 2004-2007  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.swt.renderer;
21  
22  import org.eclipse.swt.graphics.GC;
23  import org.eclipse.swt.printing.Printer;
24  
25  import de.jaret.util.ui.timebars.TimeBarViewerDelegate;
26  
27  /**
28   * Interface describing a renderer that is called to do global rendering on the timebarviewer.
29   * 
30   * @author Peter Kliem
31   * @version $Id: GlobalAssistantRenderer.java 800 2008-12-27 22:27:33Z kliem $
32   */
33  public interface GlobalAssistantRenderer {
34      /**
35       * Will be called before the interval rendering starts.
36       * 
37       * @param delegate delegate that calls
38       * @param gc GC
39       * @param printing true for printing
40       */
41      void doRenderingBeforeIntervals(TimeBarViewerDelegate delegate, GC gc, boolean printing);
42  
43      /**
44       * Will be called after the intervals have been rendered.
45       * 
46       * @param delegate delegate that calls
47       * @param gc GC
48       * @param printing true for printing
49       */
50      void doRenderingLast(TimeBarViewerDelegate delegate, GC gc, boolean printing);
51  
52      /**
53       * Dispose whatever has been allocated.
54       * 
55       */
56      void dispose();
57  
58      /**
59       * Produce a renderer for printing.
60       * 
61       * @param printer printer to use
62       * @return configured renderer for printing
63       */
64      GlobalAssistantRenderer createPrintRenderer(Printer printer);
65  
66  }