Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

Source code: javax/ide/property/spi/PropertyPageInfo.java


1   package javax.ide.property.spi;
2   
3   import javax.ide.util.MetaClass;
4   
5   /**
6    * Record of information describing a property page and the object class
7    * whose properties are edited using this page.
8    */
9   public final class PropertyPageInfo 
10  {
11    private String _label;
12    private MetaClass _pageClass;
13    private String _objectClass;
14  
15    /**
16     * Constructor.
17     */
18    public PropertyPageInfo() 
19    {
20    }
21  
22    /**
23     * Get the property page label. This label is generally displayed to the 
24     * user.
25     * @return The page label.
26     */
27    public String getLabel()
28    {
29      return _label;
30    }
31  
32    /**
33     * Set the property page label. This label is generally displayed to the 
34     * user.
35     * @param label The page label.
36     */
37    public void setLabel( String label )
38    {
39      _label = label;
40    }
41    /**
42     * Get the {@link MetaClass} for this page.
43     * @return The page meta class.
44     */
45    public MetaClass getPageClass()
46    {
47      return _pageClass;
48    }
49  
50    /**
51     * Set the {@link MetaClass} for this page.
52     * @param pageClass The page meta class.
53     */
54    public void setPageClass( MetaClass pageClass )
55    {
56      _pageClass = pageClass;
57    }
58  
59    /**
60     * Get the object {@link MetaClass} for this page.  The EDK defines 
61     * two acceptable classes: javax.ide.model.Project and javax.ide.IDE for 
62     * adding property pages to the project and the IDE preferences, respectively.
63     *
64     * @return The object meta class. The object meta class is the class of 
65     * the object for which this page is used to edit its properties.
66     */
67    public String getObjectClass()
68    {
69      return _objectClass;
70    }
71  
72    /**
73     * Set the object {@link MetaClass} for this page.
74     * @param objectClass The object meta class. The object meta class is the class of 
75     * the object for which this page is used to edit its properties.
76     */
77    public void setObjectClass( String objectClass )
78    {
79      _objectClass = objectClass;
80    }
81  }