Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* IzPack - Copyright 2001-2008 Julien Ponge, All Rights Reserved.
*
* http://izpack.org/
* http://izpack.codehaus.org/
*
* Copyright 2002 Elmar Grom
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.izforge.izpack.panels;
import com.izforge.izpack.LocaleDatabase;
import com.izforge.izpack.Pack;
import com.izforge.izpack.Panel;
import com.izforge.izpack.gui.ButtonFactory;
import com.izforge.izpack.gui.LabelFactory;
import com.izforge.izpack.gui.TwoColumnConstraints;
import com.izforge.izpack.gui.TwoColumnLayout;
import com.izforge.izpack.installer.InstallData;
import com.izforge.izpack.installer.InstallerFrame;
import com.izforge.izpack.installer.IzPanel;
import com.izforge.izpack.installer.ResourceManager;
import com.izforge.izpack.rules.RulesEngine;
import com.izforge.izpack.util.*;
import net.n3.nanoxml.*;
import javax.swing.*;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.filechooser.FileFilter;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.File;
import java.io.InputStream;
import java.text.MessageFormat;
import java.util.*;
import java.util.List;
/*---------------------------------------------------------------------------*/
/**
* This panel is designed to collect user input during the installation process. The panel is
* initially blank and is populated with input elements based on the XML specification in a resource
* file.
*
* @author getDirectoryCreated
* @version 0.0.1 / 10/19/02
*/
/*---------------------------------------------------------------------------*/
/*
* $ @design
*
* Each field is specified in its own node, containing attributes and data. When this class is
* instantiated, the specification is read and analyzed. Each field node is processed based on its
* type. An specialized member function is called for each field type that creates the necessary UI
* elements. All UI elements are stored in the uiElements vector. Elements are packaged in an object
* array that must follow this pattern:
*
* index 0 - a String object, that specifies the field type. This is identical to the string used to
* identify the field type in the XML file. index 1 - a String object that contains the variable
* name for substitution. index 2 - the constraints object that should be used for positioning the
* UI element index 3 - the UI element itself index 4 - a Vector containg a list of pack for which
* the item should be created. This is used by buildUI() to decide if the item should be added to
* the UI.
*
* In some cases additional entries are used. The use depends on the specific needs of the type of
* input field.
*
* When the panel is activated, the method buildUI() walks the list of UI elements adds them to the
* panel together with the matching constraint.
*
* When an attempt is made to move on to another panel, the method readInput() walks the list of UI
* elements again and calls specialized methods that know how to read the user input from each of
* the UI elemnts and set the associated varaible.
*
* The actual variable substitution is not performed by this panel but by the variable substitutor.
*
* To Do: ------ * make sure all header documentation is complete and correct
* --------------------------------------------------------------------------
*/
public class UserInputPanel extends IzPanel implements ActionListener
{
// ------------------------------------------------------------------------
// Constant Definitions
// ------------------------------------------------------------------------
// The constants beginning with 'POS_' define locations in the object arrays
// that used to hold all information for the individual fields. Some data is
// not required for all field types. If this happens withing the array, that
// location must be padded with 'null'. At the end of the array it can be
// omitted. The data stored in this way is in most cases only known by
// convention between the add and the associated read method. the following
// positions are also used by other service methods in this class and must
// not be used for other purposes:
// - POS_DISPLAYED
// - POS_TYPE
// - POS_CONSTRAINTS
// - POS_PACKS
/**
*
*/
private static final long serialVersionUID = 3257850965439886129L;
private static final int POS_DISPLAYED = 0;
private static final int POS_TYPE = 1;
private static final int POS_VARIABLE = 2;
private static final int POS_CONSTRAINTS = 3;
private static final int POS_FIELD = 4;
private static final int POS_PACKS = 5;
private static final int POS_OS = 6;
private static final int POS_TRUE = 7;
private static final int POS_FALSE = 8;
private static final int POS_MESSAGE = 9;
private static final int POS_GROUP = 10;
protected static final String ICON_KEY = "icon";
/**
* The name of the XML file that specifies the panel layout
*/
private static final String SPEC_FILE_NAME = "userInputSpec.xml";
private static final String LANG_FILE_NAME = "userInputLang.xml";
/**
* how the spec node for a specific panel is identified
*/
private static final String NODE_ID = "panel";
private static final String FIELD_NODE_ID = "field";
private static final String INSTANCE_IDENTIFIER = "order";
protected static final String PANEL_IDENTIFIER = "id";
private static final String TYPE = "type";
private static final String DESCRIPTION = "description";
private static final String VARIABLE = "variable";
private static final String TEXT = "txt";
private static final String KEY = "id";
private static final String SPEC = "spec";
private static final String SET = "set";
private static final String REVALIDATE = "revalidate";
private static final String TOPBUFFER = "topBuffer";
private static final String TRUE = "true";
private static final String FALSE = "false";
private static final String ALIGNMENT = "align";
private static final String LEFT = "left";
private static final String CENTER = "center";
private static final String RIGHT = "right";
private static final String TOP = "top";
private static final String ITALICS = "italic";
private static final String BOLD = "bold";
private static final String SIZE = "size";
private static final String VALIDATOR = "validator";
private static final String PROCESSOR = "processor";
private static final String CLASS = "class";
private static final String FIELD_LABEL = "label";
private static final String TITLE_FIELD = "title";
private static final String TEXT_FIELD = "text";
private static final String TEXT_SIZE = "size";
private static final String STATIC_TEXT = "staticText";
private static final String COMBO_FIELD = "combo";
private static final String COMBO_CHOICE = "choice";
private static final String COMBO_VALUE = "value";
private static final String RADIO_FIELD = "radio";
private static final String RADIO_CHOICE = "choice";
private static final String RADIO_VALUE = "value";
private static final String SPACE_FIELD = "space";
private static final String DIVIDER_FIELD = "divider";
private static final String CHECK_FIELD = "check";
private static final String RULE_FIELD = "rule";
private static final String RULE_LAYOUT = "layout";
private static final String RULE_SEPARATOR = "separator";
private static final String RULE_RESULT_FORMAT = "resultFormat";
private static final String RULE_PLAIN_STRING = "plainString";
private static final String RULE_DISPLAY_FORMAT = "displayFormat";
private static final String RULE_SPECIAL_SEPARATOR = "specialSeparator";
private static final String RULE_ENCRYPTED = "processed";
private static final String RULE_PARAM_NAME = "name";
private static final String RULE_PARAM_VALUE = "value";
private static final String RULE_PARAM = "param";
private static final String PWD_FIELD = "password";
private static final String PWD_INPUT = "pwd";
private static final String PWD_SIZE = "size";
private static final String SEARCH_FIELD = "search";
private static final String FILE_FIELD = "file";
private static final String DIR_FIELD = "dir";
// internal value for the button used to trigger autodetection
private static final String SEARCH_BUTTON_FIELD = "autodetect";
private static final String SEARCH_CHOICE = "choice";
private static final String SEARCH_FILENAME = "filename";
private static final String SEARCH_RESULT = "result";
private static final String SEARCH_VALUE = "value";
private static final String SEARCH_TYPE = "type";
private static final String SEARCH_FILE = "file";
private static final String SEARCH_DIRECTORY = "directory";
private static final String SEARCH_PARENTDIR = "parentdir";
private static final String SEARCH_CHECKFILENAME = "checkfilename";
private static final String SELECTEDPACKS = "createForPack"; // renamed
private static final String UNSELECTEDPACKS = "createForUnselectedPack"; // new
protected static final String ATTRIBUTE_CONDITIONID_NAME = "conditionid";
protected static final String VARIABLE_NODE = "variable";
protected static final String ATTRIBUTE_VARIABLE_NAME = "name";
protected static final String ATTRIBUTE_VARIABLE_VALUE = "value";
// node
private static final String NAME = "name";
private static final String OS = "os";
private static final String FAMILY = "family";
private static final String FIELD_BUTTON = "button";
// ------------------------------------------------------------------------
// Variable Declarations
// ------------------------------------------------------------------------
private static int instanceCount = 0;
protected int instanceNumber = 0;
/**
* If there is a possibility that some UI elements will not get added we can not allow to go
* back to the PacksPanel, because the process of building the UI is not reversable. This
* variable keeps track if any packs have been defined and will be used to make a decision for
* locking the 'previous' button.
*/
private boolean packsDefined = false;
private InstallerFrame parentFrame;
/**
* The parsed result from reading the XML specification from the file
*/
private XMLElement spec;
private boolean haveSpec = false;
/**
* Holds the references to all of the UI elements
*/
private Vector uiElements = new Vector();
/**
* Holds the references to all radio button groups
*/
private Vector buttonGroups = new Vector();
/**
* Holds the references to all password field groups
*/
private Vector passwordGroups = new Vector();
/**
* used for temporary storage of references to password groups that have already been read in a
* given read cycle.
*/
private Vector passwordGroupsRead = new Vector();
/**
* Used to track search fields. Contains SearchField references.
*/
private Vector searchFields = new Vector();
/**
* Holds all user inputs for use in automated installation
*/
private Vector entries = new Vector();
private LocaleDatabase langpack = null;
// Used for dynamic controls to skip content validation unless the user
// really clicks "Next"
private boolean validating = true;
private String currentDirectoryPath = null;
/*--------------------------------------------------------------------------*/
// This method can be used to search for layout problems. If this class is
// compiled with this method uncommented, the layout guides will be shown
// on the panel, making it possible to see if all components are placed
// correctly.
/*--------------------------------------------------------------------------*/
// public void paint (Graphics graphics)
// {
// super.paint (graphics);
// layout.showRules ((Graphics2D)graphics, Color.red);
// }
/*--------------------------------------------------------------------------*/
/**
* Constructs a UserInputPanel.
*
* @param parent reference to the application frame
* @param installData shared information about the installation
*/
/*--------------------------------------------------------------------------*/
public UserInputPanel(InstallerFrame parent, InstallData installData)
{
super(parent, installData);
instanceNumber = instanceCount++;
this.parentFrame = parent;
}
protected void init()
{
TwoColumnLayout layout;
super.removeAll();
uiElements.clear();
// ----------------------------------------------------
// get a locale database
// ----------------------------------------------------
try
{
// this.langpack = parent.langpack;
String resource = LANG_FILE_NAME + "_" + idata.localeISO3;
this.langpack = new LocaleDatabase(ResourceManager.getInstance().getInputStream(
resource));
}
catch (Throwable exception)
{
}
// ----------------------------------------------------
// read the specifications
// ----------------------------------------------------
try
{
readSpec();
}
catch (Throwable exception)
{
// log the problem
exception.printStackTrace();
}
// ----------------------------------------------------
// Set the topBuffer from the attribute. topBuffer=0 is useful
// if you don't want your panel to be moved up and down during
// dynamic validation (showing and hiding components within the
// same panel)
// ----------------------------------------------------
int topbuff = 25;
try
{
topbuff = Integer.parseInt(spec.getAttribute(TOPBUFFER));
}
catch (Exception ex)
{
}
finally
{
layout = new TwoColumnLayout(10, 5, 30, topbuff, TwoColumnLayout.LEFT);
}
setLayout(layout);
if (!haveSpec)
{
// return if we could not read the spec. further
// processing will only lead to problems. In this
// case we must skip the panel when it gets activated.
return;
}
// refresh variables specified in spec
updateVariables();
// ----------------------------------------------------
// process all field nodes. Each field node is analyzed
// for its type, then an appropriate memeber function
// is called that will create the correct UI elements.
// ----------------------------------------------------
Vector fields = spec.getChildrenNamed(FIELD_NODE_ID);
for (int i = 0; i < fields.size(); i++)
{
XMLElement field = fields.elementAt(i);
String attribute = field.getAttribute(TYPE);
String conditionid = field.getAttribute(ATTRIBUTE_CONDITIONID_NAME);
if (conditionid != null)
{
// check if condition is fulfilled
if (!this.parent.getRules().isConditionTrue(conditionid, idata.getVariables()))
{
continue;
}
}
if (attribute != null)
{
if (attribute.equals(RULE_FIELD))
{
addRuleField(field);
}
else if (attribute.equals(TEXT_FIELD))
{
addTextField(field);
}
else if (attribute.equals(COMBO_FIELD))
{
addComboBox(field);
}
else if (attribute.equals(RADIO_FIELD))
{
addRadioButton(field);
}
else if (attribute.equals(PWD_FIELD))
{
addPasswordField(field);
}
else if (attribute.equals(SPACE_FIELD))
{
addSpace(field);
}
else if (attribute.equals(DIVIDER_FIELD))
{
addDivider(field);
}
else if (attribute.equals(CHECK_FIELD))
{
addCheckBox(field);
}
else if (attribute.equals(STATIC_TEXT))
{
addText(field);
}
else if (attribute.equals(TITLE_FIELD))
{
addTitle(field);
}
else if (attribute.equals(SEARCH_FIELD))
{
addSearch(field);
}
else if (attribute.equals(FILE_FIELD))
{
addFileField(field);
}
else if (attribute.equals(DIR_FIELD))
{
addDirectoryField(field);
}
}
}
}
private void addDirectoryField(XMLElement field)
{
Vector forPacks = field.getChildrenNamed(SELECTEDPACKS);
Vector forOs = field.getChildrenNamed(OS);
JLabel label;
String set;
int size;
String filter = null;
String filterdesc = null;
String variable = field.getAttribute(VARIABLE);
if ((variable == null) || (variable.length() == 0))
{
return;
}
XMLElement element = field.getFirstChildNamed(SPEC);
if (element == null)
{
Debug.trace("Error: no spec element defined in file field");
return;
}
else
{
label = new JLabel(getText(element));
// ----------------------------------------------------
// extract the specification details
// ----------------------------------------------------
set = element.getAttribute(SET);
if (set == null)
{
set = idata.getVariable(variable);
if (set == null)
{
set = "";
}
}
else
{
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
set = vs.substitute(set, null);
}
}
try
{
size = Integer.parseInt(element.getAttribute(TEXT_SIZE));
}
catch (Throwable exception)
{
size = 1;
}
filter = element.getAttribute("fileext");
if (filter == null)
{
filter = "";
}
filterdesc = element.getAttribute("fileextdesc");
if (filterdesc == null)
{
filterdesc = "";
}
// internationalize it
filterdesc = idata.langpack.getString(filterdesc);
}
final JTextField filetxt = new JTextField(set, size);
filetxt.setCaretPosition(0);
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.WEST;
uiElements.add(new Object[]{null, FIELD_LABEL, null, constraints, label, forPacks, forOs});
TwoColumnConstraints constraints2 = new TwoColumnConstraints();
constraints2.position = TwoColumnConstraints.EAST;
// TODO: use separate key for button text
JButton button = ButtonFactory.createButton(idata.langpack.getString("UserInputPanel.search.browse"), idata.buttonsHColor);
button.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
System.out.println("Show dirchooser");
JFileChooser filechooser = new JFileChooser(currentDirectoryPath);
filechooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
if (filechooser.showOpenDialog(parentFrame) == JFileChooser.APPROVE_OPTION)
{
filetxt.setText(filechooser.getSelectedFile().getAbsolutePath());
currentDirectoryPath = filechooser.getSelectedFile().getAbsolutePath();
Debug.trace("Setting current file chooser directory to: " + currentDirectoryPath);
}
}
});
JPanel panel = new JPanel();
panel.add(filetxt);
panel.add(button);
uiElements.add(new Object[]{null, DIR_FIELD, variable, constraints2, panel, forPacks,
forOs});
}
private void addFileField(XMLElement field)
{
Vector forPacks = field.getChildrenNamed(SELECTEDPACKS);
Vector forOs = field.getChildrenNamed(OS);
JLabel label;
String set;
int size;
String filter = null;
String filterdesc = null;
String variable = field.getAttribute(VARIABLE);
if ((variable == null) || (variable.length() == 0))
{
return;
}
XMLElement element = field.getFirstChildNamed(SPEC);
if (element == null)
{
Debug.trace("Error: no spec element defined in file field");
return;
}
else
{
label = new JLabel(getText(element));
// ----------------------------------------------------
// extract the specification details
// ----------------------------------------------------
set = element.getAttribute(SET);
if (set == null)
{
set = idata.getVariable(variable);
if (set == null)
{
set = "";
}
}
else
{
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
set = vs.substitute(set, null);
}
}
try
{
size = Integer.parseInt(element.getAttribute(TEXT_SIZE));
}
catch (Throwable exception)
{
size = 1;
}
filter = element.getAttribute("fileext");
if (filter == null)
{
filter = "";
}
filterdesc = element.getAttribute("fileextdesc");
if (filterdesc == null)
{
filterdesc = "";
}
// internationalize it
filterdesc = idata.langpack.getString(filterdesc);
}
final JTextField filetxt = new JTextField(set, size);
filetxt.setCaretPosition(0);
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.WEST;
uiElements.add(new Object[]{null, FIELD_LABEL, null, constraints, label, forPacks, forOs});
TwoColumnConstraints constraints2 = new TwoColumnConstraints();
constraints2.position = TwoColumnConstraints.EAST;
final UserInputFileFilter uiff = new UserInputFileFilter();
uiff.setFileExt(filter);
uiff.setFileExtDesc(filterdesc);
// TODO: use separate key for button text
JButton button = ButtonFactory.createButton(idata.langpack.getString("UserInputPanel.search.browse"), idata.buttonsHColor);
button.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
System.out.println("Show filechooser");
JFileChooser filechooser = new JFileChooser(currentDirectoryPath);
filechooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
filechooser.setFileFilter(uiff);
if (filechooser.showOpenDialog(parentFrame) == JFileChooser.APPROVE_OPTION)
{
filetxt.setText(filechooser.getSelectedFile().getAbsolutePath());
currentDirectoryPath = filechooser.getSelectedFile().getParent();
Debug.trace("Setting current file chooser directory to: " + currentDirectoryPath);
}
}
});
JPanel panel = new JPanel();
panel.add(filetxt);
panel.add(button);
uiElements.add(new Object[]{null, FILE_FIELD, variable, constraints2, panel, forPacks,
forOs});
}
protected void updateUIElements()
{
boolean updated = false;
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
for (int i = 0; i < uiElements.size(); i++)
{
Object[] element = uiElements.get(i);
if (element[POS_VARIABLE] == null)
{
continue;
}
String value = idata.getVariable((String) element[POS_VARIABLE]);
if (RADIO_FIELD.equals(element[POS_TYPE]))
{
// we have a radio field, which should be updated
JRadioButton choice = (JRadioButton) element[POS_FIELD];
if (value == null)
{
continue;
}
if (value.equals(element[POS_TRUE]))
{
choice.setSelected(true);
}
else
{
choice.setSelected(false);
}
element[POS_FIELD] = choice;
}
else if (TEXT_FIELD.equals(element[POS_TYPE]))
{
// update TextField
TextInputField textf = (TextInputField) element[POS_FIELD];
if (value == null)
{
value = textf.getText();
}
textf.setText(vs.substitute(value, null));
element[POS_FIELD] = textf;
}
else if (CHECK_FIELD.equals(element[POS_TYPE]))
{
// TODO: HAS TO BE IMPLEMENTED
}
else if (SEARCH_FIELD.equals(element[POS_TYPE]))
{
// TODO: HAS TO BE IMPLEMENTED
}
else if (RULE_FIELD.equals(element[POS_TYPE]))
{
RuleInputField rulef = (RuleInputField) element[POS_FIELD];
// System.out.println("RuleInputField: " + value);
if (value == null)
{
value = rulef.getText();
}
}
else if (FIELD_BUTTON.equals(element[POS_TYPE]))
{
// nothing to do
}
// overwrite entry;
uiElements.set(i, element);
updated = true;
}
if (updated)
{
// super.removeAll();
super.invalidate();
// buildUI();
}
}
/*--------------------------------------------------------------------------*/
/**
* Indicates wether the panel has been validated or not. The installer won't let the user go
* further through the installation process until the panel is validated. Default behavior is to
* return true.
*
* @return A boolean stating wether the panel has been validated or not.
*/
/*--------------------------------------------------------------------------*/
public boolean isValidated()
{
return readInput();
}
/*--------------------------------------------------------------------------*/
/**
* This method is called when the panel becomes active.
*/
/*--------------------------------------------------------------------------*/
public void panelActivate()
{
this.init();
if (spec == null)
{
// TODO: translate
emitError("User input specification could not be found.",
"The specification for the user input panel could not be found. Please contact the packager.");
parentFrame.skipPanel();
}
// update UI with current values of associated variables
updateUIElements();
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forUnselectedPacks = spec.getChildrenNamed(UNSELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
if (!itemRequiredFor(forPacks) || !itemRequiredForUnselected(forUnselectedPacks)
|| !itemRequiredForOs(forOs))
{
parentFrame.skipPanel();
return;
}
if (!haveSpec)
{
parentFrame.skipPanel();
return;
}
// if (uiBuilt)
// {
// return;
// }
buildUI();
//need a validation, else ui is scrambled
this.setSize(this.getMaximumSize().width, this.getMaximumSize().height);
validate();
if (packsDefined)
{
parentFrame.lockPrevButton();
}
}
/*--------------------------------------------------------------------------*/
/**
* Asks the panel to set its own XML data that can be brought back for an automated installation
* process. Use it as a blackbox if your panel needs to do something even in automated mode.
*
* @param panelRoot The XML root element of the panels blackbox tree.
*/
/*--------------------------------------------------------------------------*/
public void makeXMLData(XMLElement panelRoot)
{
Map entryMap = new HashMap();
for (int i = 0; i < entries.size(); i++)
{
TextValuePair pair = entries.elementAt(i);
entryMap.put(pair.toString(), pair.getValue());
}
new UserInputPanelAutomationHelper(entryMap).makeXMLData(idata, panelRoot);
}
/*--------------------------------------------------------------------------*/
/**
* Builds the UI and makes it ready for display
*/
/*--------------------------------------------------------------------------*/
private void buildUI()
{
Object[] uiElement;
for (int i = 0; i < uiElements.size(); i++)
{
uiElement = uiElements.elementAt(i);
if (itemRequiredFor((Vector) uiElement[POS_PACKS])
&& itemRequiredForOs((Vector) uiElement[POS_OS]))
{
try
{
if (uiElement[POS_DISPLAYED] == null
|| "false".equals(uiElement[POS_DISPLAYED].toString()))
{
add((JComponent) uiElement[POS_FIELD], uiElement[POS_CONSTRAINTS]);
}
uiElement[POS_DISPLAYED] = true;
uiElements.remove(i);
uiElements.add(i, uiElement);
}
catch (Throwable exception)
{
System.out.println("Internal format error in field: "
+ uiElement[POS_TYPE].toString()); // !!! logging
}
}
else
{
try
{
if (uiElement[POS_DISPLAYED] != null
&& "true".equals(uiElement[POS_DISPLAYED].toString()))
{
remove((JComponent) uiElement[POS_FIELD]);
}
}
catch (Throwable exception)
{
System.out.println("Internal format error in field: "
+ uiElement[POS_TYPE].toString()); // !!! logging
}
uiElement[POS_DISPLAYED] = false;
uiElements.remove(i);
uiElements.add(i, uiElement);
}
}
}
/*--------------------------------------------------------------------------*/
/**
* Reads the input data from all UI elements and sets the associated variables.
*
* @return true if the operation is successdul, otherwise false.
*/
/*--------------------------------------------------------------------------*/
private boolean readInput()
{
boolean success;
String fieldType = null;
Object[] field = null;
passwordGroupsRead.clear();
// ----------------------------------------------------
// cycle through all but the password fields and read
// their contents
// ----------------------------------------------------
for (int i = 0; i < uiElements.size(); i++)
{
field = uiElements.elementAt(i);
if ((field != null) && ((Boolean) field[POS_DISPLAYED]))
{
fieldType = (String) (field[POS_TYPE]);
// ------------------------------------------------
if (fieldType.equals(RULE_FIELD))
{
success = readRuleField(field);
if (!success)
{
return (false);
}
}
// ------------------------------------------------
if (fieldType.equals(PWD_FIELD))
{
success = readPasswordField(field);
if (!success)
{
return (false);
}
}
// ------------------------------------------------
else if (fieldType.equals(TEXT_FIELD))
{
success = readTextField(field);
if (!success)
{
return (false);
}
}
// ------------------------------------------------
else if (fieldType.equals(COMBO_FIELD))
{
success = readComboBox(field);
if (!success)
{
return (false);
}
}
// ------------------------------------------------
else if (fieldType.equals(RADIO_FIELD))
{
success = readRadioButton(field);
if (!success)
{
return (false);
}
}
// ------------------------------------------------
else if (fieldType.equals(CHECK_FIELD))
{
success = readCheckBox(field);
if (!success)
{
return (false);
}
}
else if (fieldType.equals(SEARCH_FIELD))
{
success = readSearch(field);
if (!success)
{
return (false);
}
}
else if (fieldType.equals(FILE_FIELD))
{
success = readFileField(field);
if (!success)
{
return (false);
}
}
else if (fieldType.equals(DIR_FIELD))
{
success = readDirectoryField(field);
if (!success)
{
return (false);
}
}
}
}
return (true);
}
private boolean readDirectoryField(Object[] field)
{
try
{
JPanel panel = (JPanel) field[POS_FIELD];
JTextField textf = (JTextField) panel.getComponent(0);
String file = textf.getText();
if (file != null)
{
File ffile = new File(file);
if (ffile.isDirectory())
{
idata.setVariable((String) field[POS_VARIABLE], file);
entries.add(new TextValuePair((String) field[POS_VARIABLE], file));
return true;
}
else
{
showMessage("dir.notdirectory");
return false;
}
}
else
{
showMessage("dir.nodirectory");
return false;
}
}
catch (Exception e)
{
if (Debug.stackTracing())
{
Debug.trace(e);
}
return false;
}
}
private void showMessage(String messageType)
{
JOptionPane.showMessageDialog(parent, parent.langpack.getString("UserInputPanel." + messageType + ".message"),
parent.langpack.getString("UserInputPanel." + messageType + ".caption"),
JOptionPane.WARNING_MESSAGE);
}
private boolean readFileField(Object[] field)
{
try
{
JPanel panel = (JPanel) field[POS_FIELD];
JTextField textf = (JTextField) panel.getComponent(0);
String file = textf.getText();
if (file != null)
{
File ffile = new File(file);
if (ffile.isFile())
{
idata.setVariable((String) field[POS_VARIABLE], file);
entries.add(new TextValuePair((String) field[POS_VARIABLE], file));
return true;
}
else
{
showMessage("file.notfile");
return false;
}
}
else
{
showMessage("file.nofile");
return false;
}
}
catch (Exception e)
{
if (Debug.stackTracing())
{
Debug.trace(e);
}
return false;
}
}
/*--------------------------------------------------------------------------*/
/**
* Reads the XML specification for the panel layout. The result is stored in spec.
*
* @throws Exception for any problems in reading the specification
*/
/*--------------------------------------------------------------------------*/
private void readSpec() throws Exception
{
InputStream input = null;
XMLElement data;
Vector specElements;
String attribute;
String panelattribute;
String instance = Integer.toString(instanceNumber);
String panelid = null;
Panel p = this.getMetadata();
if (p != null)
{
panelid = p.getPanelid();
}
try
{
input = parentFrame.getResource(SPEC_FILE_NAME);
}
catch (Exception exception)
{
haveSpec = false;
return;
}
if (input == null)
{
haveSpec = false;
return;
}
// initialize the parser
StdXMLParser parser = new StdXMLParser();
parser.setBuilder(XMLBuilderFactory.createXMLBuilder());
parser.setValidator(new NonValidator());
parser.setReader(new StdXMLReader(input));
// get the data
data = (XMLElement) parser.parse();
// extract the spec to this specific panel instance
if (data.hasChildren())
{
specElements = data.getChildrenNamed(NODE_ID);
for (int i = 0; i < specElements.size(); i++)
{
data = specElements.elementAt(i);
attribute = data.getAttribute(INSTANCE_IDENTIFIER);
panelattribute = data.getAttribute(PANEL_IDENTIFIER);
if (((attribute != null) && instance.equals(attribute))
||
((panelattribute != null) && (panelid != null) && (panelid.equals(panelattribute))))
{
// use the current element as spec
spec = data;
// close the stream
input.close();
haveSpec = true;
return;
}
}
haveSpec = false;
return;
}
haveSpec = false;
}
/*--------------------------------------------------------------------------*/
/**
* Adds the title to the panel. There can only be one title, if mutiple titles are defined, they
* keep overwriting what has already be defined, so that the last definition is the one that
* prevails.
*
* @param spec a XMLElement containing the specification for the title.
*/
/*--------------------------------------------------------------------------*/
private void addTitle(XMLElement spec)
{
String title = getText(spec);
boolean italic = getBoolean(spec, ITALICS, false);
boolean bold = getBoolean(spec, BOLD, false);
float multiplier = getFloat(spec, SIZE, 2.0f);
int justify = getAlignment(spec);
String icon = getIconName(spec);
if (title != null)
{
JLabel label = null;
ImageIcon imgicon = null;
try
{
imgicon = parent.icons.getImageIcon(icon);
label = LabelFactory.create(title, imgicon, JLabel.TRAILING, true);
}
catch (Exception e)
{
Debug.trace("Icon " + icon + " not found in icon list. " + e.getMessage());
label = LabelFactory.create(title);
}
Font font = label.getFont();
float size = font.getSize();
int style = 0;
if (bold)
{
style += Font.BOLD;
}
if (italic)
{
style += Font.ITALIC;
}
font = font.deriveFont(style, (size * multiplier));
label.setFont(font);
label.setAlignmentX(0);
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.align = justify;
constraints.position = TwoColumnConstraints.NORTH;
add(label, constraints);
}
}
protected String getIconName(XMLElement element)
{
if (element == null)
{
return (null);
}
String key = element.getAttribute(ICON_KEY);
String text = null;
if ((key != null) && (langpack != null))
{
try
{
text = langpack.getString(key);
}
catch (Throwable exception)
{
text = null;
}
}
return (text);
}
/*--------------------------------------------------------------------------*/
/**
* Adds a rule field to the list of UI elements.
*
* @param spec a XMLElement containing the specification for the rule field.
*/
/*--------------------------------------------------------------------------*/
private void addRuleField(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
XMLElement element = spec.getFirstChildNamed(SPEC);
String variable = spec.getAttribute(VARIABLE);
RuleInputField field = null;
JLabel label;
String layout;
String set;
String separator;
String format;
String validator = null;
String message = null;
boolean hasParams = false;
String paramName = null;
String paramValue = null;
HashMap validateParamMap = null;
Vector validateParams = null;
String processor = null;
int resultFormat = RuleInputField.DISPLAY_FORMAT;
// ----------------------------------------------------
// extract the specification details
// ----------------------------------------------------
if (element != null)
{
label = new JLabel(getText(element));
layout = element.getAttribute(RULE_LAYOUT);
set = element.getAttribute(SET);
// retrieve value of variable if not specified
// (does not work here because of special format for set attribute)
// if (set == null)
// {
// set = idata.getVariable (variable);
// }
separator = element.getAttribute(RULE_SEPARATOR);
format = element.getAttribute(RULE_RESULT_FORMAT);
if (format != null)
{
if (format.equals(RULE_PLAIN_STRING))
{
resultFormat = RuleInputField.PLAIN_STRING;
}
else if (format.equals(RULE_DISPLAY_FORMAT))
{
resultFormat = RuleInputField.DISPLAY_FORMAT;
}
else if (format.equals(RULE_SPECIAL_SEPARATOR))
{
resultFormat = RuleInputField.SPECIAL_SEPARATOR;
}
else if (format.equals(RULE_ENCRYPTED))
{
resultFormat = RuleInputField.ENCRYPTED;
}
}
}
// ----------------------------------------------------
// if there is no specification element, return without
// doing anything.
// ----------------------------------------------------
else
{
return;
}
// ----------------------------------------------------
// get the description and add it to the list of UI
// elements if it exists.
// ----------------------------------------------------
element = spec.getFirstChildNamed(DESCRIPTION);
addDescription(element, forPacks, forOs);
// ----------------------------------------------------
// get the validator and processor if they are defined
// ----------------------------------------------------
element = spec.getFirstChildNamed(VALIDATOR);
if (element != null)
{
validator = element.getAttribute(CLASS);
message = getText(element);
// ----------------------------------------------------------
// check and see if we have any parameters for this validator.
// If so, then add them to validateParamMap.
// ----------------------------------------------------------
validateParams = element.getChildrenNamed(RULE_PARAM);
if (validateParams != null && validateParams.size() > 0)
{
hasParams = true;
if (validateParamMap == null)
{
validateParamMap = new HashMap();
}
for (XMLElement validateParam : validateParams)
{
element = validateParam;
paramName = element.getAttribute(RULE_PARAM_NAME);
paramValue = element.getAttribute(RULE_PARAM_VALUE);
validateParamMap.put(paramName, paramValue);
}
}
}
element = spec.getFirstChildNamed(PROCESSOR);
if (element != null)
{
processor = element.getAttribute(CLASS);
}
// ----------------------------------------------------
// create an instance of RuleInputField based on the
// extracted specifications, then add it to the list
// of UI elements.
// ----------------------------------------------------
if (hasParams)
{
field = new RuleInputField(layout, set, separator, validator, validateParamMap,
processor, resultFormat, getToolkit(), idata);
}
else
{
field = new RuleInputField(layout, set, separator, validator, processor, resultFormat,
getToolkit(), idata);
}
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.WEST;
uiElements
.add(new Object[]{null, FIELD_LABEL, null, constraints, label, forPacks, forOs});
TwoColumnConstraints constraints2 = new TwoColumnConstraints();
constraints2.position = TwoColumnConstraints.EAST;
uiElements.add(new Object[]{null, RULE_FIELD, variable, constraints2, field, forPacks,
forOs, null, null, message});
}
/*--------------------------------------------------------------------------*/
/**
* Reads the data from the rule input field and sets the associated variable.
*
* @param field the object array that holds the details of the field.
* @return true if there was no problem reading the data or if there was an
* irrecovarable problem. If there was a problem that can be corrected by the operator, an error
* dialog is popped up and false is returned.
*/
/*--------------------------------------------------------------------------*/
private boolean readRuleField(Object[] field)
{
RuleInputField ruleField = null;
String variable = null;
String message = null;
try
{
ruleField = (RuleInputField) field[POS_FIELD];
variable = (String) field[POS_VARIABLE];
message = (String) field[POS_MESSAGE];
}
catch (Throwable exception)
{
return (true);
}
if ((variable == null) || (ruleField == null))
{
return (true);
}
boolean success = !validating || ruleField.validateContents();
if (!success)
{
showWarningMessageDialog(parentFrame, message);
return (false);
}
idata.setVariable(variable, ruleField.getText());
entries.add(new TextValuePair(variable, ruleField.getText()));
return (true);
}
/*--------------------------------------------------------------------------*/
/**
* Adds a text field to the list of UI elements
*
* @param spec a XMLElement containing the specification for the text field.
*/
/*--------------------------------------------------------------------------*/
private void addTextField(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
XMLElement element = spec.getFirstChildNamed(SPEC);
JLabel label;
String set;
int size;
HashMap validateParamMap = null;
Vector validateParams = null;
String validator = null;
String message = null;
boolean hasParams = false;
TextInputField inputField;
String variable = spec.getAttribute(VARIABLE);
if ((variable == null) || (variable.length() == 0))
{
return;
}
// ----------------------------------------------------
// extract the specification details
// ----------------------------------------------------
if (element != null)
{
label = new JLabel(getText(element));
set = element.getAttribute(SET);
if (set == null)
{
set = idata.getVariable(variable);
if (set == null)
{
set = "";
}
}
else
{
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
set = vs.substitute(set, null);
}
}
try
{
size = Integer.parseInt(element.getAttribute(TEXT_SIZE));
}
catch (Throwable exception)
{
size = 1;
}
}
// ----------------------------------------------------
// if there is no specification element, return without
// doing anything.
// ----------------------------------------------------
else
{
Debug.trace("No specification element, returning.");
return;
}
// ----------------------------------------------------
// get the validator if was defined
// ----------------------------------------------------
element = spec.getFirstChildNamed(VALIDATOR);
if (element != null)
{
validator = element.getAttribute(CLASS);
Debug.trace("Validator found for text field: " + validator);
message = getText(element);
// ----------------------------------------------------------
// check and see if we have any parameters for this validator.
// If so, then add them to validateParamMap.
// ----------------------------------------------------------
validateParams = element.getChildrenNamed(RULE_PARAM);
if (validateParams != null && validateParams.size() > 0)
{
Debug.trace("Validator has " + validateParams.size() + " parameters.");
hasParams = true;
if (validateParamMap == null)
{
validateParamMap = new HashMap();
}
for (XMLElement validateParam : validateParams)
{
element = validateParam;
String paramName = element.getAttribute(RULE_PARAM_NAME);
String paramValue = element.getAttribute(RULE_PARAM_VALUE);
validateParamMap.put(paramName, paramValue);
}
}
}
// ----------------------------------------------------
// get the description and add it to the list UI
// elements if it exists.
// ----------------------------------------------------
element = spec.getFirstChildNamed(DESCRIPTION);
addDescription(element, forPacks, forOs);
// ----------------------------------------------------
// construct the UI element and add it to the list
// ----------------------------------------------------
if (hasParams)
{
inputField = new TextInputField(set, size, validator, validateParamMap);
}
else
{
inputField = new TextInputField(set, size, validator);
}
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.WEST;
uiElements
.add(new Object[]{null, FIELD_LABEL, null, constraints, label, forPacks, forOs});
TwoColumnConstraints constraints2 = new TwoColumnConstraints();
constraints2.position = TwoColumnConstraints.EAST;
uiElements.add(new Object[]{null, TEXT_FIELD, variable, constraints2, inputField, forPacks,
forOs, null, null, message});
}
/*--------------------------------------------------------------------------*/
/**
* Reads data from the text field and sets the associated variable.
*
* @param field the object array that holds the details of the field.
* @return true if there was no problem reading the data or if there was an
* irrecovarable problem. If there was a problem that can be corrected by the operator, an error
* dialog is popped up and false is returned.
*/
/*--------------------------------------------------------------------------*/
private boolean readTextField(Object[] field)
{
TextInputField textField = null;
String variable = null;
String value = null;
String message = null;
try
{
textField = (TextInputField) field[POS_FIELD];
variable = (String) field[POS_VARIABLE];
message = (String) field[POS_MESSAGE];
value = textField.getText();
}
catch (Throwable exception)
{
return (true);
}
if ((variable == null) || (value == null))
{
return (true);
}
// validate the input
Debug.trace("Validating text field");
boolean success = textField.validateContents();
if (!success)
{
Debug.trace("Validation did not pass, message: " + message);
if (message == null)
{
message = "Text entered did not pass validation.";
}
showWarningMessageDialog(parentFrame, message);
return (false);
}
Debug.trace("Field validated");
idata.setVariable(variable, value);
entries.add(new TextValuePair(variable, value));
return (true);
}
/*--------------------------------------------------------------------------*/
/**
* Adds a combo box to the list of UI elements.
* This is a complete example of a valid XML specification
*
*
*
* @param spec a XMLElement containing the specification for the combo box.
*/
/*--------------------------------------------------------------------------*/
private void addComboBox(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
XMLElement element = spec.getFirstChildNamed(SPEC);
String variable = spec.getAttribute(VARIABLE);
TextValuePair listItem = null;
JComboBox field = new JComboBox();
JLabel label;
boolean userinput = false; // is there already user input?
// ----------------------------------------------------
// extract the specification details
// ----------------------------------------------------
if (element != null)
{
label = new JLabel(getText(element));
Vector choices = element.getChildrenNamed(COMBO_CHOICE);
if (choices == null)
{
return;
}
// get current value of associated variable
String currentvariablevalue = idata.getVariable(variable);
if (currentvariablevalue != null)
{
// there seems to be user input
userinput = true;
}
for (int i = 0; i < choices.size(); i++)
{
String processorClass = (choices.elementAt(i))
.getAttribute("processor");
if (processorClass != null && !"".equals(processorClass))
{
String choiceValues = "";
try
{
choiceValues = ((Processor) Class.forName(processorClass).newInstance())
.process(null);
}
catch (Throwable t)
{
t.printStackTrace();
}
String set = (choices.elementAt(i)).getAttribute(SET);
if (set == null)
{
set = "";
}
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
set = vs.substitute(set, null);
}
StringTokenizer tokenizer = new StringTokenizer(choiceValues, ":");
int counter = 0;
while (tokenizer.hasMoreTokens())
{
String token = tokenizer.nextToken();
listItem = new TextValuePair(token, token);
field.addItem(listItem);
if (set.equals(token))
{
field.setSelectedIndex(field.getItemCount() - 1);
}
counter++;
}
}
else
{
String value = (choices.elementAt(i)).getAttribute(COMBO_VALUE);
listItem = new TextValuePair(getText(choices.elementAt(i)), value);
field.addItem(listItem);
if (userinput)
{
// is the current value identical to the value associated with this element
if ((value != null) && (value.length() > 0)
&& (currentvariablevalue.equals(value)))
{
// select it
field.setSelectedIndex(i);
}
// else do nothing
}
else
{
// there is no user input
String set = (choices.elementAt(i)).getAttribute(SET);
if (set != null)
{
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata
.getVariables());
set = vs.substitute(set, null);
}
if (set.equals(TRUE))
{
field.setSelectedIndex(i);
}
}
}
}
}
}
// ----------------------------------------------------
// if there is no specification element, return without
// doing anything.
// ----------------------------------------------------
else
{
return;
}
// ----------------------------------------------------
// get the description and add it to the list of UI
// elements if it exists.
// ----------------------------------------------------
element = spec.getFirstChildNamed(DESCRIPTION);
addDescription(element, forPacks, forOs);
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.WEST;
uiElements
.add(new Object[]{null, FIELD_LABEL, null, constraints, label, forPacks, forOs});
TwoColumnConstraints constraints2 = new TwoColumnConstraints();
constraints2.position = TwoColumnConstraints.EAST;
uiElements.add(new Object[]{null, COMBO_FIELD, variable, constraints2, field, forPacks,
forOs});
}
/*--------------------------------------------------------------------------*/
/**
* Reads the content of the combobox field and substitutes the associated variable.
*
* @param field the object array that holds the details of the field.
* @return true if there was no problem reading the data or if there was an
* irrecovarable problem. If there was a problem that can be corrected by the operator, an error
* dialog is popped up and false is returned.
*/
/*--------------------------------------------------------------------------*/
private boolean readComboBox(Object[] field)
{
String variable;
String value;
JComboBox comboBox;
try
{
variable = (String) field[POS_VARIABLE];
comboBox = (JComboBox) field[POS_FIELD];
value = ((TextValuePair) comboBox.getSelectedItem()).getValue();
}
catch (Throwable exception)
{
return true;
}
if ((variable == null) || (value == null))
{
return true;
}
idata.setVariable(variable, value);
entries.add(new TextValuePair(variable, value));
return true;
}
/*--------------------------------------------------------------------------*/
/**
* Adds a radio button set to the list of UI elements.
* This is a complete example of a valid XML specification
*
*
*
* @param spec a XMLElement containing the specification for the radio button
* set.
*/
/*--------------------------------------------------------------------------*/
private void addRadioButton(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
String variable = spec.getAttribute(VARIABLE);
String value = null;
XMLElement element = null;
ButtonGroup group = new ButtonGroup();
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.BOTH;
constraints.indent = true;
constraints.stretch = true;
// ----------------------------------------------------
// get the description and add it to the list of UI
// elements if it exists.
// ----------------------------------------------------
element = spec.getFirstChildNamed(DESCRIPTION);
addDescription(element, forPacks, forOs);
// ----------------------------------------------------
// extract the specification details
// ----------------------------------------------------
element = spec.getFirstChildNamed(SPEC);
if (element != null)
{
Vector choices = element.getChildrenNamed(RADIO_CHOICE);
if (choices == null)
{
return;
}
// --------------------------------------------------
// process each choice element
// --------------------------------------------------
for (int i = 0; i < choices.size(); i++)
{
JRadioButton choice = new JRadioButton();
choice.setText(getText(choices.elementAt(i)));
String causesValidataion = (choices.elementAt(i)).getAttribute(REVALIDATE);
if (causesValidataion != null && causesValidataion.equals("yes"))
{
choice.addActionListener(this);
}
value = ((choices.elementAt(i)).getAttribute(RADIO_VALUE));
group.add(choice);
String set = (choices.elementAt(i)).getAttribute(SET);
// in order to properly initialize dependent controls
// we must set this variable now
if (idata.getVariable(variable) == null)
{
if (set != null)
{
idata.setVariable(variable, value);
}
}
if (set != null)
{
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
set = vs.substitute(set, null);
}
if (set.equals(TRUE))
{
choice.setSelected(true);
}
}
buttonGroups.add(group);
uiElements.add(new Object[]{null, RADIO_FIELD, variable, constraints, choice,
forPacks, forOs, value, null, null, group});
}
}
}
/*--------------------------------------------------------------------------*/
/**
* Reads the content of the radio button field and substitutes the associated variable.
*
* @param field the object array that holds the details of the field.
* @return true if there was no problem reading the data or if there was an
* irrecovarable problem. If there was a problem that can be corrected by the operator, an error
* dialog is popped up and false is returned.
*/
/*--------------------------------------------------------------------------*/
private boolean readRadioButton(Object[] field)
{
String variable = null;
String value = null;
JRadioButton button = null;
try
{
button = (JRadioButton) field[POS_FIELD];
if (!button.isSelected())
{
return (true);
}
variable = (String) field[POS_VARIABLE];
value = (String) field[POS_TRUE];
}
catch (Throwable exception)
{
return (true);
}
idata.setVariable(variable, value);
entries.add(new TextValuePair(variable, value));
return (true);
}
/*--------------------------------------------------------------------------*/
/**
* Adds one or more password fields to the list of UI elements.
* This is a complete example of a valid XML specification
*
*
*
*
*
* <field type="password" variable="testVariable">
* <description align="left" txt="Please enter your password" id="a key for translated text"/>
* <spec>
* <pwd txt="Password" id="key for the label" size="10" set=""/>
* <pwd txt="Retype password" id="another key for the label" size="10" set=""/>
* </spec>
* <validator class="com.izforge.sample.PWDValidator" txt="Both versions of the password must match" id="key for the error text"/>
* <processor class="com.izforge.sample.PWDEncryptor"/>
* </field>
*
*
* Additionally, parameters and multiple validators can be used to provide
* separate validation and error messages for each case.
*
*
* <field type="password" align="left" variable="keystore.password">
* <spec>
* <pwd txt="Keystore Password:" size="25" set=""/>
* <pwd txt="Retype Password:" size="25" set=""/>
* </spec>
* <validator class="com.izforge.izpack.util.PasswordEqualityValidator" txt="Both keystore passwords must match." id="key for the error text"/>
* <validator class="com.izforge.izpack.util.PasswordKeystoreValidator" txt="Could not validate keystore with password and alias provided." id="key for the error text">
* <param name="keystoreFile" value="${existing.ssl.keystore}"/>
* <param name="keystoreType" value="JKS"/>
* <param name="keystoreAlias" value="${keystore.key.alias}"/>
* </validator>
* </field>
*
*
*
* @param spec a XMLElement containing the specification for the set of password
* fields.
*/
/*--------------------------------------------------------------------------*/
private void addPasswordField(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
String variable = spec.getAttribute(VARIABLE);
String message = null;
String processor = null;
XMLElement element = null;
PasswordGroup group = null;
int size = 0;
// For multiple validator support
Vector validatorsElem = null;
List validatorsList = new ArrayList();
int vsize = 0;
// ----------------------------------------------------
// get the description and add it to the list of UI
// elements if it exists.
// ----------------------------------------------------
element = spec.getFirstChildNamed(DESCRIPTION);
addDescription(element, forPacks, forOs);
// ----------------------------------------------------
// get the validator and processor if they are defined
// ----------------------------------------------------
validatorsElem = spec.getChildrenNamed(VALIDATOR);
if (validatorsElem != null && validatorsElem.size() > 0)
{
vsize = validatorsElem.size();
for (int i = 0; i < vsize; i++)
{
element = validatorsElem.get(i);
String validator = element.getAttribute(CLASS);
message = getText(element);
HashMap validateParamMap = new HashMap();
// ----------------------------------------------------------
// check and see if we have any parameters for this validator.
// If so, then add them to validateParamMap.
// ----------------------------------------------------------
Vector validateParams = element.getChildrenNamed(RULE_PARAM);
if (validateParams != null && validateParams.size() > 0)
{
Iterator iter = validateParams.iterator();
while (iter.hasNext())
{
element = iter.next();
String paramName = element.getAttribute(RULE_PARAM_NAME);
String paramValue = element.getAttribute(RULE_PARAM_VALUE);
// System.out.println("Adding parameter: "+paramName+"="+paramValue);
validateParamMap.put(paramName, paramValue);
}
}
validatorsList.add(new ValidatorContainer(validator, message, validateParamMap));
}
}
element = spec.getFirstChildNamed(PROCESSOR);
if (element != null)
{
processor = element.getAttribute(CLASS);
}
group = new PasswordGroup(idata, validatorsList, processor);
// ----------------------------------------------------
// extract the specification details
// ----------------------------------------------------
element = spec.getFirstChildNamed(SPEC);
if (element != null)
{
Vector inputs = element.getChildrenNamed(PWD_INPUT);
if (inputs == null)
{
return;
}
// --------------------------------------------------
// process each input field
// --------------------------------------------------
XMLElement fieldSpec;
for (int i = 0; i < inputs.size(); i++)
{
fieldSpec = inputs.elementAt(i);
String set = fieldSpec.getAttribute(SET);
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
set = vs.substitute(set, null);
}
JLabel label = new JLabel(getText(fieldSpec));
try
{
size = Integer.parseInt(fieldSpec.getAttribute(PWD_SIZE));
}
catch (Throwable exception)
{
size = 1;
}
// ----------------------------------------------------
// construct the UI element and add it to the list
// ----------------------------------------------------
JPasswordField field = new JPasswordField(set, size);
field.setCaretPosition(0);
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.WEST;
uiElements.add(new Object[]{null, FIELD_LABEL, null, constraints, label,
forPacks, forOs});
TwoColumnConstraints constraints2 = new TwoColumnConstraints();
constraints2.position = TwoColumnConstraints.EAST;
// Removed message to support pulling from multiple validators
uiElements.add(new Object[]{null, PWD_FIELD, variable, constraints2, field,
forPacks, forOs, null, null, null, group
});
// Original
// uiElements.add(new Object[]{null, PWD_FIELD, variable, constraints2, field,
// forPacks, forOs, null, null, message, group
// });
group.addField(field);
}
}
passwordGroups.add(group);
}
/*--------------------------------------------------------------------------*/
/**
* Reads the content of the password field and substitutes the associated variable.
*
* @param field a password group that manages one or more passord fields.
* @return true if there was no problem reading the data or if there was an
* irrecovarable problem. If there was a problem that can be corrected by the operator, an error
* dialog is popped up and false is returned.
*/
/*--------------------------------------------------------------------------*/
private boolean readPasswordField(Object[] field)
{
PasswordGroup group = null;
String variable = null;
String message = null;
try
{
group = (PasswordGroup) field[POS_GROUP];
variable = (String) field[POS_VARIABLE];
// Removed to support grabbing the message from multiple validators
// message = (String) field[POS_MESSAGE];
}
catch (Throwable exception)
{
return (true);
}
if ((variable == null) || (passwordGroupsRead.contains(group)))
{
return (true);
}
passwordGroups.add(group);
//boolean success = !validating || group.validateContents();
boolean success = !validating;
// Use each validator to validate contents
if (!success)
{
int size = group.validatorSize();
// System.out.println("Found "+(size)+" validators");
for (int i = 0; i < size; i++)
{
success = group.validateContents(i);
if (!success)
{
JOptionPane.showMessageDialog(parentFrame, group.getValidatorMessage(i),
parentFrame.langpack.getString("UserInputPanel.error.caption"),
JOptionPane.WARNING_MESSAGE);
break;
}
}
}
// // Changed to show messages for each validator
// if (!success) {
// JOptionPane.showMessageDialog(parentFrame, message, parentFrame.langpack.getString("UserInputPanel.error.caption"), JOptionPane.WARNING_MESSAGE);
// return (false);
// }
if (success)
{
idata.setVariable(variable, group.getPassword());
entries.add(new TextValuePair(variable, group.getPassword()));
}
return success;
}
/*--------------------------------------------------------------------------*/
/**
* Adds a chackbox to the list of UI elements.
*
* @param spec a XMLElement containing the specification for the checkbox.
*/
/*--------------------------------------------------------------------------*/
private void addCheckBox(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
String label = "";
String set = null;
String trueValue = null;
String falseValue = null;
String variable = spec.getAttribute(VARIABLE);
String causesValidataion = null;
XMLElement detail = spec.getFirstChildNamed(SPEC);
if (variable == null)
{
return;
}
if (detail != null)
{
label = getText(detail);
set = detail.getAttribute(SET);
trueValue = detail.getAttribute(TRUE);
falseValue = detail.getAttribute(FALSE);
causesValidataion = detail.getAttribute(REVALIDATE);
String value = idata.getVariable(variable);
Debug.trace("check: value: " + value + ", set: " + set);
if (value != null)
{
// Default is not checked so we only need to check for true
if (value.equals(trueValue))
{
set = TRUE;
}
}
}
JCheckBox checkbox = new JCheckBox(label);
if (causesValidataion != null && causesValidataion.equals("yes"))
{
checkbox.addActionListener(this);
}
if (set != null)
{
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
set = vs.substitute(set, null);
}
if (set.equals(FALSE))
{
checkbox.setSelected(false);
}
if (set.equals(TRUE))
{
checkbox.setSelected(true);
}
}
// ----------------------------------------------------
// get the description and add it to the list of UI
// elements if it exists.
// ----------------------------------------------------
XMLElement element = spec.getFirstChildNamed(DESCRIPTION);
addDescription(element, forPacks, forOs);
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.BOTH;
constraints.stretch = true;
constraints.indent = true;
uiElements.add(new Object[]{null, CHECK_FIELD, variable, constraints, checkbox, forPacks,
forOs, trueValue, falseValue});
}
/*--------------------------------------------------------------------------*/
/**
* Reads the content of the checkbox field and substitutes the associated variable.
*
* @param field the object array that holds the details of the field.
* @return true if there was no problem reading the data or if there was an
* irrecovarable problem. If there was a problem that can be corrected by the operator, an error
* dialog is popped up and false is returned.
*/
/*--------------------------------------------------------------------------*/
private boolean readCheckBox(Object[] field)
{
String variable = null;
String trueValue = null;
String falseValue = null;
JCheckBox box = null;
try
{
box = (JCheckBox) field[POS_FIELD];
variable = (String) field[POS_VARIABLE];
trueValue = (String) field[POS_TRUE];
if (trueValue == null)
{
trueValue = "";
}
falseValue = (String) field[POS_FALSE];
if (falseValue == null)
{
falseValue = "";
}
}
catch (Throwable exception)
{
Debug.trace("readCheckBox(): failed: " + exception);
return (true);
}
if (box.isSelected())
{
Debug.trace("readCheckBox(): selected, setting " + variable + " to " + trueValue);
idata.setVariable(variable, trueValue);
entries.add(new TextValuePair(variable, trueValue));
}
else
{
Debug.trace("readCheckBox(): not selected, setting " + variable + " to " + falseValue);
idata.setVariable(variable, falseValue);
entries.add(new TextValuePair(variable, falseValue));
}
return (true);
}
/*--------------------------------------------------------------------------*/
/**
* Adds a search field to the list of UI elements.
*
* This is a complete example of a valid XML specification
*
*
*
*
*
* <field type="search" variable="testVariable">
* <description text="Description for the search field" id="a key for translated text"/>
* <spec text="label" id="key for the label" filename="the_file_to_search" result="directory" /> <!-- values for result: directory, file -->
* <choice dir="directory1" set="true" /> <!-- default value -->
* <choice dir="dir2" />
* </spec>
* </field>
*
*
*
*
*
* @param spec a XMLElement containing the specification for the search field
*/
/*--------------------------------------------------------------------------*/
private void addSearch(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
XMLElement element = spec.getFirstChildNamed(SPEC);
String variable = spec.getAttribute(VARIABLE);
String filename = null;
String check_filename = null;
int search_type = 0;
int result_type = 0;
JComboBox combobox = new JComboBox();
JLabel label = null;
// System.out.println ("adding search combobox, variable "+variable);
// allow the user to enter something
combobox.setEditable(true);
// ----------------------------------------------------
// extract the specification details
// ----------------------------------------------------
if (element != null)
{
label = new JLabel(getText(element));
// search type is optional (default: file)
search_type = SearchField.TYPE_FILE;
String search_type_str = element.getAttribute(SEARCH_TYPE);
if (search_type_str != null)
{
if (search_type_str.equals(SEARCH_FILE))
{
search_type = SearchField.TYPE_FILE;
}
else if (search_type_str.equals(SEARCH_DIRECTORY))
{
search_type = SearchField.TYPE_DIRECTORY;
}
}
// result type is mandatory too
String result_type_str = element.getAttribute(SEARCH_RESULT);
if (result_type_str == null)
{
return;
}
else if (result_type_str.equals(SEARCH_FILE))
{
result_type = SearchField.RESULT_FILE;
}
else if (result_type_str.equals(SEARCH_DIRECTORY))
{
result_type = SearchField.RESULT_DIRECTORY;
}
else if (result_type_str.equals(SEARCH_PARENTDIR))
{
result_type = SearchField.RESULT_PARENTDIR;
}
else
{
return;
}
// might be missing - null is okay
filename = element.getAttribute(SEARCH_FILENAME);
check_filename = element.getAttribute(SEARCH_CHECKFILENAME);
Vector choices = element.getChildrenNamed(SEARCH_CHOICE);
if (choices == null)
{
return;
}
for (int i = 0; i < choices.size(); i++)
{
XMLElement choice_el = choices.elementAt(i);
if (!OsConstraint.oneMatchesCurrentSystem(choice_el))
{
continue;
}
String value = choice_el.getAttribute(SEARCH_VALUE);
combobox.addItem(value);
String set = (choices.elementAt(i)).getAttribute(SET);
if (set != null)
{
if (set != null && !"".equals(set))
{
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
set = vs.substitute(set, null);
}
if (set.equals(TRUE))
{
combobox.setSelectedIndex(i);
}
}
}
}
// ----------------------------------------------------
// if there is no specification element, return without
// doing anything.
// ----------------------------------------------------
else
{
return;
}
// ----------------------------------------------------
// get the description and add it to the list of UI
// elements if it exists.
// ----------------------------------------------------
element = spec.getFirstChildNamed(DESCRIPTION);
addDescription(element, forPacks, forOs);
TwoColumnConstraints westconstraint1 = new TwoColumnConstraints();
westconstraint1.position = TwoColumnConstraints.WEST;
uiElements.add(new Object[]{null, FIELD_LABEL, null, westconstraint1, label, forPacks,
forOs});
TwoColumnConstraints eastconstraint1 = new TwoColumnConstraints();
eastconstraint1.position = TwoColumnConstraints.EAST;
StringBuffer tooltiptext = new StringBuffer();
if ((filename != null) && (filename.length() > 0))
{
tooltiptext.append(MessageFormat.format(parentFrame.langpack
.getString("UserInputPanel.search.location"), new Object[]{new String[]{filename}}));
}
boolean showAutodetect = (check_filename != null) && (check_filename.length() > 0);
if (showAutodetect)
{
tooltiptext.append(MessageFormat.format(parentFrame.langpack
.getString("UserInputPanel.search.location.checkedfile"), new Object[]{new String[]{check_filename}}));
}
if (tooltiptext.length() > 0)
{
combobox.setToolTipText(tooltiptext.toString());
}
uiElements.add(new Object[]{null, SEARCH_FIELD, variable, eastconstraint1, combobox,
forPacks, forOs});
JPanel buttonPanel = new JPanel();
buttonPanel.setLayout(new com.izforge.izpack.gui.FlowLayout(
com.izforge.izpack.gui.FlowLayout.LEADING));
JButton autodetectButton = ButtonFactory.createButton(parentFrame.langpack
.getString("UserInputPanel.search.autodetect"), idata.buttonsHColor);
autodetectButton.setVisible(showAutodetect);
autodetectButton.setToolTipText(parentFrame.langpack
.getString("UserInputPanel.search.autodetect.tooltip"));
buttonPanel.add(autodetectButton);
JButton browseButton = ButtonFactory.createButton(parentFrame.langpack
.getString("UserInputPanel.search.browse"), idata.buttonsHColor);
buttonPanel.add(browseButton);
TwoColumnConstraints eastonlyconstraint = new TwoColumnConstraints();
eastonlyconstraint.position = TwoColumnConstraints.EASTONLY;
uiElements.add(new Object[]{null, SEARCH_BUTTON_FIELD, null, eastonlyconstraint,
buttonPanel, forPacks, forOs});
searchFields.add(new SearchField(filename, check_filename, parentFrame, combobox,
autodetectButton, browseButton, search_type, result_type));
}
/*--------------------------------------------------------------------------*/
/**
* Reads the content of the search field and substitutes the associated variable.
*
* @param field the object array that holds the details of the field.
* @return true if there was no problem reading the data or if there was an
* irrecovarable problem. If there was a problem that can be corrected by the operator, an error
* dialog is popped up and false is returned.
*/
/*--------------------------------------------------------------------------*/
private boolean readSearch(Object[] field)
{
String variable = null;
String value = null;
JComboBox comboBox = null;
try
{
variable = (String) field[POS_VARIABLE];
comboBox = (JComboBox) field[POS_FIELD];
for (int i = 0; i < this.searchFields.size(); ++i)
{
SearchField sf = this.searchFields.elementAt(i);
if (sf.belongsTo(comboBox))
{
value = sf.getResult();
break;
}
}
}
catch (Throwable exception)
{
return (true);
}
if ((variable == null) || (value == null))
{
return (true);
}
idata.setVariable(variable, value);
entries.add(new TextValuePair(variable, value));
return (true);
}
/*--------------------------------------------------------------------------*/
/**
* Adds text to the list of UI elements
*
* @param spec a XMLElement containing the specification for the text.
*/
/*--------------------------------------------------------------------------*/
private void addText(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
addDescription(spec, forPacks, forOs);
}
/*--------------------------------------------------------------------------*/
/**
* Adds a dummy field to the list of UI elements to act as spacer.
*
* @param spec a XMLElement containing other specifications. At present this
* information is not used but might be in future versions.
*/
/*--------------------------------------------------------------------------*/
private void addSpace(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
JPanel panel = new JPanel();
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.BOTH;
constraints.stretch = true;
uiElements
.add(new Object[]{null, SPACE_FIELD, null, constraints, panel, forPacks, forOs});
}
/*--------------------------------------------------------------------------*/
/**
* Adds a dividing line to the list of UI elements act as separator.
*
* @param spec a XMLElement containing additional specifications.
*/
/*--------------------------------------------------------------------------*/
private void addDivider(XMLElement spec)
{
Vector forPacks = spec.getChildrenNamed(SELECTEDPACKS);
Vector forOs = spec.getChildrenNamed(OS);
JPanel panel = new JPanel();
String alignment = spec.getAttribute(ALIGNMENT);
if (alignment != null)
{
if (alignment.equals(TOP))
{
panel.setBorder(BorderFactory.createMatteBorder(1, 0, 0, 0, Color.gray));
}
else
{
panel.setBorder(BorderFactory.createMatteBorder(0, 0, 1, 0, Color.gray));
}
}
else
{
panel.setBorder(BorderFactory.createMatteBorder(0, 0, 1, 0, Color.gray));
}
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.BOTH;
constraints.stretch = true;
uiElements.add(new Object[]{null, DIVIDER_FIELD, null, constraints, panel, forPacks,
forOs});
}
/*--------------------------------------------------------------------------*/
/**
* Adds a description to the list of UI elements.
*
* @param spec a XMLElement containing the specification for the description.
*/
/*--------------------------------------------------------------------------*/
private void addDescription(XMLElement spec, Vector forPacks, Vector forOs)
{
String description;
TwoColumnConstraints constraints = new TwoColumnConstraints();
constraints.position = TwoColumnConstraints.BOTH;
constraints.stretch = true;
if (spec != null)
{
description = getText(spec);
// if we have a description, add it to the UI elements
if (description != null)
{
String alignment = spec.getAttribute(ALIGNMENT);
// FIX needed: where do we use this variable at all? i dont think so...
int justify = MultiLineLabel.LEFT;
if (alignment != null)
{
if (alignment.equals(LEFT))
{
justify = MultiLineLabel.LEFT;
}
else if (alignment.equals(CENTER))
{
justify = MultiLineLabel.CENTER;
}
else if (alignment.equals(RIGHT))
{
justify = MultiLineLabel.RIGHT;
}
}
javax.swing.JTextPane label = new javax.swing.JTextPane();
// Not editable, but still selectable.
label.setEditable(false);
// If html tags are present enable html rendering, otherwise the JTextPane
// looks exactly like MultiLineLabel.
if (description.startsWith("") && description.endsWith(""))
{
label.setContentType("text/html");
}
label.setText(description);
// Background color and font to match the label's.
label.setBackground(javax.swing.UIManager.getColor("label.backgroud"));
label.setMargin(new java.awt.Insets(3, 0, 3, 0));
// workaround to cut out layout problems
label.getPreferredSize();
// end of workaround.
uiElements.add(new Object[]{null, DESCRIPTION, null, constraints, label,
forPacks, forOs});
}
}
}
/*--------------------------------------------------------------------------*/
/**
* Retrieves the value of a boolean attribute. If the attribute is found and the values equals
* the value of the constant TRUE then true is returned. If it equals
* FALSE the false is returned. In all other cases, including when the attribute
* is not found, the default value is returned.
*
* @param element the XMLElement to search for the attribute.
* @param attribute the attribute to search for
* @param defaultValue the default value to use if the attribute does not exist or a illegal
* value was discovered.
* @return true if the attribute is found and the value equals the the constant
* TRUE. < if the
* attribute is FALSE. In all other cases the
* default value is returned.
*/
/*--------------------------------------------------------------------------*/
private boolean getBoolean(XMLElement element, String attribute, boolean defaultValue)
{
boolean result = defaultValue;
if ((attribute != null) && (attribute.length() > 0))
{
String value = element.getAttribute(attribute);
if (value != null)
{
if (value.equals(TRUE))
{
result = true;
}
else if (value.equals(FALSE))
{
result = false;
}
}
}
return (result);
}
/*--------------------------------------------------------------------------*/
/**
* Retrieves the value of an integer attribute. If the attribute is not found or the value is
* non-numeric then the default value is returned.
*
* @param element the XMLElement to search for the attribute.
* @param attribute the attribute to search for
* @param defaultValue the default value to use in case the attribute does not exist.
* @param element the XMLElement to search for the attribute.
* @param attribute the attribute to search for
* @param defaultValue the default value to use in case the attribute does not exist.
* @param element the XMLElement to search for the attribute.
* @param attribute the attribute to search for
* @param defaultValue the default value to use in case the attribute does not exist.
* @return the value of the attribute. If the attribute is not found or the content is not a
* legal integer, then the default value is returned.
*/
/*--------------------------------------------------------------------------*/
// private int getInt(XMLElement element, String attribute, int defaultValue)
// {
// int result = defaultValue;
//
// if ((attribute != null) && (attribute.length() > 0))
// {
// try
// {
// result = Integer.parseInt(element.getAttribute(attribute));
// }
// catch (Throwable exception)
// {}
// }
//
// return (result);
// }
/*--------------------------------------------------------------------------*/
/**
* Retrieves the value of a floating point attribute. If the attribute is not found or the value
* is non-numeric then the default value is returned.
*
* @param element the XMLElement to search for the attribute.
* @param attribute the attribute to search for
* @param defaultValue the default value to use in case the attribute does not exist.
*
* @return the value of the attribute. If the attribute is not found or the content is not a
* legal integer, then the default value is returned.
*/
/*--------------------------------------------------------------------------*/
private float getFloat(XMLElement element, String attribute, float defaultValue)
{
float result = defaultValue;
if ((attribute != null) && (attribute.length() > 0))
{
try
{
result = Float.parseFloat(element.getAttribute(attribute));
}
catch (Throwable exception)
{
}
}
return (result);
}
/*--------------------------------------------------------------------------*/
/**
* Extracts the text from an XMLElement. The text must be defined in the
* resource file under the key defined in the id attribute or as value of the
* attribute text.
*
* @param element the XMLElement from which to extract the text.
* @return The text defined in the XMLElement. If no text can be located,
* null is returned.
*/
/*--------------------------------------------------------------------------*/
private String getText(XMLElement element)
{
if (element == null)
{
return (null);
}
String key = element.getAttribute(KEY);
String text = null;
if ((key != null) && (langpack != null))
{
try
{
text = langpack.getString(key);
}
catch (Throwable exception)
{
text = null;
}
}
// if there is no text in the description, then
// we were unable to retrieve it form the resource.
// In this case try to get the text directly from
// the XMLElement
if (text == null)
{
text = element.getAttribute(TEXT);
}
// try to parse the text, and substitute any variable it finds
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
return (vs.substitute(text, null));
}
/*--------------------------------------------------------------------------*/
/**
* Retreives the alignment setting for the XMLElement. The default value in case
* the ALIGNMENT attribute is not found or the value is illegal is
* TwoColumnConstraints.LEFT.
*
* @param element the XMLElement from which to extract the alignment setting.
* @return the alignement setting for the XMLElement. The value is either
* TwoColumnConstraints.LEFT, TwoColumnConstraints.CENTER or
* TwoColumnConstraints.RIGHT.
* @see com.izforge.izpack.gui.TwoColumnConstraints
*/
/*--------------------------------------------------------------------------*/
private int getAlignment(XMLElement element)
{
int result = TwoColumnConstraints.LEFT;
String value = element.getAttribute(ALIGNMENT);
if (value != null)
{
if (value.equals(LEFT))
{
result = TwoColumnConstraints.LEFT;
}
else if (value.equals(CENTER))
{
result = TwoColumnConstraints.CENTER;
}
else if (value.equals(RIGHT))
{
result = TwoColumnConstraints.RIGHT;
}
}
return (result);
}
/**
* Verifies if an item is required for the operating system the installer executed. The
* configuration for this feature is: <os family="unix"/>
*
* Note:
* If the list of the os is empty then true is always returnd.
*
* @param os The Vector of Strings. containing the os names
* @return true if the item is required for the os, otherwise returns
* false.
*/
public boolean itemRequiredForOs(Vector os)
{
if (os.size() == 0)
{
return true;
}
for (int i = 0; i < os.size(); i++)
{
String family = (os.elementAt(i)).getAttribute(FAMILY);
boolean match = false;
if ("windows".equals(family))
{
match = OsVersion.IS_WINDOWS;
}
else if ("mac".equals(family))
{
match = OsVersion.IS_OSX;
}
else if ("unix".equals(family))
{
match = OsVersion.IS_UNIX;
}
if (match)
{
return true;
}
}
return false;
}
/*--------------------------------------------------------------------------*/
/**
* Verifies if an item is required for any of the packs listed. An item is required for a pack
* in the list if that pack is actually selected for installation.
*
* Note:
* If the list of selected packs is empty then true is always returnd. The same
* is true if the packs list is empty.
*
* @param packs a Vector of Strings. Each of the strings denotes
* a pack for which an item should be created if the pack is actually installed.
* @return true if the item is required for at least one pack in the list,
* otherwise returns false.
*/
/*--------------------------------------------------------------------------*/
/*
* $ @design
*
* The information about the installed packs comes from InstallData.selectedPacks. This assumes
* that this panel is presented to the user AFTER the PacksPanel.
* --------------------------------------------------------------------------
*/
private boolean itemRequiredFor(Vector packs)
{
String selected;
String required;
if (packs.size() == 0)
{
return (true);
}
// ----------------------------------------------------
// We are getting to this point if any packs have been
// specified. This means that there is a possibility
// that some UI elements will not get added. This
// means that we can not allow to go back to the
// PacksPanel, because the process of building the
// UI is not reversable.
// ----------------------------------------------------
// packsDefined = true;
// ----------------------------------------------------
// analyze if the any of the packs for which the item
// is required have been selected for installation.
// ----------------------------------------------------
for (int i = 0; i < idata.selectedPacks.size(); i++)
{
selected = ((Pack) idata.selectedPacks.get(i)).name;
for (int k = 0; k < packs.size(); k++)
{
required = (packs.elementAt(k)).getAttribute(NAME, "");
if (selected.equals(required))
{
return (true);
}
}
}
return (false);
}
/*--------------------------------------------------------------------------*/
/**
* Verifies if an item is required for any of the packs listed. An item is required for a pack
* in the list if that pack is actually NOT selected for installation.
*
* Note:
* If the list of selected packs is empty then true is always returnd. The same
* is true if the packs list is empty.
*
* @param packs a Vector of Strings. Each of the strings denotes
* a pack for which an item should be created if the pack is actually installed.
* @return true if the item is required for at least one pack in the list,
* otherwise returns false.
*/
/*--------------------------------------------------------------------------*/
/*
* $ @design
*
* The information about the installed packs comes from InstallData.selectedPacks. This assumes
* that this panel is presented to the user AFTER the PacksPanel.
* --------------------------------------------------------------------------
*/
private boolean itemRequiredForUnselected(Vector packs)
{
String selected;
String required;
if (packs.size() == 0)
{
return (true);
}
// ----------------------------------------------------
// analyze if the any of the packs for which the item
// is required have been selected for installation.
// ----------------------------------------------------
for (int i = 0; i < idata.selectedPacks.size(); i++)
{
selected = ((Pack) idata.selectedPacks.get(i)).name;
for (int k = 0; k < packs.size(); k++)
{
required = (packs.elementAt(k)).getAttribute(NAME, "");
if (selected.equals(required))
{
return (false);
}
}
}
return (true);
}
// ----------- Inheritance stuff -----------------------------------------
/**
* Returns the uiElements.
*
* @return Returns the uiElements.
*/
protected Vector getUiElements()
{
return uiElements;
}
// --------------------------------------------------------------------------
// Inner Classes
// --------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/**
* This class can be used to associate a text string and a (text) value.
*/
/*---------------------------------------------------------------------------*/
private static class TextValuePair
{
private String text = "";
private String value = "";
/*--------------------------------------------------------------------------*/
/**
* Constructs a new Text/Value pair, initialized with the text and a value.
*
* @param text the text that this object should represent
* @param value the value that should be associated with this object
*/
/*--------------------------------------------------------------------------*/
public TextValuePair(String text, String value)
{
this.text = text;
this.value = value;
}
/*--------------------------------------------------------------------------*/
/**
* Sets the text
*
* @param text the text for this object
*/
/*--------------------------------------------------------------------------*/
public void setText(String text)
{
this.text = text;
}
/*--------------------------------------------------------------------------*/
/**
* Sets the value of this object
*
* @param value the value for this object
*/
/*--------------------------------------------------------------------------*/
public void setValue(String value)
{
this.value = value;
}
/*--------------------------------------------------------------------------*/
/**
* This method returns the text that was set for the object
*
* @return the object's text
*/
/*--------------------------------------------------------------------------*/
public String toString()
{
return (text);
}
/*--------------------------------------------------------------------------*/
/**
* This method returns the value that was associated with this object
*
* @return the object's value
*/
/*--------------------------------------------------------------------------*/
public String getValue()
{
return (value);
}
}
/*---------------------------------------------------------------------------*/
/**
* This class encapsulates a lot of search field functionality.
*
* A search field supports searching directories and files on the target system. This is a
* helper class to manage all data belonging to a search field.
*/
/*---------------------------------------------------------------------------*/
private class SearchField implements ActionListener
{
/**
* used in constructor - we search for a directory.
*/
public static final int TYPE_DIRECTORY = 1;
/**
* used in constructor - we search for a file.
*/
public static final int TYPE_FILE = 2;
/**
* used in constructor - result of search is the directory.
*/
public static final int RESULT_DIRECTORY = 1;
/**
* used in constructor - result of search is the whole file name.
*/
public static final int RESULT_FILE = 2;
/**
* used in constructor - result of search is the parent directory.
*/
public static final int RESULT_PARENTDIR = 3;
private String filename = null;
private String checkFilename = null;
private JButton autodetectButton = null;
private JButton browseButton = null;
private JComboBox pathComboBox = null;
private int searchType = TYPE_DIRECTORY;
private int resultType = RESULT_DIRECTORY;
private InstallerFrame parent = null;
/*---------------------------------------------------------------------------*/
/**
* Constructor - initializes the object, adds it as action listener to the "autodetect"
* button.
*
* @param filename the name of the file to search for (might be null for searching
* directories)
* @param checkFilename the name of the file to check when searching for directories (the
* checkFilename is appended to a found directory to figure out whether it is the right
* directory)
* @param combobox the JComboBox holding the list of choices; it should be
* editable and contain only Strings
* @param autobutton the autodetection button for triggering autodetection
* @param browsebutton the browse button to look for the file
* @param search_type what to search for - TYPE_FILE or TYPE_DIRECTORY
* @param result_type what to return as the result - RESULT_FILE or RESULT_DIRECTORY or
* RESULT_PARENTDIR
*/
/*---------------------------------------------------------------------------*/
public SearchField(String filename, String checkFilename, InstallerFrame parent,
JComboBox combobox, JButton autobutton, JButton browsebutton, int search_type,
int result_type)
{
this.filename = filename;
this.checkFilename = checkFilename;
this.parent = parent;
this.autodetectButton = autobutton;
this.browseButton = browsebutton;
this.pathComboBox = combobox;
this.searchType = search_type;
this.resultType = result_type;
this.autodetectButton.addActionListener(this);
this.browseButton.addActionListener(this);
/*
* add DocumentListener to manage nextButton if user enters input
*/
((JTextField) this.pathComboBox.getEditor().getEditorComponent()).getDocument().addDocumentListener(new DocumentListener()
{
public void changedUpdate(DocumentEvent e)
{
checkNextButtonState();
}
public void insertUpdate(DocumentEvent e)
{
checkNextButtonState();
}
public void removeUpdate(DocumentEvent e)
{
checkNextButtonState();
}
private void checkNextButtonState()
{
Document doc = ((JTextField) pathComboBox.getEditor().getEditorComponent()).getDocument();
try
{
if (pathMatches(doc.getText(0, doc.getLength())))
{
getInstallerFrame().unlockNextButton(false);
}
else
{
getInstallerFrame().lockNextButton();
}
}
catch (BadLocationException e)
{/*ignore, it not happens*/}
}
});
autodetect();
}
/**
* convenient method
*/
private InstallerFrame getInstallerFrame()
{
return parent;
}
/**
* Check whether the given combobox belongs to this searchfield. This is used when reading
* the results.
*/
public boolean belongsTo(JComboBox combobox)
{
return (this.pathComboBox == combobox);
}
/**
* check whether the given path matches
*/
private boolean pathMatches(String path)
{
if (path != null)
{ // Make sure, path is not null
File file = null;
if ((this.filename == null) || (this.searchType == TYPE_DIRECTORY))
{
file = new File(path);
}
else
{
file = new File(path, this.filename);
}
if (file.exists())
{
if (((this.searchType == TYPE_DIRECTORY) && (file.isDirectory()))
|| ((this.searchType == TYPE_FILE) && (file.isFile())))
{
// no file to check for
if (this.checkFilename == null)
{
return true;
}
file = new File(file, this.checkFilename);
return file.exists();
}
}
// System.out.println (path + " did not match");
} // end if
return false;
}
/**
* perform autodetection
*/
public boolean autodetect()
{
Vector items = new Vector();
/*
* Check if the user has entered data into the ComboBox and add it to the Itemlist
*/
String selected = (String) this.pathComboBox.getSelectedItem();
if (selected == null)
{
parent.lockNextButton();
return false;
}
boolean found = false;
for (int x = 0; x < this.pathComboBox.getItemCount(); x++)
{
if (this.pathComboBox.getItemAt(x).equals(selected))
{
found = true;
}
}
if (!found)
{
// System.out.println("Not found in Itemlist");
this.pathComboBox.addItem(this.pathComboBox.getSelectedItem());
}
// Checks whether a placeholder item is in the combobox
// and resolve the pathes automatically:
// /usr/lib/* searches all folders in usr/lib to find
// /usr/lib/*/lib/tools.jar
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
for (int i = 0; i < this.pathComboBox.getItemCount(); ++i)
{
String path = vs.substitute((String) this.pathComboBox.getItemAt(i), null);
// System.out.println ("autodetecting " + path);
if (path.endsWith("*"))
{
path = path.substring(0, path.length() - 1);
File dir = new File(path);
if (dir.isDirectory())
{
File[] subdirs = dir.listFiles();
for (File subdir : subdirs)
{
String search = subdir.getAbsolutePath();
if (this.pathMatches(search))
{
items.add(search);
}
}
}
}
else
{
if (this.pathMatches(path))
{
items.add(path);
}
}
}
// Make the enties in the vector unique
items = new Vector(new HashSet(items));
// Now clear the combobox and add the items out of the newly
// generated vector
this.pathComboBox.removeAllItems();
for (String item : items)
{
String res = vs.substitute(item, "plain");
// System.out.println ("substitution " + item + ", result " + res);
this.pathComboBox.addItem(res);
}
// loop through all items
for (int i = 0; i < this.pathComboBox.getItemCount(); ++i)
{
String path = (String) this.pathComboBox.getItemAt(i);
if (this.pathMatches(path))
{
this.pathComboBox.setSelectedIndex(i);
parent.unlockNextButton();
return true;
}
}
// if the user entered something else, it's not listed as an item
if (this.pathMatches((String) this.pathComboBox.getSelectedItem()))
{
parent.unlockNextButton();
return true;
}
parent.lockNextButton();
return false;
}
/*--------------------------------------------------------------------------*/
/**
* This is called if one of the buttons has been pressed.
*
* It checks, which button caused the action and acts accordingly.
*/
/*--------------------------------------------------------------------------*/
public void actionPerformed(ActionEvent event)
{
// System.out.println ("autodetection button pressed.");
if (event.getSource() == this.autodetectButton)
{
if (!autodetect())
{
showMessageDialog(parent, "UserInputPanel.search.autodetect.failed.message",
"UserInputPanel.search.autodetect.failed.caption",
JOptionPane.WARNING_MESSAGE);
}
}
else if (event.getSource() == this.browseButton)
{
JFileChooser chooser = new JFileChooser();
if (this.resultType != TYPE_FILE)
{
chooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
}
int result = chooser.showOpenDialog(this.parent);
if (result == JFileChooser.APPROVE_OPTION)
{
File f = chooser.getSelectedFile();
this.pathComboBox.setSelectedItem(f.getAbsolutePath());
// use any given directory directly
if (this.resultType != TYPE_FILE && !this.pathMatches(f.getAbsolutePath()))
{
showMessageDialog(parent, "UserInputPanel.search.wrongselection.message",
"UserInputPanel.search.wrongselection.caption",
JOptionPane.WARNING_MESSAGE);
}
}
}
// we don't care for anything more here - getResult() does the rest
}
/*--------------------------------------------------------------------------*/
/**
* Return the result of the search according to result type.
*
* Sometimes, the whole path of the file is wanted, sometimes only the directory where the
* file is in, sometimes the parent directory.
*
* @return null on error
*/
/*--------------------------------------------------------------------------*/
public String getResult()
{
String item = (String) this.pathComboBox.getSelectedItem();
if (item != null)
{
item = item.trim();
}
String path = item;
File f = new File(item);
if (!f.isDirectory())
{
path = f.getParent();
}
// path now contains the final content of the combo box
if (this.resultType == RESULT_DIRECTORY)
{
return path;
}
else if (this.resultType == RESULT_FILE)
{
if (this.filename != null)
{
return path + File.separatorChar + this.filename;
}
else
{
return item;
}
}
else if (this.resultType == RESULT_PARENTDIR)
{
File dir = new File(path);
return dir.getParent();
}
return null;
}
} // private class SearchFile
protected void updateVariables()
{
/**
* Look if there are new variables defined
*/
Vector variables = spec.getChildrenNamed(VARIABLE_NODE);
RulesEngine rules = parent.getRules();
VariableSubstitutor vs = new VariableSubstitutor(idata.getVariables());
for (int i = 0; i < variables.size(); i++)
{
XMLElement variable = variables.elementAt(i);
String vname = variable.getAttribute(ATTRIBUTE_VARIABLE_NAME);
String vvalue = variable.getAttribute(ATTRIBUTE_VARIABLE_VALUE);
if (vvalue == null)
{
// try to read value element
if (variable.hasChildren())
{
XMLElement value = variable.getFirstChildNamed("value");
vvalue = value.getContent();
}
}
String conditionid = variable.getAttribute(ATTRIBUTE_CONDITIONID_NAME);
if (conditionid != null)
{
// check if condition for this variable is fulfilled
if (!rules.isConditionTrue(conditionid, idata.getVariables()))
{
continue;
}
}
// are there any OS-Constraints?
if (OsConstraint.oneMatchesCurrentSystem(variable))
{
if (vname == null)
{
}
else
{
// vname is given
if (vvalue != null)
{
// try to substitute variables in value field
vvalue = vs.substitute(vvalue, null);
// to cut out circular references
idata.setVariable(vname, "");
vvalue = vs.substitute(vvalue, null);
}
// try to set variable
idata.setVariable(vname, vvalue);
// for save this variable to be used later by Automation Helper
entries.add(new TextValuePair(vname, vvalue));
}
}
}
}
// Repaint all controls and validate them agains the current variables
public void actionPerformed(ActionEvent e)
{
validating = false;
readInput();
panelActivate();
validating = true;
}
/*--------------------------------------------------------------------------*/
/**
* Show localized message dialog basing on given parameters.
*
* @param parentFrame The parent frame.
* @param message The message to print out in dialog box.
* @param caption The caption of dialog box.
* @param messageType The message type (JOptionPane.*_MESSAGE)
*/
/*--------------------------------------------------------------------------*/
private void showMessageDialog(InstallerFrame parentFrame, String message, String caption, int messageType)
{
String localizedMessage = parentFrame.langpack.getString(message);
if ((localizedMessage == null) || (localizedMessage.trim().length() == 0))
{
localizedMessage = message;
}
JOptionPane.showMessageDialog(parentFrame, localizedMessage, caption, messageType);
}
/*--------------------------------------------------------------------------*/
/**
* Show localized warning message dialog basing on given parameters.
*
* @param parentFrame parent frame.
* @param message the message to print out in dialog box.
*/
/*--------------------------------------------------------------------------*/
private void showWarningMessageDialog(InstallerFrame parentFrame, String message)
{
showMessageDialog(parentFrame, message,
parentFrame.langpack.getString("UserInputPanel.error.caption"),
JOptionPane.WARNING_MESSAGE);
}
} // public class UserInputPanel
/*---------------------------------------------------------------------------*/
class UserInputFileFilter extends FileFilter
{
String fileext = "";
String description = "";
public void setFileExt(String fileext)
{
this.fileext = fileext;
}
public void setFileExtDesc(String desc)
{
this.description = desc;
}
public boolean accept(File pathname)
{
if (pathname.isDirectory())
{
return true;
}
else
{
return pathname.getAbsolutePath().endsWith(this.fileext);
}
}
public String getDescription()
{
return this.description;
}
}
