2 <<The file is used to create, update Data Hub Record entries in a MSA file.>>
4 <<The DataHbsDlg is a dialog called to add or edit a Data Hub Record within a MSA file.>>
6 Copyright (c) 2006, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 Module Name: FrameworkWizard
20 package org
.tianocore
.frameworkwizard
.module
.ui
.dialog
;
22 import java
.awt
.event
.ActionEvent
;
23 import java
.util
.Vector
;
25 import javax
.swing
.JButton
;
26 import javax
.swing
.JComboBox
;
27 import javax
.swing
.JLabel
;
28 import javax
.swing
.JPanel
;
29 import javax
.swing
.JScrollPane
;
30 import javax
.swing
.JTextField
;
31 import javax
.swing
.JTextArea
;
33 import org
.tianocore
.frameworkwizard
.common
.DataType
;
34 import org
.tianocore
.frameworkwizard
.common
.DataValidation
;
35 import org
.tianocore
.frameworkwizard
.common
.EnumerationData
;
36 import org
.tianocore
.frameworkwizard
.common
.Log
;
37 import org
.tianocore
.frameworkwizard
.common
.Tools
;
38 import org
.tianocore
.frameworkwizard
.common
.ui
.ArchCheckBox
;
39 import org
.tianocore
.frameworkwizard
.common
.ui
.IDialog
;
40 import org
.tianocore
.frameworkwizard
.common
.ui
.IFrame
;
41 import org
.tianocore
.frameworkwizard
.common
.ui
.StarLabel
;
42 import org
.tianocore
.frameworkwizard
.module
.Identifications
.DataHubs
.DataHubsIdentification
;
45 * The class is used to create, update DataHub of MSA/MBD file It extends
51 public class DataHubsDlg
extends IDialog
{
54 // / Define class Serial Version UID
56 private static final long serialVersionUID
= -3667906991966638892L;
59 // Define class members
61 private JPanel jContentPane
= null;
63 private JLabel jLabelUsage
= null;
65 private JComboBox jComboBoxUsage
= null;
67 private JLabel jLabelDataHubRecord
= null;
69 private JTextField jTextFieldDataHubRecord
= null;
71 private StarLabel jStarLabel1
= null;
73 private StarLabel jStarLabel2
= null;
75 private JLabel jLabelFeatureFlag
= null;
77 private JTextField jTextFieldFeatureFlag
= null;
79 private JLabel jLabelArch
= null;
81 private JScrollPane jScrollPane
= null;
83 private JLabel jLabelHelpText
= null;
85 private JTextArea jTextAreaHelpText
= null;
87 private JScrollPane jScrollPaneHelpText
= null;
89 private ArchCheckBox jArchCheckBox
= null;
91 private JButton jButtonOk
= null;
93 private JButton jButtonCancel
= null;
98 private DataHubsIdentification id
= null;
100 private EnumerationData ed
= new EnumerationData();
103 * This method initializes jTextFieldDataHubRecord
105 * @return javax.swing.JTextField jTextFieldDataHubRecord
108 private JTextField
getJTextFieldDataHubRecord() {
109 if (jTextFieldDataHubRecord
== null) {
110 jTextFieldDataHubRecord
= new JTextField();
111 jTextFieldDataHubRecord
112 .setBounds(new java
.awt
.Rectangle(160, 10, 320, 20));
113 jTextFieldDataHubRecord
.setPreferredSize(new java
.awt
.Dimension(320, 20));
114 jTextFieldDataHubRecord
115 .setToolTipText("Enter the C Name of the Data Hub Record");
117 return jTextFieldDataHubRecord
;
121 * This method initializes jComboBoxUsage
123 * @return javax.swing.JComboBox jComboBoxUsage
126 private JComboBox
getJComboBoxUsage() {
127 if (jComboBoxUsage
== null) {
128 jComboBoxUsage
= new JComboBox();
129 jComboBoxUsage
.setBounds(new java
.awt
.Rectangle(160, 35, 320, 20));
130 jComboBoxUsage
.setPreferredSize(new java
.awt
.Dimension(320, 20));
132 .setToolTipText("<html><table><tr><td>ALWAYS_CONSUMED</td><td>Module always consumes a Data Hub Entry<br>via registering a filter driver.</td></tr><tr><td>SOMETIMES_CONSUMED</td><td>Module will use a Data Hub Entry if it exists<br>via registering a filter driver</td></tr><tr><td>ALWAYS_PRODUCED</td><td>Always logs data into the Data Hub</td></tr><tr><td>SOMETIMES_PRODUCED</td><td>Log data into the Data Hub under<br>certain circumstances</td></tr></table></html>");
134 return jComboBoxUsage
;
138 * This method initializes jTextFieldFeatureFlag
140 * @return javax.swing.JTextField
142 private JTextField
getJTextFieldFeatureFlag() {
143 if (jTextFieldFeatureFlag
== null) {
144 jTextFieldFeatureFlag
= new JTextField();
145 jTextFieldFeatureFlag
.setBounds(new java
.awt
.Rectangle(160, 105, 320, 20));
146 jTextFieldFeatureFlag
.setPreferredSize(new java
.awt
.Dimension(320, 20));
147 jTextFieldFeatureFlag
.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");
149 return jTextFieldFeatureFlag
;
153 * This method initializes jScrollPane
155 * @return javax.swing.JScrollPane
157 private JScrollPane
getJScrollPane() {
158 if (jScrollPane
== null) {
159 jScrollPane
= new JScrollPane();
160 jScrollPane
.setViewportView(getJContentPane());
166 * This method initializes jTextAreaHelpText
168 * @return javax.swing.JTextArea
171 private JTextArea
getJTextAreaHelpText() {
172 if (jTextAreaHelpText
== null) {
173 jTextAreaHelpText
= new JTextArea();
174 jTextAreaHelpText
.setLineWrap(true);
175 jTextAreaHelpText
.setWrapStyleWord(true);
177 return jTextAreaHelpText
;
181 * This method initializes jScrollPaneHelpText
183 * @return javax.swing.JScrollPane
186 private JScrollPane
getJScrollPaneHelpText() {
187 if (jScrollPaneHelpText
== null) {
188 jScrollPaneHelpText
= new JScrollPane();
189 jScrollPaneHelpText
.setHorizontalScrollBarPolicy(javax
.swing
.JScrollPane
.HORIZONTAL_SCROLLBAR_NEVER
);
190 jScrollPaneHelpText
.setSize(new java
.awt
.Dimension(320, 40));
191 jScrollPaneHelpText
.setPreferredSize(new java
.awt
.Dimension(320,40));
192 jScrollPaneHelpText
.setLocation(new java
.awt
.Point(160,60));
193 jScrollPaneHelpText
.setViewportView(getJTextAreaHelpText());
195 return jScrollPaneHelpText
;
198 * This method initializes jButtonOk
200 * @return javax.swing.JButton
203 private JButton
getJButtonOk() {
204 if (jButtonOk
== null) {
205 jButtonOk
= new JButton();
206 jButtonOk
.setBounds(new java
.awt
.Rectangle(290, 157, 90, 20));
207 jButtonOk
.setText("Ok");
208 jButtonOk
.addActionListener(this);
214 * This method initializes jButtonCancel
216 * @return javax.swing.JButton
219 private JButton
getJButtonCancel() {
220 if (jButtonCancel
== null) {
221 jButtonCancel
= new JButton();
222 jButtonCancel
.setBounds(new java
.awt
.Rectangle(390, 157, 90, 20));
223 jButtonCancel
.setText("Cancel");
224 jButtonCancel
.addActionListener(this);
226 return jButtonCancel
;
229 public static void main(String
[] args
) {
234 * This method initializes this
237 private void init() {
238 this.setSize(500, 230);
239 this.setContentPane(getJScrollPane());
240 this.setTitle("Data Hubs");
242 this.setViewMode(false);
247 * This method initializes this Fill values to all fields if these values are
250 * @param inDataHubsId
253 private void init(DataHubsIdentification inDataHubsId
) {
255 this.id
= inDataHubsId
;
257 if (this.id
!= null) {
258 this.jTextFieldDataHubRecord
.setText(id
.getName());
259 this.jComboBoxUsage
.setSelectedItem(id
.getUsage());
260 this.jTextAreaHelpText
.setText(id
.getHelp());
261 this.jTextFieldFeatureFlag
.setText(id
.getFeatureFlag());
262 this.jArchCheckBox
.setSelectedItems(id
.getSupArchList());
267 * This is the override edit constructor
269 * @param inDataHubsIdentification
273 public DataHubsDlg(DataHubsIdentification inDataHubsIdentification
,
276 init(inDataHubsIdentification
);
280 * Disable all components when the mode is view
283 * true - The view mode; false - The non-view mode
286 public void setViewMode(boolean isView
) {
288 this.jTextFieldDataHubRecord
.setEnabled(!isView
);
289 this.jComboBoxUsage
.setEnabled(!isView
);
294 * This method initializes jContentPane
296 * @return javax.swing.JPanel jContentPane
299 private JPanel
getJContentPane() {
300 if (jContentPane
== null) {
301 jStarLabel1
= new StarLabel();
302 jStarLabel1
.setLocation(new java
.awt
.Point(2, 10));
303 jLabelDataHubRecord
= new JLabel();
304 jLabelDataHubRecord
.setBounds(new java
.awt
.Rectangle(15, 10, 145, 20));
305 jLabelDataHubRecord
.setText("Data Hub Record");
306 jStarLabel2
= new StarLabel();
307 jStarLabel2
.setLocation(new java
.awt
.Point(2, 35));
308 jLabelUsage
= new JLabel();
309 jLabelUsage
.setText("Usage");
310 jLabelUsage
.setBounds(new java
.awt
.Rectangle(15, 35, 145, 20));
311 jLabelHelpText
= new JLabel();
312 jLabelHelpText
.setBounds(new java
.awt
.Rectangle(14, 60, 145, 20));
313 jLabelHelpText
.setText("Help Text");
314 jLabelFeatureFlag
= new JLabel();
315 jLabelFeatureFlag
.setBounds(new java
.awt
.Rectangle(15, 105, 145, 20));
316 jLabelFeatureFlag
.setText("Feature Flag Expression");
317 jLabelArch
= new JLabel();
318 jLabelArch
.setBounds(new java
.awt
.Rectangle(15, 130, 145, 20));
319 jLabelArch
.setText("Supported Architectures");
320 jArchCheckBox
= new ArchCheckBox();
321 jArchCheckBox
.setBounds(new java
.awt
.Rectangle(160, 130, 320, 20));
322 jArchCheckBox
.setPreferredSize(new java
.awt
.Dimension(320, 20));
324 jContentPane
= new JPanel();
325 jContentPane
.setLayout(null);
326 jContentPane
.setPreferredSize(new java
.awt
.Dimension(485, 185));
328 jContentPane
.add(jLabelDataHubRecord
, null);
329 jContentPane
.add(jLabelUsage
, null);
330 jContentPane
.add(jLabelFeatureFlag
, null);
331 jContentPane
.add(jLabelArch
, null);
333 jContentPane
.add(getJTextFieldDataHubRecord(), null);
334 jContentPane
.add(getJComboBoxUsage(), null);
335 jContentPane
.add(getJTextFieldFeatureFlag(), null);
337 jContentPane
.add(jStarLabel1
, null);
338 jContentPane
.add(jStarLabel2
, null);
340 jContentPane
.add(jLabelHelpText
, null);
341 jContentPane
.add(getJScrollPaneHelpText(), null);
342 jContentPane
.add(jArchCheckBox
, null);
343 jContentPane
.add(getJButtonOk(), null);
344 jContentPane
.add(getJButtonCancel(), null);
350 * This method initializes Usage type
353 private void initFrame() {
354 Tools
.generateComboBoxByVector(jComboBoxUsage
, ed
.getVDataHubUsage());
360 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
362 * Override actionPerformed to listen all actions
365 public void actionPerformed(ActionEvent arg0
) {
366 if (arg0
.getSource() == jButtonOk
) {
368 getCurrentDataHubs();
369 this.returnType
= DataType
.RETURN_TYPE_OK
;
370 this.setVisible(false);
374 if (arg0
.getSource() == jButtonCancel
) {
375 this.returnType
= DataType
.RETURN_TYPE_CANCEL
;
376 this.setVisible(false);
381 * Data validation for all fields
383 * @retval true - All datas are valid
384 * @retval false - At least one data is invalid
387 public boolean checkAdd() {
389 // Check if all fields have correct data types
393 // Check DataHubRecord
395 if (isEmpty(this.jTextFieldDataHubRecord
.getText())) {
396 Log
.wrn("Update Hubs", "Data Hub Record must not be empty");
400 if (!isEmpty(this.jTextFieldDataHubRecord
.getText())) {
401 if (!DataValidation
.isC_NameType(this.jTextFieldDataHubRecord
.getText())) {
402 Log
.wrn("Update Hubs", "Incorrect data type for Data Hub Record");
410 if (!isEmpty(this.jTextFieldFeatureFlag
.getText())) {
411 if (!DataValidation
.isFeatureFlag(this.jTextFieldFeatureFlag
.getText())) {
412 Log
.wrn("Update Hubs", "Incorrect data type for Feature Flag");
420 private DataHubsIdentification
getCurrentDataHubs() {
421 String arg0
= this.jTextFieldDataHubRecord
.getText();
422 String arg1
= this.jComboBoxUsage
.getSelectedItem().toString();
424 String arg2
= this.jTextFieldFeatureFlag
.getText();
425 Vector
<String
> arg3
= this.jArchCheckBox
.getSelectedItemsVector();
426 String arg4
= this.jTextAreaHelpText
.getText();
428 id
= new DataHubsIdentification(arg0
, arg1
, arg2
, arg3
, arg4
);
432 public DataHubsIdentification
getId() {
436 public void setId(DataHubsIdentification id
) {