Source code: javax/ide/wizard/spi/WizardInfo.java
1 package javax.ide.wizard.spi;
2
3 import javax.ide.util.IconDescription;
4 import javax.ide.util.MetaClass;
5
6 /**
7 * Record of information identifying a wizard type. The information used
8 * to initialize this class comes from an Extension Deployment Descriptor
9 * (EDD).<p>
10 *
11 * The information kept in this class includes the wizard label,
12 * icon, and brief description that can be displayed to the user.
13 */
14 public final class WizardInfo
15 {
16 private String _label;
17 private IconDescription _icon;
18 private String _toolTip;
19 private final MetaClass _class;
20
21 /**
22 * Constructor.
23 */
24 public WizardInfo( MetaClass wizardClass )
25 {
26 _class = wizardClass;
27 }
28
29 public MetaClass getWizardClass()
30 {
31 return _class;
32 }
33
34
35 /**
36 * Get a localizable label describing the wizard. This label is for user
37 * display.
38 * @return a label describing this class.
39 */
40 public String getLabel()
41 {
42 return _label;
43 }
44
45 /**
46 * Set a localizable label describing the wizard. This label is for user
47 * display.
48 * @param label label describing this wizard.
49 */
50 void setLabel( String label )
51 {
52 _label = label;
53 }
54
55 /**
56 * Get a localizable icon path that can be used to graphically
57 * represent what this wizard creates.
58 * @return the icon path to an image for user display.
59 */
60 public IconDescription getIcon()
61 {
62 return _icon;
63 }
64
65 /**
66 * Set a localizable icon path that can be used to graphically
67 * represent what this wizard creates.
68 * @param iconPath the icon path to an image for user display.
69 */
70 void setIcon( IconDescription icon )
71 {
72 _icon = icon;
73 }
74
75 /**
76 * Get a description of what this wizard does. This descriptions is for
77 * user display.
78 * @return a description of the wizard.
79 */
80 public String getToolTip()
81 {
82 return _toolTip;
83 }
84
85 /**
86 * Set a description of what this wizard does. This descriptions is for
87 * user display.
88 * @param toolTip a description of the wizard.
89 */
90 void setToolTip( String toolTip )
91 {
92 _toolTip = toolTip;
93 }
94 }