1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
package com.vaadin.demo.sampler;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Serializable;
import com.vaadin.ui.Component;
/**
* Represents one feature or sample, with associated example.
* <p>
*
* </p>
*
*/
@SuppressWarnings("serial")
abstract public class Feature implements Serializable {
public static final Object PROPERTY_ICON = "Icon";
public static final Object PROPERTY_NAME = "Name";
public static final Object PROPERTY_DESCRIPTION = "Description";
private static final String MSG_SOURCE_NOT_AVAILABLE = "I'm terribly sorry,"
+ " but it seems the source could not be found.\n"
+ "Please try adding the source folder to the classpath for your"
+ " server, or tell the administrator to do so!";
private static final Object MUTEX = new Object();
private String javaSource = null;
/**
* Gets the name of this feature. Try not to exceed 25 characters too much.
*
* @return
*/
abstract public String getName();
/**
* Gets the description for this feature. Should describe what the example
* intends to showcase. May contain HTML. 100 words should be enough, and
* about 7 rows...
*
* @return the description
*/
abstract public String getDescription();
/**
* Gets related resources, i.e links to resources related to the example.
* <p>
* Good candidates are resources used to make the example (CSS, images,
* custom layouts), documentation links (reference manual), articles (e.g.
* pattern description, usability discussion).
* </p>
* <p>
* May return null, if the example has no related resources.
* </p>
* <p>
* The name of the NamedExternalResource will be shown in the UI. <br/>
* Note that Javadoc should be referenced via {@link #getRelatedAPI()}.
* </p>
*
* @see #getThemeBase()
* @return related external stuff
*/
abstract public NamedExternalResource[] getRelatedResources();
/**
* Gets related API resources, i.e links to javadoc of used classes.
* <p>
* Good candidates are Vaadin classes being demoed in the example, or other
* classes playing an important role in the example.
* </p>
* <p>
* May return null, if the example uses no interesting classes.
* <p>
*
* @return
*/
abstract public APIResource[] getRelatedAPI();
/**
* Gets related Features; the classes returned should extend Feature.
* <p>
* Good candidates are Features similar to this one, Features using the
* functionality demoed in this one, and Features being used in this one.
* </p>
* <p>
* May return null, if no other Features are related to this one.
* <p>
*
* @return
*/
abstract public Class[] getRelatedFeatures();
/**
* Gets the name of the icon for this feature, usually simpleName +
* extension.
*
* @return
*/
public String getIconName() {
String icon = getClass().getSimpleName() + ".png";
return icon;
}
/**
* Get the example instance. Override if instantiation needs parameters.
*
* @return
*/
public Component getExample() {
String className = this.getClass().getName() + "Example";
try {
Class<?> classObject = getClass().getClassLoader().loadClass(
className);
return (Component) classObject.newInstance();
} catch (ClassNotFoundException e) {
return null;
} catch (InstantiationException e) {
return null;
} catch (IllegalAccessException e) {
return null;
}
}
public String getSource() {
synchronized (MUTEX) {
if (javaSource == null) {
StringBuffer src = new StringBuffer();
try {
/*
* Use package name + class name so the class loader won't
* have to guess the package name.
*/
String resourceName = "/"
+ getExample().getClass().getName().replace('.',
'/') + ".java";
InputStream is = getClass().getResourceAsStream(
resourceName);
BufferedReader bis = new BufferedReader(
new InputStreamReader(is));
for (String line = bis.readLine(); null != line; line = bis
.readLine()) {
src.append(line);
src.append("\n");
}
javaSource = src.toString();
} catch (Exception e) {
System.err.println(MSG_SOURCE_NOT_AVAILABLE + " ("
+ getPathName() + ")");
javaSource = MSG_SOURCE_NOT_AVAILABLE;
}
}
}
return javaSource;
}
public String getSourceHTML() {
return getSource();
}
/**
* Gets the name used when resolving the path for this feature. Usually no
* need to override.
*
* @return
*/
public String getPathName() {
return getClass().getSimpleName();
}
/**
* Gets the base url used to reference theme resources.
*
* @return
*/
protected static final String getThemeBase() {
return SamplerApplication.getThemeBase();
}
@Override
public String toString() {
return getName();
}
@Override
public boolean equals(Object obj) {
// A feature is uniquely identified by its class name
if (obj == null) {
return false;
}
return obj.getClass() == getClass();
}
@Override
public int hashCode() {
// A feature is uniquely identified by its class name
return getClass().hashCode();
}
}
|
