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: IFont.java 395 2005-12-31 04:05:41Z mat007 $
29   */
30  
31  package palmed.edit;
32  
33  import javax.microedition.lcdui.Graphics;
34  
35  /***
36   * This class defines a custom monospaced font.
37   *
38   * @author Mathieu Champlon
39   * @version $Revision: 395 $ $Date: 2005-12-31 13:05:41 +0900 (sam., 31 déc. 2005) $
40   */
41  public interface IFont
42  {
43      /***
44       * Retrieve the width of a character.
45       *
46       * @return character width in pixels
47       */
48      int getWidth();
49  
50      /***
51       * Retrieve the height of a character.
52       *
53       * @return character height in pixels
54       */
55      int getHeight();
56  
57      /***
58       * Draw the given characters.
59       * <p>
60       * The character at the end position should not be drawn.
61       *
62       * @param g the graphics to use
63       * @param text the text to draw a subpart of
64       * @param start the start position in the text
65       * @param end the end position in the text
66       * @param y the line number to draw the text at
67       */
68      void draw( Graphics g, String text, int start, int end, int y );
69  
70      /***
71       * Draw the given characters as selection.
72       * <p>
73       * The character at the end position should not be drawn.
74       *
75       * @param g the graphics to use
76       * @param text the text to draw a subpart of
77       * @param start the start position in the text
78       * @param end the end position in the text
79       * @param y the line number to draw the text at
80       */
81      void drawSelection( Graphics g, String text, int start, int end, int y );
82  
83      /***
84       * Draw the given number of spaces as selection.
85       * <p>
86       * The character at the end position should not be drawn.
87       *
88       * @param g the graphics to use
89       * @param start the start position in the text
90       * @param end the end position in the text
91       * @param y the line number to draw the text at
92       */
93      void drawEmptySelection( Graphics g, int start, int end, int y );
94  }