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
|
package uk.org.ury.frontend;
import java.net.URL;
import javax.swing.JPanel;
import org.swixml.SwingEngine;
import uk.org.ury.frontend.exceptions.UICreationFailureException;
/**
* An extension of JPanel providing common functionality for user
* interface panels in the URY system frontend.
*
* Most notably, this includes automated access to XML-based
* preparation of the user interface provided by the panel,
* using an appropriate constructor call giving the XML file from
* which the user interface form should be read.
*
* @author Matt Windsor
*
*/
public class FrontendPanel extends JPanel
{
/**
*
*/
private static final long serialVersionUID = -4481079599056565279L;
protected FrontendMaster master;
/**
* Construct a new, blank FrontendPanel.
*
* @param master The FrontendMaster driving the frontend, if any.
* For direct instantiations of this class,
* providing null here is guaranteed to be safe.
*/
public
FrontendPanel (FrontendMaster master)
{
super ();
this.master = master;
}
/**
* Construct a new FrontendPanel from an XML layout.
*
* This is the preferred means of constructing FrontendPanels, and
* uses an XML-based engine to construct the panel layout.
*
* @param xmlPath The path, relative from this source file, to the
* XML file from which this panel will read its
* layout.
*
* @param master The FrontendMaster driving the frontend, if any.
* For direct instantiations of this class,
* providing null here is guaranteed to be safe.
*
* @throws UICreationFailureException if the UI creation fails.
*/
public
FrontendPanel (String xmlPath, FrontendMaster master)
throws UICreationFailureException
{
super ();
this.master = master;
// Acquire path.
URL path = getClass ().getResource (xmlPath);
if (path == null)
throw new UICreationFailureException ("UI creation failure:"
+ "XML layout "
+ xmlPath
+ " does not exist.");
SwingEngine se = new SwingEngine (this);
// Custom UI element tag registration.
se.getTaglib ().registerTag ("hint", HintField.class);
se.getTaglib ().registerTag ("subbanner", FrontendSubBanner.class);
// Read the XML.
try
{
se.insert (path, this);
}
catch (Exception e)
{
throw new UICreationFailureException ("UI creation failure: "
+ e.getMessage ());
}
}
/**
* Set the frontend master.
*
* @param master The new frontend master to use.
*/
public void
setMaster (FrontendMaster master)
{
this.master = master;
}
}
|
