View Javadoc

1   /***
2    * Redistribution  and use  in source  and binary  forms, with  or without
3    * modification, are permitted provided  that the following conditions are
4    * met :
5    *
6    * . Redistributions  of  source  code  must  retain  the  above copyright
7    *   notice, this list of conditions and the following disclaimer.
8    *
9    * . Redistributions in  binary form  must reproduce  the above  copyright
10   *   notice, this list of conditions  and the following disclaimer in  the
11   *   documentation and/or other materials provided with the distribution.
12   *
13   * . The name of the author may not be used to endorse or promote products
14   *   derived from this software without specific prior written permission.
15   *
16   * THIS SOFTWARE IS  PROVIDED BY THE  AUTHOR ``AS IS''  AND ANY EXPRESS  OR
17   * IMPLIED  WARRANTIES,  INCLUDING,  BUT   NOT  LIMITED  TO,  THE   IMPLIED
18   * WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE ARE
19   * DISCLAIMED.  IN NO  EVENT SHALL  THE AUTHOR  BE LIABLE  FOR ANY  DIRECT,
20   * INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL  DAMAGES
21   * (INCLUDING,  BUT  NOT LIMITED  TO,  PROCUREMENT OF  SUBSTITUTE  GOODS OR
22   * SERVICES;  LOSS  OF USE,  DATA,  OR PROFITS;  OR  BUSINESS INTERRUPTION)
23   * HOWEVER CAUSED  AND ON  ANY THEORY  OF LIABILITY,  WHETHER IN  CONTRACT,
24   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25   * ANY  WAY  OUT OF  THE  USE OF  THIS  SOFTWARE, EVEN  IF  ADVISED OF  THE
26   * POSSIBILITY OF SUCH DAMAGE.
27   *
28   * $Id$
29   */
30  
31  package palmed.edit.scrollbar;
32  
33  import javax.microedition.lcdui.Graphics;
34  
35  /***
36   * This interface defines a component able to draw a scrollbar.
37   *
38   * @author Mathieu Champlon
39   * @version $Revision$ $Date$
40   */
41  public interface IDrawer
42  {
43      /***
44       * Draw the body.
45       *
46       * @param g the graphics
47       * @param start the offset where to start at perpendiculary of the axis of the scrollbar
48       * @param end the offset where to end at perpendiculary of the axis of the scrollbar
49       * @param from the offset where to start at on the axis of the scrollbar
50       * @param to the offset where to end at on the axis of the scrollbar
51       */
52      void drawBody( final Graphics g, final int start, final int end, final int from, final int to );
53  
54      /***
55       * Draw an arrow.
56       *
57       * @param g the graphics
58       * @param end the offset where to end at perpendiculary of the axis of the scrollbar
59       * @param from the offset where to start at on the axis of the scrollbar
60       * @param to the offset where to end at on the axis of the scrollbar
61       */
62      void drawArrow( final Graphics g, final int end, final int from, final int to );
63  
64      /***
65       * Draw the cursor.
66       *
67       * @param g the graphics
68       * @param start the offset to start at perpendiculary of the axis of the scrollbar
69       * @param width the width of the cursor
70       * @param from the offset to start at on the axis of the scrollbar
71       * @param length the length of the cursor
72       */
73      void drawCursor( final Graphics g, final int start, final int width, final int from, final int length );
74  
75      /***
76       * Draw the background.
77       *
78       * @param g the graphics
79       * @param size the size of the scrollbar
80       * @param width the width of the scrollbar
81       */
82      void drawBackground( Graphics g, int size, int width );
83  }