Source

lapr4_cleansheets_v2 / doc / api / src-html / csheets / ext / assertion / ui / AssertionPanel.html

Full commit
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Copyright (c) 2005 Peter Palotas, Fredrik Johansson, Einar Pehrson,<a name="line.2"></a>
<FONT color="green">003</FONT>     * Sebastian Kekkonen, Lars Magnus Lĺng, Malin Johansson and Sofia Nilsson<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * This file is part of<a name="line.5"></a>
<FONT color="green">006</FONT>     * CleanSheets Extension for Assertions<a name="line.6"></a>
<FONT color="green">007</FONT>     *<a name="line.7"></a>
<FONT color="green">008</FONT>     * CleanSheets Extension for Assertions is free software; you can<a name="line.8"></a>
<FONT color="green">009</FONT>     * redistribute it and/or modify it under the terms of the GNU General Public<a name="line.9"></a>
<FONT color="green">010</FONT>     * License as published by the Free Software Foundation; either version 2 of<a name="line.10"></a>
<FONT color="green">011</FONT>     * the License, or (at your option) any later version.<a name="line.11"></a>
<FONT color="green">012</FONT>     *<a name="line.12"></a>
<FONT color="green">013</FONT>     * CleanSheets Extension for Assertions is distributed in the hope that<a name="line.13"></a>
<FONT color="green">014</FONT>     * it will be useful, but WITHOUT ANY WARRANTY; without even the implied<a name="line.14"></a>
<FONT color="green">015</FONT>     * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.<a name="line.15"></a>
<FONT color="green">016</FONT>     * See the GNU General Public License for more details.<a name="line.16"></a>
<FONT color="green">017</FONT>     *<a name="line.17"></a>
<FONT color="green">018</FONT>     * You should have received a copy of the GNU General Public License<a name="line.18"></a>
<FONT color="green">019</FONT>     * along with CleanSheets Extension for Assertions; if not, write to the<a name="line.19"></a>
<FONT color="green">020</FONT>     * Free Software Foundation, Inc., 59 Temple Place, Suite 330,<a name="line.20"></a>
<FONT color="green">021</FONT>     * Boston, MA  02111-1307  USA<a name="line.21"></a>
<FONT color="green">022</FONT>     */<a name="line.22"></a>
<FONT color="green">023</FONT>    package csheets.ext.assertion.ui;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    import java.awt.BorderLayout;<a name="line.25"></a>
<FONT color="green">026</FONT>    import java.awt.Color;<a name="line.26"></a>
<FONT color="green">027</FONT>    import java.awt.Component;<a name="line.27"></a>
<FONT color="green">028</FONT>    import java.awt.Dimension;<a name="line.28"></a>
<FONT color="green">029</FONT>    import java.awt.event.ActionEvent;<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>    import javax.swing.BorderFactory;<a name="line.31"></a>
<FONT color="green">032</FONT>    import javax.swing.Box;<a name="line.32"></a>
<FONT color="green">033</FONT>    import javax.swing.BoxLayout;<a name="line.33"></a>
<FONT color="green">034</FONT>    import javax.swing.JButton;<a name="line.34"></a>
<FONT color="green">035</FONT>    import javax.swing.JLabel;<a name="line.35"></a>
<FONT color="green">036</FONT>    import javax.swing.JPanel;<a name="line.36"></a>
<FONT color="green">037</FONT>    import javax.swing.JTextArea;<a name="line.37"></a>
<FONT color="green">038</FONT>    import javax.swing.JTextField;<a name="line.38"></a>
<FONT color="green">039</FONT>    import javax.swing.border.TitledBorder;<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>    import csheets.core.Cell;<a name="line.41"></a>
<FONT color="green">042</FONT>    import csheets.ext.assertion.AssertableCell;<a name="line.42"></a>
<FONT color="green">043</FONT>    import csheets.ext.assertion.AssertableCellListener;<a name="line.43"></a>
<FONT color="green">044</FONT>    import csheets.ext.assertion.Assertion;<a name="line.44"></a>
<FONT color="green">045</FONT>    import csheets.ext.assertion.AssertionExtension;<a name="line.45"></a>
<FONT color="green">046</FONT>    import csheets.ui.ctrl.FocusOwnerAction;<a name="line.46"></a>
<FONT color="green">047</FONT>    import csheets.ui.ctrl.SelectionEvent;<a name="line.47"></a>
<FONT color="green">048</FONT>    import csheets.ui.ctrl.SelectionListener;<a name="line.48"></a>
<FONT color="green">049</FONT>    import csheets.ui.ctrl.UIController;<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>    /**<a name="line.51"></a>
<FONT color="green">052</FONT>     * A panel for adding or editing an assertion for a cell<a name="line.52"></a>
<FONT color="green">053</FONT>     * @author Björn Lanneskog<a name="line.53"></a>
<FONT color="green">054</FONT>     * @author Einar Pehrson<a name="line.54"></a>
<FONT color="green">055</FONT>     */<a name="line.55"></a>
<FONT color="green">056</FONT>    @SuppressWarnings("serial")<a name="line.56"></a>
<FONT color="green">057</FONT>    public class AssertionPanel extends JPanel implements SelectionListener,<a name="line.57"></a>
<FONT color="green">058</FONT>                    AssertableCellListener {<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>            /** The assertion controller */<a name="line.60"></a>
<FONT color="green">061</FONT>            private AssertionController controller;<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>            /** The assertable cell currently being displayed in the panel */<a name="line.63"></a>
<FONT color="green">064</FONT>            private AssertableCell cell;<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>            /** The label on which the status of the assertion is displayed */<a name="line.66"></a>
<FONT color="green">067</FONT>            private JLabel statusLabel = new JLabel();<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>            /** The text field in which the assertion of the cell is displayed.*/<a name="line.69"></a>
<FONT color="green">070</FONT>            private JTextField usField = new JTextField();<a name="line.70"></a>
<FONT color="green">071</FONT>    <a name="line.71"></a>
<FONT color="green">072</FONT>            /**A label showing the system-generated assertion*/<a name="line.72"></a>
<FONT color="green">073</FONT>            private JLabel sgLabel = new JLabel();<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>            /**<a name="line.75"></a>
<FONT color="green">076</FONT>             * Creates a new assertion panel.<a name="line.76"></a>
<FONT color="green">077</FONT>             * @param uiController the user interface controller<a name="line.77"></a>
<FONT color="green">078</FONT>             */<a name="line.78"></a>
<FONT color="green">079</FONT>            public AssertionPanel(UIController uiController) {<a name="line.79"></a>
<FONT color="green">080</FONT>                    // Configures panel<a name="line.80"></a>
<FONT color="green">081</FONT>                    super(new BorderLayout());<a name="line.81"></a>
<FONT color="green">082</FONT>                    setName(AssertionExtension.NAME);<a name="line.82"></a>
<FONT color="green">083</FONT>    <a name="line.83"></a>
<FONT color="green">084</FONT>                    // Creates controller<a name="line.84"></a>
<FONT color="green">085</FONT>                    controller = new AssertionController(uiController);<a name="line.85"></a>
<FONT color="green">086</FONT>                    uiController.addSelectionListener(this);<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>                    // Creates system-generated assertion components<a name="line.88"></a>
<FONT color="green">089</FONT>                    JPanel sgPanel = new JPanel();<a name="line.89"></a>
<FONT color="green">090</FONT>                    sgPanel.setPreferredSize(new Dimension(130, 60));<a name="line.90"></a>
<FONT color="green">091</FONT>                    sgPanel.add(sgLabel);<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>                    // Creates user-specified assertion components<a name="line.93"></a>
<FONT color="green">094</FONT>                    ApplyAction applyAction = new ApplyAction();<a name="line.94"></a>
<FONT color="green">095</FONT>                    JButton applyButton = new JButton(applyAction);<a name="line.95"></a>
<FONT color="green">096</FONT>                    usField.setPreferredSize(new Dimension(120, 24));<a name="line.96"></a>
<FONT color="green">097</FONT>                    usField.setMaximumSize(new Dimension(1000, 24));<a name="line.97"></a>
<FONT color="green">098</FONT>                    usField.addActionListener(applyAction);<a name="line.98"></a>
<FONT color="green">099</FONT>                    usField.setAlignmentX(Component.CENTER_ALIGNMENT);<a name="line.99"></a>
<FONT color="green">100</FONT>                    applyButton.setAlignmentX(Component.CENTER_ALIGNMENT);<a name="line.100"></a>
<FONT color="green">101</FONT>                    statusLabel.setAlignmentX(Component.CENTER_ALIGNMENT);<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>                    // Lays out user-specified assertion components<a name="line.103"></a>
<FONT color="green">104</FONT>                    JPanel usPanel = new JPanel();<a name="line.104"></a>
<FONT color="green">105</FONT>                    usPanel.setLayout(new BoxLayout(usPanel, BoxLayout.PAGE_AXIS));<a name="line.105"></a>
<FONT color="green">106</FONT>                    usPanel.setPreferredSize(new Dimension(130, 120));<a name="line.106"></a>
<FONT color="green">107</FONT>                    usPanel.add(usField);<a name="line.107"></a>
<FONT color="green">108</FONT>                    usPanel.add(Box.createRigidArea(new Dimension(120, 4)));<a name="line.108"></a>
<FONT color="green">109</FONT>                    usPanel.add(applyButton);<a name="line.109"></a>
<FONT color="green">110</FONT>                    usPanel.add(Box.createRigidArea(new Dimension(120, 12)));<a name="line.110"></a>
<FONT color="green">111</FONT>                    usPanel.add(statusLabel);<a name="line.111"></a>
<FONT color="green">112</FONT>                    usPanel.add(Box.createRigidArea(new Dimension(120, 12)));<a name="line.112"></a>
<FONT color="green">113</FONT>    <a name="line.113"></a>
<FONT color="green">114</FONT>                    // Creates assertion syntax components<a name="line.114"></a>
<FONT color="green">115</FONT>                    JPanel syntaxPanel = new JPanel();<a name="line.115"></a>
<FONT color="green">116</FONT>                    JTextArea syntaxArea = new JTextArea("");<a name="line.116"></a>
<FONT color="green">117</FONT>                            // "Operators: &gt; &lt; &gt;= &lt;=\nOR\nEXCEPT\nINTEGER"<a name="line.117"></a>
<FONT color="green">118</FONT>                    syntaxArea.setPreferredSize(new Dimension(120, 100));<a name="line.118"></a>
<FONT color="green">119</FONT>                    syntaxArea.setLineWrap(true);<a name="line.119"></a>
<FONT color="green">120</FONT>                    syntaxArea.setEditable(false);<a name="line.120"></a>
<FONT color="green">121</FONT>                    syntaxArea.setBackground(getBackground());<a name="line.121"></a>
<FONT color="green">122</FONT>                    syntaxPanel.add(syntaxArea);<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>                    // Adds borders<a name="line.124"></a>
<FONT color="green">125</FONT>                    TitledBorder border = BorderFactory.createTitledBorder("System-generated");<a name="line.125"></a>
<FONT color="green">126</FONT>                    border.setTitleJustification(TitledBorder.CENTER);<a name="line.126"></a>
<FONT color="green">127</FONT>                    sgPanel.setBorder(border);<a name="line.127"></a>
<FONT color="green">128</FONT>                    border = BorderFactory.createTitledBorder("User-specified");<a name="line.128"></a>
<FONT color="green">129</FONT>                    border.setTitleJustification(TitledBorder.CENTER);<a name="line.129"></a>
<FONT color="green">130</FONT>                    usPanel.setBorder(border);<a name="line.130"></a>
<FONT color="green">131</FONT>                    border = BorderFactory.createTitledBorder("Syntax");<a name="line.131"></a>
<FONT color="green">132</FONT>                    border.setTitleJustification(TitledBorder.CENTER);<a name="line.132"></a>
<FONT color="green">133</FONT>                    // syntaxPanel.setBorder(border);<a name="line.133"></a>
<FONT color="green">134</FONT>    <a name="line.134"></a>
<FONT color="green">135</FONT>                    // Adds panels<a name="line.135"></a>
<FONT color="green">136</FONT>                    JPanel northPanel = new JPanel(new BorderLayout());<a name="line.136"></a>
<FONT color="green">137</FONT>                    northPanel.add(sgPanel, BorderLayout.NORTH);<a name="line.137"></a>
<FONT color="green">138</FONT>                    northPanel.add(usPanel, BorderLayout.SOUTH);<a name="line.138"></a>
<FONT color="green">139</FONT>                    add(northPanel, BorderLayout.NORTH);<a name="line.139"></a>
<FONT color="green">140</FONT>                    add(syntaxPanel, BorderLayout.CENTER);<a name="line.140"></a>
<FONT color="green">141</FONT>            }<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>            /**<a name="line.143"></a>
<FONT color="green">144</FONT>             * Updates the assertion field and status label when the active cell of<a name="line.144"></a>
<FONT color="green">145</FONT>             * the application is changed.<a name="line.145"></a>
<FONT color="green">146</FONT>             * @param event the selection event that was fired<a name="line.146"></a>
<FONT color="green">147</FONT>             */<a name="line.147"></a>
<FONT color="green">148</FONT>            public void selectionChanged(SelectionEvent event) {<a name="line.148"></a>
<FONT color="green">149</FONT>                    Cell cell = event.getCell();<a name="line.149"></a>
<FONT color="green">150</FONT>                    if (cell != null) {<a name="line.150"></a>
<FONT color="green">151</FONT>                            AssertableCell activeCell<a name="line.151"></a>
<FONT color="green">152</FONT>                                    = (AssertableCell)cell.getExtension(AssertionExtension.NAME);<a name="line.152"></a>
<FONT color="green">153</FONT>                            activeCell.addAssertableCellListener(this);<a name="line.153"></a>
<FONT color="green">154</FONT>                            assertionsChanged(activeCell);<a name="line.154"></a>
<FONT color="green">155</FONT>                    } else {<a name="line.155"></a>
<FONT color="green">156</FONT>                            usField.setText("");<a name="line.156"></a>
<FONT color="green">157</FONT>                            statusLabel.setText("");<a name="line.157"></a>
<FONT color="green">158</FONT>                            sgLabel.setText("");<a name="line.158"></a>
<FONT color="green">159</FONT>                    }<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>                    // Stops listening to previous active cell<a name="line.161"></a>
<FONT color="green">162</FONT>                    if (event.getPreviousCell() != null)<a name="line.162"></a>
<FONT color="green">163</FONT>                            ((AssertableCell)event.getPreviousCell().getExtension(AssertionExtension.NAME))<a name="line.163"></a>
<FONT color="green">164</FONT>                                    .removeAssertableCellListener(this);<a name="line.164"></a>
<FONT color="green">165</FONT>            }<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>            /**<a name="line.167"></a>
<FONT color="green">168</FONT>             * Updates the assertion field and status label when the assertion of the<a name="line.168"></a>
<FONT color="green">169</FONT>             * active cell is changed.<a name="line.169"></a>
<FONT color="green">170</FONT>             * @param cell the cell whose assertion changed<a name="line.170"></a>
<FONT color="green">171</FONT>             */<a name="line.171"></a>
<FONT color="green">172</FONT>            public void assertionsChanged(AssertableCell cell) {<a name="line.172"></a>
<FONT color="green">173</FONT>                    // Stores the cell for use when applying assertion<a name="line.173"></a>
<FONT color="green">174</FONT>                    this.cell = cell;<a name="line.174"></a>
<FONT color="green">175</FONT>    <a name="line.175"></a>
<FONT color="green">176</FONT>                    // Initializes colors and text<a name="line.176"></a>
<FONT color="green">177</FONT>                    Color usColor = Color.BLACK;<a name="line.177"></a>
<FONT color="green">178</FONT>                    Color sgColor = Color.BLACK;<a name="line.178"></a>
<FONT color="green">179</FONT>                    String usStatus = "";<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>                    // Updates system-generated assertion label<a name="line.181"></a>
<FONT color="green">182</FONT>                    if (cell.isSGAsserted()) {<a name="line.182"></a>
<FONT color="green">183</FONT>                            sgLabel.setText(cell.getSGAssertion().toString());<a name="line.183"></a>
<FONT color="green">184</FONT>                            sgColor = AssertionController.getAssertionResultColor(cell.assertSG());<a name="line.184"></a>
<FONT color="green">185</FONT>                    } else<a name="line.185"></a>
<FONT color="green">186</FONT>                            sgLabel.setText("No assertion");<a name="line.186"></a>
<FONT color="green">187</FONT>    <a name="line.187"></a>
<FONT color="green">188</FONT>                    // Updates the text field and validates the assertion, if any<a name="line.188"></a>
<FONT color="green">189</FONT>                    if (cell.isUSAsserted()) {<a name="line.189"></a>
<FONT color="green">190</FONT>                            usField.setText(cell.getUSAssertion().toString());<a name="line.190"></a>
<FONT color="green">191</FONT>                            Assertion.Result result = cell.assertUS();<a name="line.191"></a>
<FONT color="green">192</FONT>            <a name="line.192"></a>
<FONT color="green">193</FONT>                            // Determines the status message<a name="line.193"></a>
<FONT color="green">194</FONT>                            usColor = AssertionController.getAssertionResultColor(result);<a name="line.194"></a>
<FONT color="green">195</FONT>                            switch (result) {<a name="line.195"></a>
<FONT color="green">196</FONT>                                    case OK:<a name="line.196"></a>
<FONT color="green">197</FONT>                                            usStatus += "Valid";<a name="line.197"></a>
<FONT color="green">198</FONT>                                            break;<a name="line.198"></a>
<FONT color="green">199</FONT>                                    case NAN:<a name="line.199"></a>
<FONT color="green">200</FONT>                                            usStatus += "Non-numeric value";<a name="line.200"></a>
<FONT color="green">201</FONT>                                            break;<a name="line.201"></a>
<FONT color="green">202</FONT>                                    case FAILED:<a name="line.202"></a>
<FONT color="green">203</FONT>                                            usStatus += "Illegal value";<a name="line.203"></a>
<FONT color="green">204</FONT>                                            break;<a name="line.204"></a>
<FONT color="green">205</FONT>                                    case NO_DATA:<a name="line.205"></a>
<FONT color="green">206</FONT>                                            usStatus += "No value";<a name="line.206"></a>
<FONT color="green">207</FONT>                                            break;<a name="line.207"></a>
<FONT color="green">208</FONT>                            }<a name="line.208"></a>
<FONT color="green">209</FONT>    <a name="line.209"></a>
<FONT color="green">210</FONT>                            // Compares assertions<a name="line.210"></a>
<FONT color="green">211</FONT>                            Assertion.ComparisonResult compResult = cell.assertAssertions();<a name="line.211"></a>
<FONT color="green">212</FONT>                            switch (compResult) {<a name="line.212"></a>
<FONT color="green">213</FONT>                                    case NON_EQUAL:<a name="line.213"></a>
<FONT color="green">214</FONT>                                            usColor =  new Color(0.7f, 0.0f, 0f);<a name="line.214"></a>
<FONT color="green">215</FONT>                                            usStatus = "Conflicting assertions";<a name="line.215"></a>
<FONT color="green">216</FONT>                                             break;<a name="line.216"></a>
<FONT color="green">217</FONT>                                    case ILLEGAL_INTERVAL:<a name="line.217"></a>
<FONT color="green">218</FONT>                                            sgLabel.setText(compResult.getErrorMsg());<a name="line.218"></a>
<FONT color="green">219</FONT>                                            break;<a name="line.219"></a>
<FONT color="green">220</FONT>                            }<a name="line.220"></a>
<FONT color="green">221</FONT>                    } else {<a name="line.221"></a>
<FONT color="green">222</FONT>                            usField.setText("");<a name="line.222"></a>
<FONT color="green">223</FONT>                            usStatus = "No assertion";<a name="line.223"></a>
<FONT color="green">224</FONT>                    }<a name="line.224"></a>
<FONT color="green">225</FONT>    <a name="line.225"></a>
<FONT color="green">226</FONT>                    // Updates the label<a name="line.226"></a>
<FONT color="green">227</FONT>                    sgLabel.setForeground(sgColor);<a name="line.227"></a>
<FONT color="green">228</FONT>                    statusLabel.setForeground(usColor);<a name="line.228"></a>
<FONT color="green">229</FONT>                    statusLabel.setText(usStatus);<a name="line.229"></a>
<FONT color="green">230</FONT>            }<a name="line.230"></a>
<FONT color="green">231</FONT>    <a name="line.231"></a>
<FONT color="green">232</FONT>            /**<a name="line.232"></a>
<FONT color="green">233</FONT>             * An action used to apply changes made in the assertion field.<a name="line.233"></a>
<FONT color="green">234</FONT>             */<a name="line.234"></a>
<FONT color="green">235</FONT>            protected class ApplyAction extends FocusOwnerAction {<a name="line.235"></a>
<FONT color="green">236</FONT>    <a name="line.236"></a>
<FONT color="green">237</FONT>                    /**<a name="line.237"></a>
<FONT color="green">238</FONT>                     * Creates a new apply action.<a name="line.238"></a>
<FONT color="green">239</FONT>                     */<a name="line.239"></a>
<FONT color="green">240</FONT>                    public ApplyAction() {}<a name="line.240"></a>
<FONT color="green">241</FONT>    <a name="line.241"></a>
<FONT color="green">242</FONT>                    protected String getName() {<a name="line.242"></a>
<FONT color="green">243</FONT>                            return "Apply";<a name="line.243"></a>
<FONT color="green">244</FONT>                    }<a name="line.244"></a>
<FONT color="green">245</FONT>    <a name="line.245"></a>
<FONT color="green">246</FONT>                    public void actionPerformed(ActionEvent e) {<a name="line.246"></a>
<FONT color="green">247</FONT>                            if (cell != null)<a name="line.247"></a>
<FONT color="green">248</FONT>                                    if (controller.setAssertion(cell, usField.getText().trim()))<a name="line.248"></a>
<FONT color="green">249</FONT>                                            focusOwner.repaint();<a name="line.249"></a>
<FONT color="green">250</FONT>                    }<a name="line.250"></a>
<FONT color="green">251</FONT>            }<a name="line.251"></a>
<FONT color="green">252</FONT>    }<a name="line.252"></a>




























































</PRE>
</BODY>
</HTML>