View Javadoc

1   package fr.ove.openmath.jome.behaviour;
2   
3   /***
4   * The interface to implement if we want selection abilities.
5   *
6   * @author © 1999 DIRAT Laurent
7   * @version 2.0 29/06/1999
8   */
9   public interface Selectable {
10      /***
11      * Selects the instance.<BR>
12      * In the case of an instance composed by different elements (for example trees), this 
13      * method is recursive, and then selects the different elements.
14      */
15      public void select();
16      
17      /***
18      * Marks the instance as selected.
19      */
20      public void setSelected();
21      
22      /***
23      * Deselects the instance.<BR>
24      * In the case of an instance composed by different elements (for example trees), this 
25      * method is recursive, and then deselects the different elements.
26      */
27      public void deselect();
28      
29      /***
30      * Marks the instance as not selected.
31      */
32      public void setNotSelected();
33      
34      /***
35      * Checks if the instance is selected.
36      * @returns <CODE>true</CODE> if the instance is selected. <CODE>false</CODE>
37      * otherwise.
38      */
39      public boolean isSelected();
40      
41      /***
42      * In the case of an instance composed by different elements (for example trees), this 
43      * method checks if there are some selected elements.
44      * @returns <CODE>true</CODE> if the instance has selected elements. <CODE>false</CODE>
45      * otherwise.
46      */
47      public boolean gotSelectedElements();
48  }