View Javadoc

1   package fr.ove.openmath.jome.model.processor;
2   
3   import java.util.Vector;
4   
5   /***
6   * The interface to implement to be a width processor.<BR>
7   * A width processor manages to display a certain amount of children (the view)
8   * of an element whose number of children (the width) is greater than a specified level.
9   *
10  * @author © 2000 DIRAT Laurent
11  * @version 1.0  21/08/2000
12  */
13  public interface WidthProcessorInterface extends Processor {
14      /***
15      * Sets the width level form which the processing will be considering.<BR>
16      * For convenience only, in most cases this method is equivalent to the
17      * @see setLevel of the @see Processor interface.
18      * @param widthLevel the width level.
19      */
20      public void setWidthLevel(int widthLevel);
21      
22      /***
23      * Returns the width level form which the processing will be considering.<BR>
24      * For convenience only, in most cases this method is equivalent to the
25      * @see getLevel of the @see Processor interface.
26      */
27      public int getWidthLevel();
28      
29      /***
30      * Sets the number of children viewed.
31      * @param the number of children viewed.
32      */
33      public void setView(int view);
34      
35      /***
36      * Returns the number of children viewed.
37      */
38      public int getView();
39      
40      /***
41      * Returns the list of widths calculated.
42      */
43      public Vector getWidthList();
44      
45      /***
46      * Returns the biggest width calculated.
47      */
48      public int getBiggestWidth();
49  }