View Javadoc

1   package fr.ove.openmath.jome.ctrlview.bidim;
2   
3   import java.awt.*;
4   import fr.ove.openmath.jome.ctrlview.bidim.GraphicContext;
5   import fr.ove.openmath.jome.ctrlview.bidim.Localisable;
6   import fr.ove.openmath.jome.ctrlview.bidim.Sizable;
7   
8   /***
9   * An implementation of the <CODE>Displayable</CODE> interface.<BR>
10  *
11  * @author © 1999 DIRAT Laurent
12  * @version 2.0 29/06/1999
13  */
14  public interface Displayable extends Localisable, Sizable {
15      /***
16      * Sets the ascent.
17      * @param ascent the new ascent value.
18      */
19      public void setAscent(int ascent);
20      
21      /***
22      * Returns the ascent.
23      * @return the ascent.
24      */
25      public int getAscent();
26      
27      /***
28      * Sets the descent.
29      * @param descent the new descent value.
30      */
31      public void setDescent(int descent);
32      
33      /***
34      * Returns the descent.
35      * @return the descent.
36      */
37      public int getDescent();
38      
39      /***
40      * Sets the horizontal shift.
41      * @param shift the new horizontal shift value.
42      */
43      public void setShiftX(int shiftX);
44      
45      /***
46      * Returns the horizontal shift.
47      * @return the horizontal shift.
48      */
49      public int getShiftX();
50      
51      /***
52      * Sets the vertical shift.
53      * @param shiftY the new vertical shift value.
54      */
55      public void setShiftY(int shiftY);
56      
57      /***
58      * Returns the vertical shift.
59      * @return the vertical shift.
60      */
61      public int getShiftY();
62      
63      /***
64      * Sets all the attributes.
65      * @param ascent the new ascent value.
66      * @param descent the new descent value.
67      * @param shiftX the new horizontal shift value.
68      * @param shiftY the new vertical shift value.
69      */
70      public void setAttributes(int ascent, int descent, int shiftX, int shiftY);
71          
72      /***
73      * Sets the graphic context of the instance.
74      * @param graphicContext the graphic context.
75      */
76      public void setGraphicContext(GraphicContext graphicContext);
77      
78      /***
79      * Returns the graphic context of the instance.
80      */
81      public GraphicContext getGraphicContext();
82      
83      /***
84      * The paint method of the object to display.
85      * @param g the drawing area of the symbol.
86      */
87      public void paint(Graphics g);
88  }