fiore@0: /*  
fiore@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
fiore@0:   
fiore@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
fiore@0: 
fiore@0:  This program is free software: you can redistribute it and/or modify
fiore@0:  it under the terms of the GNU General Public License as published by
fiore@0:  the Free Software Foundation, either version 3 of the License, or
fiore@0:  (at your option) any later version.
fiore@0: 
fiore@0:  This program is distributed in the hope that it will be useful,
fiore@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
fiore@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
fiore@0:  GNU General Public License for more details.
fiore@0: 
fiore@0:  You should have received a copy of the GNU General Public License
fiore@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
fiore@0: */  
fiore@0: 
fiore@0: package uk.ac.qmul.eecs.ccmi.simpletemplate;
fiore@0: 
fiore@0: import java.awt.Component;
fiore@0: import java.awt.Dimension;
fiore@0: import java.awt.FlowLayout;
fiore@0: import java.awt.Frame;
fiore@0: import java.awt.GridBagLayout;
fiore@0: import java.awt.GridLayout;
fiore@0: import java.awt.event.ActionEvent;
fiore@0: import java.awt.event.KeyEvent;
fiore@0: import java.io.IOException;
fiore@0: import java.text.MessageFormat;
fiore@0: import java.util.ArrayList;
fiore@0: import java.util.Arrays;
fiore@0: import java.util.Collection;
fiore@0: import java.util.LinkedHashMap;
fiore@0: import java.util.LinkedHashSet;
fiore@0: import java.util.ResourceBundle;
fiore@0: import java.util.Set;
fiore@0: 
fiore@0: import javax.swing.AbstractAction;
fiore@0: import javax.swing.DefaultComboBoxModel;
fiore@0: import javax.swing.JCheckBox;
fiore@0: import javax.swing.JComboBox;
fiore@0: import javax.swing.JComponent;
fiore@0: import javax.swing.JPanel;
fiore@0: import javax.swing.JScrollPane;
fiore@0: import javax.swing.JTextField;
fiore@0: import javax.swing.KeyStroke;
fiore@0: import javax.swing.SpinnerModel;
fiore@0: 
fiore@0: import jwizardcomponent.FinishAction;
fiore@0: import jwizardcomponent.JWizardComponents;
fiore@0: import jwizardcomponent.JWizardPanel;
fiore@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.NodeProperties;
fiore@0: import uk.ac.qmul.eecs.ccmi.diagrammodel.NodeProperties.Modifiers;
fiore@0: import uk.ac.qmul.eecs.ccmi.gui.Diagram;
fiore@0: import uk.ac.qmul.eecs.ccmi.gui.Edge;
fiore@0: import uk.ac.qmul.eecs.ccmi.gui.LineStyle;
fiore@0: import uk.ac.qmul.eecs.ccmi.gui.LoopComboBox;
fiore@0: import uk.ac.qmul.eecs.ccmi.gui.LoopSpinnerNumberModel;
fiore@0: import uk.ac.qmul.eecs.ccmi.gui.Node;
fiore@0: import uk.ac.qmul.eecs.ccmi.gui.SpeechSummaryPane;
fiore@0: import uk.ac.qmul.eecs.ccmi.simpletemplate.SimpleShapeNode.ShapeType;
fiore@0: import uk.ac.qmul.eecs.ccmi.sound.SoundEvent;
fiore@0: import uk.ac.qmul.eecs.ccmi.sound.SoundFactory;
fiore@0: import uk.ac.qmul.eecs.ccmi.speech.NarratorFactory;
fiore@0: import uk.ac.qmul.eecs.ccmi.speech.SpeechUtilities;
fiore@0: import uk.ac.qmul.eecs.ccmi.utils.GridBagUtilities;
fiore@0: 
fiore@0: /**
fiore@0:  *
fiore@0:  * A Wizard-like sequence of screens prompted to the user to let they input (e.g. which shape a node will have or how many nodes an edge can connect at most) 
fiore@0:  * how to build a template diagram. A template diagram is a prototype diagram
fiore@0:  * (containing prototype nodes and edges) which can later on be used for creating instances
fiore@0:  * of that type of diagram through clonation. The wizard is completely accessible via audio 
fiore@0:  * as all the content and all focused components names are spoken out by the {@link Narrator} through a text to speech synthesizer.   
fiore@0:  *
fiore@0:  */
fiore@0: public class Wizard {
fiore@0: 	public Wizard(Frame frame, Collection<String> existingDiagrams, Diagram diagramToEdit){
fiore@0: 		dialog = new SpeechWizardDialog(frame);
fiore@0: 		resources = ResourceBundle.getBundle(SpeechWizardDialog.class.getName());
fiore@0: 		
fiore@0: 		model = createModel(diagramToEdit);
fiore@0: 		node = new Model.Node();
fiore@0: 		edge = new Model.Edge();
fiore@0: 		property = new Model.Property();
fiore@0: 		modifier = new Model.Modifier();
fiore@0: 		
fiore@0: 		initWizardComponents(existingDiagrams,diagramToEdit);
fiore@0: 		
fiore@0: 		/* if the user is editing from an existing diagram, they have to choose a new name. They're switched *
fiore@0: 		 * directly to the diagram name panel so they have to enter a new name as they would otherwise       *
fiore@0: 		 * not be allowed to proceed.                                                                        */
fiore@0: 		if(diagramToEdit != null)
fiore@0: 			dialog.getWizardComponents().setCurrentIndex(DIAGRAM_NAME);
fiore@0: 		
fiore@0: 		/* when the user clicks on the finish button they'll be prompted with a summary text area dialog     * 
fiore@0: 		 * describing what they have created so far and asking for a confirmation to proceed with the actual *
fiore@0: 		 * creation of the template.                                                                 		 */
fiore@0: 		dialog.getWizardComponents().setFinishAction(new FinishAction(dialog.getWizardComponents()){
fiore@0: 			@Override
fiore@0: 			public void performAction(){
fiore@0: 				String[] options = {
fiore@0: 						resources.getString("dialog.summary.ok_button_label"),
fiore@0: 						resources.getString("dialog.summary.cancel_button_label")};
fiore@0: 				int result = SpeechSummaryPane.showDialog(
fiore@0: 						dialog, 
fiore@0: 						resources.getString("dialog.summary.title"), 
fiore@0: 						model.toString(),
fiore@0: 						SpeechSummaryPane.OK_CANCEL_OPTION,
fiore@0: 						options);
fiore@0: 				
fiore@0: 				if(result == SpeechSummaryPane.CANCEL){ // user wants to continue editing  
fiore@0: 					SoundFactory.getInstance().play(SoundEvent.CANCEL);
fiore@0: 					return;
fiore@0: 				}
fiore@0: 				/* create the actual diagram (it will be return to the client class by execute()) */
fiore@0: 				diagram = createDiagram(model);
fiore@0: 				dialog.dispose();
fiore@0: 			}
fiore@0: 		});
fiore@0: 	}
fiore@0: 	
fiore@0: 	public Wizard(Frame frame, Collection<String> existingDiagrams){
fiore@0: 		this(frame,existingDiagrams,null);
fiore@0: 	}
fiore@0: 	
fiore@0: 	public Diagram execute(){
fiore@0: 		diagram = null;
fiore@0: 		dialog.show();
fiore@0: 		if(diagram == null)
fiore@0: 			SoundFactory.getInstance().play(SoundEvent.CANCEL);
fiore@0: 		return diagram;
fiore@0: 	}
fiore@0: 	
fiore@0: 	@SuppressWarnings("serial")
fiore@0: 	private void initWizardComponents(Collection<String> existingDiagrams, final Diagram diagramToEdit){
fiore@0: 		/* --- MAIN PANEL --- */
fiore@0: 		String[] choices = {
fiore@0: 				resources.getString("panel.home.choice.diagram_name"),
fiore@0: 				resources.getString("panel.home.choice.nodes"),
fiore@0: 				resources.getString("panel.home.choice.edges"),
fiore@0: 		};
fiore@0: 		int[] nexts = {DIAGRAM_NAME,NODES,EDGES};
fiore@0: 		
fiore@0: 		/* panel for the selection of main tasks when creating the diagram: enter diagram name, create node and      *
fiore@0: 		 * create edge. When a name is assigned an item is added to the selection which allows the user to finish    *
fiore@0: 		 * the template creation, much as they would do by pressing the finish button. If the user edits an existing * 
fiore@0: 		 * diagram they're prompted with a message to enter a new diagram name (as there cannot be two diagrams      *
fiore@0: 		 * with the same name. When the user enters the name the message goes away                                   */
fiore@0: 		add(HOME,new SelectWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.home.title.new"),
fiore@0: 				Arrays.asList(choices),
fiore@0: 				nexts,
fiore@0: 				SpeechWizardPanel.DISABLE_SWITCH
fiore@0: 				){
fiore@0: 			@Override
fiore@0: 			public void update(){
fiore@0: 				if(!model.diagramName.value.isEmpty()){
fiore@0: 					dialog.setFinishButtonEnabled(true);
fiore@0: 					/* if the diagram has a name the template creation can finish. So add a selection item to the *
fiore@0: 					 * comboBox unless it's already there from a previous update (item count < 4 )                */
fiore@0: 					if(comboBox.getItemCount() < 4)
fiore@0: 						((DefaultComboBoxModel)comboBox.getModel()).addElement(resources.getString("panel.home.choice.finish"));
fiore@0: 				}
fiore@0: 				super.update();
fiore@0: 			}
fiore@0: 			@Override
fiore@0: 			public void next(){
fiore@0: 				if(comboBox.getSelectedIndex() == 3)
fiore@0: 					dialog.getWizardComponents().getFinishButton().doClick();
fiore@0: 				else
fiore@0: 					super.next();
fiore@0: 			}
fiore@0: 		});
fiore@0: 
fiore@0: 		/* --- DIAGRAM NAME INPUT PANEL --- */
fiore@0: 		add(DIAGRAM_NAME, new TextWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString(diagramToEdit == null ? "panel.diagram_name.title" : "panel.diagram_name.title.editing_existing_diagram"),
fiore@0: 				existingDiagrams, 
fiore@0: 				HOME, 
fiore@0: 				HOME, 
fiore@0: 				model.diagramName	
fiore@0: 			){
fiore@0: 			@Override
fiore@0: 			public void update(){
fiore@0: 				/* this is a little nasty trick to achieve the following: when the user creates a new diagram out of an already existing 
fiore@0: 				 * one they're directly prompted with this panel. We want the name of the diagram to be there for awareness 
fiore@0: 				 * but at the same time it must not be accepted by the program as it would otherwise clash with 
fiore@0: 				 * with the starting diagam's. As the program accepts it when the text entered in the text field is equal to 
fiore@0: 				 * model.diagramName.value (for when the user wants to re-edit the name of a diagram they're creating) we must 
fiore@0: 				 * fill model.DiagramName.value with the name of the starting diagram to get it shown and spoken out but then 
fiore@0: 				 * it's assigned the empty string not to let the user to go forward */
fiore@0: 				if(diagramToEdit != null && model.diagramName.value.isEmpty()){
fiore@0: 					model.diagramName.value = diagramToEdit.getName();
fiore@0: 					super.update();
fiore@0: 					model.diagramName.value = "";
fiore@0: 				}else{
fiore@0: 					super.update();
fiore@0: 				}
fiore@0: 			}
fiore@0: 		});
fiore@0: 		
fiore@0: 		/* --- NODE ACTION SELECTION PANEL --- */
fiore@0: 		/* decide whether to add a new node or to edit/delete an existing node */ 
fiore@0: 		String[] nodeOptions = {
fiore@0: 				resources.getString("panel.nodes.actions.add"),
fiore@0: 				resources.getString("panel.nodes.actions.edit"),
fiore@0: 				resources.getString("panel.nodes.actions.del"),
fiore@0: 				resources.getString("panel.nodes.actions.finish")};
fiore@0: 		int[] nodeNexts = {NODE_TYPE,NODE_EDIT,NODE_DEL,HOME};
fiore@0: 		add(NODES, new ActionChooserPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				model.nodes.getNames(),
fiore@0: 				resources.getString("panel.nodes.title"),
fiore@0: 				nodeOptions,
fiore@0: 				nodeNexts,
fiore@0: 				HOME,
fiore@0: 				node
fiore@0: 			));
fiore@0: 		
fiore@0: 		/* --- NODE TYPE NAME INPUT PANEL --- */
fiore@0: 		add(NODE_TYPE,new TextWizardPanel(
fiore@0: 			dialog.getWizardComponents(),
fiore@0: 			resources.getString("panel.node_name.title"),
fiore@0: 			model.nodes.getNames(),
fiore@0: 			NODE_SHAPE,
fiore@0: 			NODES,
fiore@0: 			node.type
fiore@0: 			));
fiore@0: 
fiore@0: 		/* --- NODE TO DELETE SELECTION PANEL*/
fiore@0: 		add(NODE_DEL, new DeletePanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.node_del.title"),
fiore@0: 				NODES,
fiore@0: 				NODES,
fiore@0: 				model.nodes));
fiore@0: 		
fiore@0: 		/* -- NODE TO EDIT SELECTION PANEL */
fiore@0: 		add(NODE_EDIT, new EditPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.node_edit.title"),
fiore@0: 				NODE_TYPE,
fiore@0: 				NODES,
fiore@0: 				model.nodes,
fiore@0: 				node
fiore@0: 			));
fiore@0: 		
fiore@0: 		ShapeType[] shapeTypes = ShapeType.values();
fiore@0: 		ArrayList<String> shapeTypeNames = new ArrayList<String>(shapeTypes.length);
fiore@0: 		for(int i=0; i<shapeTypes.length;i++)
fiore@0: 			if(shapeTypes[i] != ShapeType.Transparent)
fiore@0: 				shapeTypeNames.add(shapeTypes[i].toString());
fiore@0: 		
fiore@0: 		/* -- NODE SHAPE SELECTION PANEL --- */ 
fiore@0: 		add(NODE_SHAPE, new SelectWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.node_shape.title"),
fiore@0: 				shapeTypeNames,
fiore@0: 				NODE_YESNO_PROPERTIES,
fiore@0: 				NODE_TYPE,
fiore@0: 				node.shape
fiore@0: 				));
fiore@0: 		
fiore@0: 		/* --- SELECT WHETHER THE THE NODE HAS TO HAVE PROPERTIES --- */
fiore@0: 		String[] yesnoPropertyOptions = {
fiore@0: 				resources.getString("panel.yesno_properties.add"),
fiore@0: 				resources.getString("panel.yesno_properties.finish")
fiore@0: 		};
fiore@0: 		int[] yesnoPropertyNexts = {PROPERTIES,NODES};
fiore@0: 		
fiore@0: 		add(NODE_YESNO_PROPERTIES,new SelectWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.yesno_properties.title"),
fiore@0: 				Arrays.asList(yesnoPropertyOptions),
fiore@0: 				yesnoPropertyNexts,
fiore@0: 				NODE_SHAPE
fiore@0: 				){
fiore@0: 			@Override
fiore@0: 			public void next(){
fiore@0: 				if(comboBox.getSelectedIndex() == 1){
fiore@0: 					Model.Node newNode = new Model.Node();
fiore@0: 					Model.copy(node, newNode);
fiore@0: 					model.nodes.put(newNode.id,newNode);
fiore@0: 				}
fiore@0: 				super.next();
fiore@0: 			}
fiore@0: 		});
fiore@0: 		
fiore@0: 		/* --- PROPERTIES ACTION SELECTION PANEL --- */
fiore@0: 		String[] propertyOptions = {
fiore@0: 				resources.getString("panel.properties.actions.add"),
fiore@0: 				resources.getString("panel.properties.actions.edit"),
fiore@0: 				resources.getString("panel.properties.actions.del"),
fiore@0: 				resources.getString("panel.properties.action.finish")};
fiore@0: 		int[] propertyNexts = {PROPERTY_TYPE,PROPERTY_EDIT,PROPERTY_DEL,NODES};
fiore@0: 		
fiore@0: 		add(PROPERTIES, new ActionChooserPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				node.properties.getNames(),
fiore@0: 				resources.getString("panel.properties.title"),
fiore@0: 				propertyOptions,
fiore@0: 				propertyNexts,
fiore@0: 				NODE_SHAPE,
fiore@0: 				property
fiore@0: 			){
fiore@0: 				@Override
fiore@0: 				public void next(){
fiore@0: 					/* if the user selects finish, create a new node put in it the values of */
fiore@0: 					/* the temporary property and store it in the model                      */  
fiore@0: 					if( (comboBox.getSelectedIndex() == 1 && comboBox.getItemCount() == 2)||
fiore@0: 							(comboBox.getSelectedIndex() == 3 && comboBox.getItemCount() == 4)){ 
fiore@0: 						Model.Node newNode = new Model.Node();
fiore@0: 						Model.copy(node, newNode);
fiore@0: 						model.nodes.put(newNode.id,newNode);
fiore@0: 					}
fiore@0: 					super.next();
fiore@0: 				}
fiore@0: 		});
fiore@0: 		
fiore@0: 		/* --- PROPERTY TYPE NAME INPUT PANEL --- */
fiore@0: 		add(PROPERTY_TYPE,new TextWizardPanel(
fiore@0: 			dialog.getWizardComponents(),
fiore@0: 			resources.getString("panel.property_name.title"),
fiore@0: 			node.properties.getNames(),
fiore@0: 			PROPERTY_POSITION,
fiore@0: 			PROPERTIES,
fiore@0: 			property.type
fiore@0: 			));
fiore@0: 		
fiore@0: 		/* --- PROPERTY TO DELETE SELECTION PANEL --- */
fiore@0: 		add(PROPERTY_DEL, new DeletePanel(
fiore@0: 			dialog.getWizardComponents(),
fiore@0: 			resources.getString("panel.property_del.title"),
fiore@0: 			PROPERTIES,
fiore@0: 			PROPERTIES,
fiore@0: 			node.properties
fiore@0: 			));
fiore@0: 
fiore@0: 		/* --- PROPERTY TO EDIT SELECTION PANEL --- */
fiore@0: 		add(PROPERTY_EDIT, new EditPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.property_edit.title"),
fiore@0: 				PROPERTY_TYPE,
fiore@0: 				PROPERTIES,
fiore@0: 				node.properties,
fiore@0: 				property
fiore@0: 				));
fiore@0: 		
fiore@0: 		/* --- PROPERTY POSITION SELECTION DIALOG --- */
fiore@0: 		SimpleShapeNode.Position positions[] = SimpleShapeNode.Position.values(); 
fiore@0: 		ArrayList<String> positionNames = new ArrayList<String>(positions.length);
fiore@0: 		for(int i=0; i<positions.length;i++)
fiore@0: 			positionNames.add(positions[i].toString());
fiore@0: 		int[] positionNexts = {PROPERTY_YESNO_MODIFIER,PROPERTY_SHAPE};
fiore@0: 		
fiore@0: 		
fiore@0: 		add(PROPERTY_POSITION, new SelectWizardPanel(
fiore@0: 			dialog.getWizardComponents(),
fiore@0: 			resources.getString("panel.property_position.title"),
fiore@0: 			positionNames,
fiore@0: 			positionNexts,
fiore@0: 			PROPERTY_TYPE,
fiore@0: 			property.position
fiore@0: 			));
fiore@0: 		
fiore@0: 		/* --- PROPERTY SHAPE SELECTION DIALOG --- */
fiore@0: 		shapeTypeNames.add(ShapeType.Transparent.toString());
fiore@0: 		add(PROPERTY_SHAPE, new SelectWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.property_shape.title"),
fiore@0: 				shapeTypeNames,
fiore@0: 				PROPERTY_YESNO_MODIFIER,
fiore@0: 				PROPERTY_POSITION,
fiore@0: 				property.shape
fiore@0: 				));
fiore@0: 		
fiore@0: 		/* --- SELECT WHETHER THE THE PROPERTY HAS TO HAVE MODIFIERS --- */
fiore@0: 		String[] yesnoModifierOptions = {
fiore@0: 				resources.getString("panel.yesno_modifiers.add"),
fiore@0: 				resources.getString("panel.yesno_modifiers.finish")
fiore@0: 		};
fiore@0: 		int[] yesnoModifierNexts = {MODIFIERS,PROPERTIES};
fiore@0: 		
fiore@0: 		add(PROPERTY_YESNO_MODIFIER,new SelectWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.yesno_modifiers.title"),
fiore@0: 				Arrays.asList(yesnoModifierOptions),
fiore@0: 				yesnoModifierNexts,
fiore@0: 				PROPERTY_POSITION
fiore@0: 				){
fiore@0: 			@Override
fiore@0: 			public void next(){
fiore@0: 				if(comboBox.getSelectedIndex() == 1){
fiore@0: 					Model.Property newProperty = new Model.Property();
fiore@0: 					Model.copy(property, newProperty);
fiore@0: 					node.properties.put(newProperty.id,newProperty);
fiore@0: 				}
fiore@0: 				super.next();
fiore@0: 			}
fiore@0: 		});
fiore@0: 		/* --- MODIFIERS ACTION SELECTION PANE --- */
fiore@0: 		String[] modifierOptions = {
fiore@0: 				resources.getString("panel.modifiers.actions.add"),
fiore@0: 				resources.getString("panel.modifiers.actions.edit"),
fiore@0: 				resources.getString("panel.modifiers.actions.del"),
fiore@0: 				resources.getString("panel.modifiers.actions.finish")
fiore@0: 		};
fiore@0: 		int[] modifiersNexts = {MODIFIER_TYPE,MODIFIER_EDIT,MODIFIER_DEL,PROPERTIES};
fiore@0: 		
fiore@0: 		add(MODIFIERS, new ActionChooserPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				property.modifiers.getNames(), 
fiore@0: 				resources.getString("panel.modifiers.title"),
fiore@0: 				modifierOptions, 
fiore@0: 				modifiersNexts, 
fiore@0: 				PROPERTY_POSITION, 
fiore@0: 				modifier){
fiore@0: 				
fiore@0: 				@Override
fiore@0: 				public void next(){
fiore@0: 					/* if the user selects finish, create a new property put in it the values of */
fiore@0: 					/* the temporary property and store it in the model                          */
fiore@0: 					if( (comboBox.getSelectedIndex() == 1 && comboBox.getItemCount() == 2)||
fiore@0: 							(comboBox.getSelectedIndex() == 3 && comboBox.getItemCount() == 4)){ 
fiore@0: 						Model.Property newProperty = new Model.Property();
fiore@0: 						Model.copy(property, newProperty);
fiore@0: 						node.properties.put(newProperty.id,newProperty);
fiore@0: 					}
fiore@0: 					super.next();
fiore@0: 				}
fiore@0: 		});
fiore@0: 		
fiore@0: 		/* --- MODIFIER TYPE PANEL --- */
fiore@0: 		add(MODIFIER_TYPE, new TextWizardPanel(
fiore@0: 				dialog.getWizardComponents(), 
fiore@0: 				resources.getString("panel.modifier_type.title"), 
fiore@0: 				property.modifiers.getNames(),
fiore@0: 				MODIFIER_FORMAT, 
fiore@0: 				MODIFIERS,
fiore@0: 				modifier.type
fiore@0: 				));
fiore@0: 		
fiore@0: 		add(MODIFIER_DEL, new DeletePanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.modifier_del.title"), 
fiore@0: 				MODIFIERS, 
fiore@0: 				MODIFIERS, 
fiore@0: 				property.modifiers));
fiore@0: 		
fiore@0: 		add(MODIFIER_EDIT, new EditPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.modifier_edit.title"),
fiore@0: 				MODIFIER_TYPE,
fiore@0: 				MODIFIERS,
fiore@0: 				property.modifiers,
fiore@0: 				modifier
fiore@0: 		));
fiore@0: 		
fiore@0: 		add(MODIFIER_FORMAT, new FormatWizardPanel());
fiore@0: 		/* --- EDGE ACTION SELECTION PANEL --- */
fiore@0: 		/* decide whether to add a new edge or to edit/delete an existing edge */ 
fiore@0: 		String[] edgeOptions = {
fiore@0: 				resources.getString("panel.edges.actions.add"),
fiore@0: 				resources.getString("panel.edges.actions.edit"),
fiore@0: 				resources.getString("panel.edges.actions.del"),
fiore@0: 				resources.getString("panel.edges.actions.finish")};
fiore@0: 		int[] edgeNexts = {EDGE_TYPE,EDGE_EDIT,EDGE_DEL,HOME};
fiore@0: 		add(EDGES, new ActionChooserPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				model.edges.getNames(),
fiore@0: 				resources.getString("panel.edges.title"),
fiore@0: 				edgeOptions,
fiore@0: 				edgeNexts,
fiore@0: 				HOME,
fiore@0: 				edge
fiore@0: 			));
fiore@0: 		
fiore@0: 		/* --- EDGE TYPE NAME INPUT PANEL --- */
fiore@0: 		add(EDGE_TYPE,new TextWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.edge_name.title"),
fiore@0: 				model.edges.getNames(),
fiore@0: 				EDGE_LINE_STYLE,
fiore@0: 				EDGES,
fiore@0: 				edge.type
fiore@0: 		));
fiore@0: 		
fiore@0: 		/* --- EDGE TO DELETE SELECTION PANEL --- */
fiore@0: 		add(EDGE_DEL, new DeletePanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.edge_del.title"),
fiore@0: 				EDGES,
fiore@0: 				EDGES,
fiore@0: 				model.edges));
fiore@0: 		
fiore@0: 		/* --- EDGE TO EDIT SELECTION PANEL --- */
fiore@0: 		add(EDGE_EDIT, new EditPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.edge_edit.title"),
fiore@0: 				EDGE_TYPE,
fiore@0: 				EDGES,
fiore@0: 				model.edges,
fiore@0: 				edge
fiore@0: 			));
fiore@0: 
fiore@0: 		/* --- LINE STYLE SELECTION PANEL --- */
fiore@0: 		LineStyle[] lineStyles = LineStyle.values();	
fiore@0: 		String[] lineStyleNames = new String[lineStyles.length];
fiore@0: 		for(int i=0; i<lineStyles.length;i++)
fiore@0: 			lineStyleNames[i] = lineStyles[i].toString();
fiore@0: 		                                 
fiore@0: 		add(EDGE_LINE_STYLE, new SelectWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.edge_linestyle.title"),
fiore@0: 				Arrays.asList(lineStyleNames),
fiore@0: 				EDGE_MIN_NODES,
fiore@0: 				EDGE_TYPE,
fiore@0: 				edge.lineStyle
fiore@0: 				));
fiore@0: 		
fiore@0: 		/* --- MIN NODES SELECTION PANEL --- */
fiore@0: 		SpinnerModel minNodesSpinnerModel = new LoopSpinnerNumberModel(2,2,4);
fiore@0: 		add(EDGE_MIN_NODES,new SpinnerWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.edge_min_nodes.title"),
fiore@0: 				minNodesSpinnerModel,
fiore@0: 				EDGE_MAX_NODES,
fiore@0: 				EDGE_LINE_STYLE,
fiore@0: 				edge.minNodes
fiore@0: 				));
fiore@0: 		
fiore@0: 		/* --- MAX NODES SELECTION PANEL --- */
fiore@0: 		SpinnerModel maxNodesSpinnerModel = new LoopSpinnerNumberModel(2,2,4);
fiore@0: 		add(EDGE_MAX_NODES, new SpinnerWizardPanel(
fiore@0: 			dialog.getWizardComponents(),
fiore@0: 			resources.getString("panel.edge_max_nodes.title"),
fiore@0: 			maxNodesSpinnerModel,
fiore@0: 			EDGE_YESNO_ARROW_HEAD,
fiore@0: 			EDGE_MIN_NODES,
fiore@0: 			edge.maxNodes
fiore@0: 			){
fiore@0: 				@Override
fiore@0: 				public void next(){
fiore@0: 					int min = Integer.parseInt(edge.minNodes.value);
fiore@0: 					int max = Integer.parseInt(spinner.getValue().toString());
fiore@0: 					if(min > max){
fiore@0: 						NarratorFactory.getInstance().speak(resources.getString("dialog.error.min_max"));
fiore@0: 					}else{
fiore@0: 						super.next();
fiore@0: 					}
fiore@0: 				}
fiore@0: 				
fiore@0: 		});
fiore@0: 		
fiore@0: 		/* --- SELECT WHETHER THE EDGE MUST HAVE ARROW HEADS OR NOT --- */
fiore@0: 		String[] arrowHeadOptions = {
fiore@0: 				resources.getString("panel.edge_yesno_arrow_head.actions.add"),
fiore@0: 				resources.getString("panel.edge_yesno_arrow_head.actions.finish")
fiore@0: 		};
fiore@0: 		int[] arrowHeadNexts = {EDGE_ARROW_HEAD,EDGES};
fiore@0: 		add(EDGE_YESNO_ARROW_HEAD,new SelectWizardPanel(
fiore@0: 				dialog.getWizardComponents(),
fiore@0: 				resources.getString("panel.edge_yesno_arrow_head.title"),
fiore@0: 				Arrays.asList(arrowHeadOptions),
fiore@0: 				arrowHeadNexts,
fiore@0: 				EDGE_MAX_NODES
fiore@0: 				){
fiore@0: 			@Override
fiore@0: 			public void next(){
fiore@0: 				if(comboBox.getSelectedIndex() == 1){
fiore@0: 					Model.Edge newEdge = new Model.Edge();
fiore@0: 					Model.copy(edge, newEdge);
fiore@0: 					model.edges.put(newEdge.id,newEdge);
fiore@0: 				}
fiore@0: 				super.next();
fiore@0: 			}
fiore@0: 		});
fiore@0: 		
fiore@0: 		/* --- ARROW HEAD SELECTION PANEL --- */
fiore@0: 		add(EDGE_ARROW_HEAD, new ArrowHeadPanel());
fiore@0: 		
fiore@0: 		add(LAST_PANEL, new DummyWizardPanel(dialog.getWizardComponents()));
fiore@0: 		
fiore@0: 		SpeechUtilities.changeTabListener((JComponent)dialog.getContentPane(), dialog);
fiore@0: 	}
fiore@0: 	
fiore@0: 	private void add(int index, JWizardPanel panel){
fiore@0: 		dialog.getWizardComponents().addWizardPanel(index,panel);
fiore@0: 	}
fiore@0: 	
fiore@0: 	private Diagram createDiagram(Model model){
fiore@0: 		/* create the node prototypes */
fiore@0: 		Node[] nodes = new Node[model.nodes.size()];
fiore@0: 		int i = 0;
fiore@0: 		for(Model.Node n : model.nodes.values()){
fiore@0: 			nodes[i] = createDiagramNode(n);
fiore@0: 			i++;
fiore@0: 		}
fiore@0: 		/* create the edge prototypes */
fiore@0: 		Edge[] edges = new Edge[model.edges.size()];
fiore@0: 		i = 0;
fiore@0: 		for(Model.Edge e : model.edges.values()){
fiore@0: 			edges[i] = createDiagramEdge(e);
fiore@0: 			i++;
fiore@0: 		}
fiore@0: 		return Diagram.newInstance(model.diagramName.value, nodes, edges, new SimpleShapePrototypePersistenceDelegate());
fiore@0: 	}
fiore@0: 	
fiore@0: 	private Node createDiagramNode(Model.Node n){
fiore@0: 		/* set up the properties */
fiore@0: 		LinkedHashMap<String,Set<String>> propertiesTypeDefinition = new LinkedHashMap<String,Set<String>>();
fiore@0: 		/* create the property type definition */
fiore@0: 		for(Model.Property modelProperty : n.properties.values()){
fiore@0: 			Set<String> modifiersTypeDefinition = new LinkedHashSet<String>();
fiore@0: 			for(Model.Modifier modifier : modelProperty.modifiers.values())
fiore@0: 				modifiersTypeDefinition.add(modifier.type.value);
fiore@0: 			propertiesTypeDefinition.put(modelProperty.type.value, modifiersTypeDefinition);
fiore@0: 		}
fiore@0: 		NodeProperties properties = new NodeProperties(propertiesTypeDefinition);	
fiore@0: 		/* now that properties object is created attach the views on it */
fiore@0: 		for(Model.Property modelProperty : n.properties.values()){
fiore@0: 			PropertyView propertyView = new PropertyView(
fiore@0: 					SimpleShapeNode.Position.valueOf(modelProperty.position.value),
fiore@0: 					modelProperty.shape.value.isEmpty() ? 
fiore@0: 							/* doesn't really matter as position is inside and shape won't be taken into account */ 
fiore@0: 							SimpleShapeNode.ShapeType.Rectangle :   
fiore@0: 							SimpleShapeNode.ShapeType.valueOf(modelProperty.shape.value) 
fiore@0: 					);
fiore@0: 			properties.setView(modelProperty.type.value, propertyView);
fiore@0: 			/* modifier view */
fiore@0: 			for(Model.Modifier modelModifier : modelProperty.modifiers.values()){
fiore@0: 				boolean bold = false;
fiore@0: 				boolean italic = false;
fiore@0: 				boolean underline = false;
fiore@0: 				String prefix = "";
fiore@0: 				String suffix = "";	
fiore@0: 				for(String value : modelModifier.format.values){
fiore@0: 					if(value.equals(resources.getString("modifier.format.bold"))){
fiore@0: 						bold = true;
fiore@0: 					}else if(value.equals(resources.getString("modifier.format.underline"))){
fiore@0: 						underline = true;
fiore@0: 					}else if(value.equals(resources.getString("modifier.format.italic"))){
fiore@0: 						italic = true;
fiore@0: 					}else if(value.equals(resources.getString("modifier.format.prefix"))){
fiore@0: 						prefix = modelModifier.affix.values[PREFIX_INDEX];
fiore@0: 					}else if(value.equals(resources.getString("modifier.format.suffix"))){
fiore@0: 						suffix = modelModifier.affix.values[SUFFIX_INDEX];
fiore@0: 					}
fiore@0: 				}
fiore@0: 				ModifierView modifierView = new ModifierView(underline,bold,italic,prefix,suffix);
fiore@0: 				properties.getModifiers(modelProperty.type.value).setView(modelModifier.type.value, modifierView);
fiore@0: 			}
fiore@0: 		}
fiore@0: 		return SimpleShapeNode.getInstance(
fiore@0: 				SimpleShapeNode.ShapeType.valueOf(n.shape.value), 
fiore@0: 				n.type.value, 
fiore@0: 				properties);
fiore@0: 	}
fiore@0: 	
fiore@0: 	private Edge createDiagramEdge(Model.Edge e){
fiore@0: 		/* create the arrow head array out of the string stored in the model */
fiore@0: 		ArrowHead[] arrowHeads = new ArrowHead[e.arrowHeads.values.length];
fiore@0: 		for(int i=0; i<e.arrowHeads.values.length;i++){
fiore@0: 			try {
fiore@0: 				arrowHeads[i] = ArrowHead.getArrowHeadFromString(e.arrowHeads.values[i]);
fiore@0: 			} catch (IOException ioe) {
fiore@0: 				throw new RuntimeException(ioe);// the wizard mustn't allow the user to enter different strings
fiore@0: 			}
fiore@0: 		}
fiore@0: 		return new SimpleShapeEdge(
fiore@0: 				e.type.value,
fiore@0: 				LineStyle.valueOf(e.lineStyle.value),
fiore@0: 				arrowHeads,
fiore@0: 				e.arrowHeadsDescriptions.values,
fiore@0: 				Integer.parseInt(e.minNodes.value),
fiore@0: 				Integer.parseInt(e.maxNodes.value)
fiore@0: 				);
fiore@0: 	}
fiore@0: 	
fiore@0: 	private Model createModel(Diagram diagram) {
fiore@0: 		Model model = new Model();
fiore@0: 		if(diagram == null)
fiore@0: 			return model;
fiore@0: 		
fiore@0: 		/* the name isn't copied as the user as to find a new one */
fiore@0: 		/* model.diagramName.value = diagram.getName();*/
fiore@0: 
fiore@0: 		/* nodes */
fiore@0: 		for(Node n : diagram.getNodePrototypes()){
fiore@0: 			if(!(n instanceof SimpleShapeNode))
fiore@0: 				continue;
fiore@0: 			Model.Node modelNode = createModelNode((SimpleShapeNode)n);
fiore@0: 			model.nodes.put(modelNode.id,modelNode);
fiore@0: 		}
fiore@0: 		/* edges */
fiore@0: 		for(Edge e : diagram.getEdgePrototypes()){
fiore@0: 			if(!(e instanceof SimpleShapeEdge))
fiore@0: 				continue;
fiore@0: 			Model.Edge modelEdge = createModelEdge((SimpleShapeEdge)e);
fiore@0: 			model.edges.put(modelEdge.id, modelEdge);
fiore@0: 		}
fiore@0: 		return model;
fiore@0: 	}
fiore@0: 	
fiore@0: 	/**
fiore@0: 	 * fills up the model node object with informations from the real diagram node 
fiore@0: 	 * @param n
fiore@0: 	 * @return
fiore@0: 	 */
fiore@0: 	private Model.Node createModelNode(SimpleShapeNode n){
fiore@0: 		Model.Node modelNode = new Model.Node();
fiore@0: 		modelNode.type.value = n.getType();
fiore@0: 		modelNode.shape.value = n.getShapeType().toString();
fiore@0: 		
fiore@0: 		NodeProperties properties = n.getProperties();
fiore@0: 		for(String propertyType : properties.getTypes()){
fiore@0: 			Model.Property modelProperty = new Model.Property();
fiore@0: 			modelProperty.type.value = propertyType;
fiore@0: 			/* if the view is not a PropertyView or is null then assign a default value         */
fiore@0: 			/* it should never happen but it's just to keep it safer and more forward compliant */ 
fiore@0: 			if(! (properties.getView(propertyType) instanceof PropertyView)){
fiore@0: 				modelProperty.position.value = SimpleShapeNode.Position.Inside.toString();
fiore@0: 			}else{
fiore@0: 				PropertyView propertyView = (PropertyView)properties.getView(propertyType);
fiore@0: 				modelProperty.position.value = propertyView.getPosition().toString();
fiore@0: 				modelProperty.shape.value = propertyView.getShapeType().toString();
fiore@0: 			}
fiore@0: 			Modifiers modifiers = properties.getModifiers(propertyType);
fiore@0: 			for(String modifierType : modifiers.getTypes()){
fiore@0: 				Model.Modifier modelModifier = new Model.Modifier();
fiore@0: 				modelModifier.type.value = modifierType;
fiore@0: 				if(modifiers.getView(modifierType) instanceof ModifierView){
fiore@0: 					ModifierView modifierView = (ModifierView)modifiers.getView(modifierType);
fiore@0: 					/* the string array with the modifier values must be created, so the size must be known before */
fiore@0: 					int numModifierValues = 0;
fiore@0: 					if(modifierView.isBold())
fiore@0: 						numModifierValues++;
fiore@0: 					if(modifierView.isItalic())
fiore@0: 						numModifierValues++;
fiore@0: 					if(modifierView.isUnderline())
fiore@0: 						numModifierValues++;
fiore@0: 					if(!modifierView.getPrefix().isEmpty())
fiore@0: 						numModifierValues++;
fiore@0: 					if(!modifierView.getSuffix().isEmpty())
fiore@0: 						numModifierValues++;
fiore@0: 					/* create the string array and fill it up with values */
fiore@0: 					modelModifier.format.values = new String[numModifierValues];
fiore@0: 					numModifierValues = 0;
fiore@0: 					if(modifierView.isBold())
fiore@0: 						modelModifier.format.values[numModifierValues++] = resources.getString("modifier.format.bold");
fiore@0: 					if(modifierView.isItalic())
fiore@0: 						modelModifier.format.values[numModifierValues++] = resources.getString("modifier.format.italic");
fiore@0: 					if(modifierView.isUnderline())
fiore@0: 						modelModifier.format.values[numModifierValues++] = resources.getString("modifier.format.underline");
fiore@0: 					if(!modifierView.getPrefix().isEmpty()){
fiore@0: 						modelModifier.format.values[numModifierValues++] = resources.getString("modifier.format.prefix");
fiore@0: 						modelModifier.affix.values[PREFIX_INDEX] = modifierView.getPrefix(); 
fiore@0: 					}
fiore@0: 							
fiore@0: 					if(!modifierView.getSuffix().isEmpty()){
fiore@0: 						modelModifier.format.values[numModifierValues++] = resources.getString("modifier.format.suffix"); 
fiore@0: 						modelModifier.affix.values[SUFFIX_INDEX] = modifierView.getSuffix();
fiore@0: 					}
fiore@0: 				}
fiore@0: 				modelProperty.modifiers.put(modelModifier.id, modelModifier);
fiore@0: 			}
fiore@0: 			modelNode.properties.put(modelProperty.id, modelProperty);
fiore@0: 		}
fiore@0: 		return modelNode;
fiore@0: 	}
fiore@0: 	
fiore@0: 	private Model.Edge createModelEdge(SimpleShapeEdge e){
fiore@0: 		Model.Edge modelEdge = new Model.Edge();
fiore@0: 		modelEdge.type.value = e.getType();
fiore@0: 		modelEdge.lineStyle.value = e.getStyle().toString();
fiore@0: 		modelEdge.maxNodes.value = Integer.toString(e.getMaxAttachedNodes());
fiore@0: 		modelEdge.minNodes.value = Integer.toString(e.getMinAttachedNodes());
fiore@0: 		
fiore@0: 		/* arrow heads and arrowheads descriptions */
fiore@0: 		modelEdge.arrowHeadsDescriptions.values = e.getAvailableEndDescriptions();
fiore@0: 		modelEdge.arrowHeads.values = new String[e.getHeads().length];
fiore@0: 		for(int i  =0; i<e.getHeads().length;i++){
fiore@0: 			modelEdge.arrowHeads.values[i] = e.getHeads()[i].toString();
fiore@0: 		}
fiore@0: 		
fiore@0: 		return modelEdge;
fiore@0: 	}
fiore@0: 	
fiore@0: 	private SpeechWizardDialog dialog;
fiore@0: 	private Diagram diagram;
fiore@0: 	private ResourceBundle resources;
fiore@0: 	private Model model;
fiore@0: 	/* these are the temporary variables where the data are stored during the wizard  *
fiore@0: 	 * when a sub task is completed ( node creation, edge creation, property creation)*  
fiore@0: 	 * the data stored in the temporary variables are saved in the model              */
fiore@0: 	private Model.Node node;
fiore@0: 	private Model.Property property;
fiore@0: 	private Model.Modifier modifier;
fiore@0: 	private Model.Edge edge;
fiore@0: 	
fiore@0: 	static int HOME = 0;
fiore@0: 	static int DIAGRAM_NAME = 1;
fiore@0: 	static int NODES = 2;
fiore@0: 	static int NODE_TYPE = 3;
fiore@0: 	static int NODE_DEL = 4;
fiore@0: 	static int NODE_EDIT = 5;
fiore@0: 	static int NODE_SHAPE = 6;
fiore@0: 	static int NODE_YESNO_PROPERTIES = 7;
fiore@0: 	static int PROPERTIES = 8;
fiore@0: 	static int PROPERTY_TYPE = 9;
fiore@0: 	static int PROPERTY_DEL = 10;
fiore@0: 	static int PROPERTY_EDIT = 11; 
fiore@0: 	static int PROPERTY_POSITION = 12;
fiore@0: 	static int PROPERTY_SHAPE = 13;
fiore@0: 	static int PROPERTY_YESNO_MODIFIER = 14;
fiore@0: 	static int MODIFIERS = 15;
fiore@0: 	static int MODIFIER_TYPE = 16;
fiore@0: 	static int MODIFIER_DEL = 17;
fiore@0: 	static int MODIFIER_EDIT = 18;
fiore@0: 	static int MODIFIER_FORMAT = 19;
fiore@0: 	static int EDGES = 20;
fiore@0: 	static int EDGE_TYPE = 21; 
fiore@0: 	static int EDGE_DEL = 22; 
fiore@0: 	static int EDGE_EDIT = 23;
fiore@0: 	static int EDGE_LINE_STYLE = 24;
fiore@0: 	static int EDGE_MIN_NODES = 25;
fiore@0: 	static int EDGE_MAX_NODES = 26;
fiore@0: 	static int EDGE_YESNO_ARROW_HEAD = 27;
fiore@0: 	static int EDGE_ARROW_HEAD = 28;
fiore@0: 	static int LAST_PANEL = 29;
fiore@0: 	
fiore@0: 	private static int PREFIX_INDEX = 0;
fiore@0: 	private static int SUFFIX_INDEX = 1;
fiore@0: 	
fiore@0: 	/* the abstract class from which the panels for Nodes, edges and Modifiers inherit 
fiore@0: 	 * It displays the actions (add,edit,delete,finish) on a comboBox. if elementNames is empty 
fiore@0: 	 * it means that no element has been created yet and therefore edit and delete actions are disabled 
fiore@0: 	 */
fiore@0: 	@SuppressWarnings("serial")
fiore@0: 	private static class ActionChooserPanel extends SpeechWizardPanel{
fiore@0: 		ActionChooserPanel(JWizardComponents wizardComponents,Collection<String> elementNames, String title, String[] options, int[] nexts, int previous, Model.Element temporaryElement){
fiore@0: 			super(wizardComponents,title,OWN_SWITCH, previous);
fiore@0: 			this.options = options;
fiore@0: 			comboBoxModel = new DefaultComboBoxModel();
fiore@0: 			comboBoxModel.addElement(options[0]);
fiore@0: 			comboBoxModel.addElement(options[3]);
fiore@0: 			comboBox = new LoopComboBox(comboBoxModel);
fiore@0: 			comboBox.addItemListener(SpeechUtilities.getSpeechComboBoxItemListener());
fiore@0: 			layoutComponents(comboBox);
fiore@0: 			this.elementNames = elementNames;
fiore@0: 			this.temporaryElement = temporaryElement;
fiore@0: 			this.nexts = nexts;
fiore@0: 		}
fiore@0: 
fiore@0: 		@Override
fiore@0: 		public void update(){
fiore@0: 			if(elementNames.isEmpty() && comboBoxModel.getSize() == 4){
fiore@0: 				comboBoxModel.removeElement(options[1]);
fiore@0: 				comboBoxModel.removeElement(options[2]);
fiore@0: 			}else if(!elementNames.isEmpty() && comboBoxModel.getSize() == 2){
fiore@0: 				comboBoxModel.insertElementAt(options[1],1);
fiore@0: 				comboBoxModel.insertElementAt(options[2],2);
fiore@0: 			}
fiore@0: 			super.update();
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public void next(){
fiore@0: 			/* if the selection was add element, then we clear the temporary holder */
fiore@0: 			if(comboBox.getSelectedIndex() == 0)
fiore@0: 				temporaryElement.clear();
fiore@0: 			/* jump to the selected next step, works both when it's only add/finish and when it's add/delete/edit/finish */
fiore@0: 			for(int i=0; i<options.length; i++)
fiore@0: 				if(comboBox.getSelectedItem().equals(options[i])){
fiore@0: 					switchPanel(nexts[i]);
fiore@0: 					return;
fiore@0: 				}
fiore@0: 		}
fiore@0: 		
fiore@0: 		JComboBox comboBox;
fiore@0: 		Collection<String> elementNames;
fiore@0: 		DefaultComboBoxModel comboBoxModel;
fiore@0: 		String[] options;
fiore@0: 		Model.Element temporaryElement;
fiore@0: 		int[] nexts;
fiore@0: 	}
fiore@0: 	
fiore@0: 	@SuppressWarnings("serial")
fiore@0: 	private static class DeletePanel extends SpeechWizardPanel {
fiore@0: 		DeletePanel(JWizardComponents wizardComponents,String title, int next, int previous, ModelMap<? extends Model.Element> elements){
fiore@0: 			super(wizardComponents,title,next, previous);
fiore@0: 			this.elements = elements;
fiore@0: 			comboBox = new LoopComboBox();
fiore@0: 			comboBox.addItemListener(SpeechUtilities.getSpeechComboBoxItemListener());
fiore@0: 			layoutComponents(comboBox);
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public void update(){
fiore@0: 			String[] options = new String[elements.values().size()];
fiore@0: 			options = elements.getNames().toArray(options);
fiore@0: 			comboBox.setModel(new DefaultComboBoxModel(options));
fiore@0: 			super.update();
fiore@0: 		}
fiore@0: 		
fiore@0: 		/**
fiore@0: 		 * the default behaviour is to delete the selected element 
fiore@0: 		 */
fiore@0: 		@Override
fiore@0: 		public void next(){
fiore@0: 			Model.Element elementToDelete = null;
fiore@0: 			for(Model.Element element : elements.values()){
fiore@0: 				if(element.type.value.equals(comboBox.getSelectedItem())){
fiore@0: 					elementToDelete = element;
fiore@0: 					break;
fiore@0: 				}
fiore@0: 			}
fiore@0: 			Object o = elements.remove(elementToDelete.id);
fiore@0: 			assert(o != null);
fiore@0: 			super.next();
fiore@0: 		}
fiore@0: 		
fiore@0: 		JComboBox comboBox;
fiore@0: 		ModelMap<? extends Model.Element> elements;
fiore@0: 	}
fiore@0: 	
fiore@0: 	@SuppressWarnings("serial")
fiore@0: 	private static class EditPanel extends DeletePanel {
fiore@0: 		EditPanel(JWizardComponents wizardComponents,
fiore@0: 				String title, 
fiore@0: 				int next, 
fiore@0: 				int previous, 
fiore@0: 				ModelMap<? extends Model.Element> elements,
fiore@0: 				Model.Element temporaryHolder){
fiore@0: 			super(wizardComponents, title,next, previous,elements);
fiore@0: 			this.temporaryHolder = temporaryHolder;
fiore@0: 			this.next = next;
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public void next(){
fiore@0: 			Model.Element selected = null;
fiore@0: 			for(Model.Element e : elements.values()){
fiore@0: 				if(e.type.value.equals(comboBox.getSelectedItem())){
fiore@0: 					selected = e;
fiore@0: 					break;
fiore@0: 				}
fiore@0: 			}
fiore@0: 			
fiore@0: 			Model.copy(selected, temporaryHolder);
fiore@0: 			switchPanel(next);
fiore@0: 		}
fiore@0: 		
fiore@0: 		int next;
fiore@0: 		Model.Element temporaryHolder;
fiore@0: 	}
fiore@0: 	
fiore@0: 	@SuppressWarnings("serial")
fiore@0: 	private class FormatWizardPanel extends SpeechWizardPanel{
fiore@0: 		FormatWizardPanel(){
fiore@0: 			super(dialog.getWizardComponents(),resources.getString("panel.modifier_format.title"),MODIFIERS,MODIFIER_TYPE);
fiore@0: 			String values[] = {
fiore@0: 					resources.getString("modifier.format.bold"),
fiore@0: 					resources.getString("modifier.format.underline"),
fiore@0: 					resources.getString("modifier.format.italic"),
fiore@0: 					resources.getString("modifier.format.prefix"),
fiore@0: 					resources.getString("modifier.format.suffix"),
fiore@0: 			};
fiore@0: 
fiore@0: 			checkBoxes = new JCheckBox[values.length];
fiore@0: 			checkBoxPanel = new JPanel(new GridLayout(0, 1));
fiore@0: 			for(int i=0; i<values.length;i++){
fiore@0: 				String value = values[i];
fiore@0: 				checkBoxes[i] = new JCheckBox(value);
fiore@0: 				checkBoxes[i].getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,0), "enter");
fiore@0: 				checkBoxes[i].getActionMap().put("enter", new AbstractAction(){
fiore@0: 					@Override
fiore@0: 					public void actionPerformed(ActionEvent arg0) {
fiore@0: 						getWizardComponents().getNextButton().doClick();
fiore@0: 					}
fiore@0: 				});
fiore@0: 				checkBoxes[i].addItemListener(SpeechUtilities.getCheckBoxSpeechItemListener());
fiore@0: 				/* prefix and suffix check boxes must have a JText area for the user to enter the String */
fiore@0: 				if(i == 3 || i == 4){
fiore@0: 					JPanel panel = new JPanel();
fiore@0: 					panel.setLayout(new FlowLayout(FlowLayout.LEFT,0,0));
fiore@0: 					panel.add(checkBoxes[i]);
fiore@0: 					if(i == 3){
fiore@0: 						prefixTextField = new JTextField();
fiore@0: 						prefixTextField.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,0), "enter");
fiore@0: 						prefixTextField.getActionMap().put("enter", new AbstractAction(){
fiore@0: 							@Override
fiore@0: 							public void actionPerformed(ActionEvent arg0) {
fiore@0: 								getWizardComponents().getNextButton().doClick();
fiore@0: 							}
fiore@0: 						});
fiore@0: 						prefixTextField.getAccessibleContext().setAccessibleName(checkBoxes[i].getText());
fiore@0: 						prefixTextField.setColumns(5);
fiore@0: 						prefixTextField.addKeyListener(SpeechUtilities.getSpeechKeyListener(true));
fiore@0: 						panel.add(prefixTextField);
fiore@0: 					}else{
fiore@0: 						suffixTextField = new JTextField();
fiore@0: 						suffixTextField.getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,0), "enter");
fiore@0: 						suffixTextField.getActionMap().put("enter", new AbstractAction(){
fiore@0: 							@Override
fiore@0: 							public void actionPerformed(ActionEvent arg0) {
fiore@0: 								getWizardComponents().getNextButton().doClick();
fiore@0: 							}
fiore@0: 						});
fiore@0: 						suffixTextField.getAccessibleContext().setAccessibleName(checkBoxes[i].getText());
fiore@0: 						suffixTextField.setColumns(5);
fiore@0: 						suffixTextField.addKeyListener(SpeechUtilities.getSpeechKeyListener(true));
fiore@0: 						panel.add(suffixTextField);
fiore@0: 					}
fiore@0: 					checkBoxPanel.add(panel);
fiore@0: 				}else{
fiore@0: 					checkBoxPanel.add(checkBoxes[i]);
fiore@0: 				}
fiore@0: 			}
fiore@0: 			JScrollPane scrollPane = new JScrollPane(checkBoxPanel); 
fiore@0: 			scrollPane.setFocusable(false);
fiore@0: 			layoutComponents(scrollPane);
fiore@0: 			dialog.getWizardComponents().getFinishButton().setEnabled(true);
fiore@0: 		}
fiore@0: 		
fiore@0: 		/* store the checks into the StrArrayRecord, it doesn't call super.next thus */
fiore@0: 		/* sub classes have to implement call the switch panel on their own          */
fiore@0: 		public void next(){
fiore@0: 			int numCheckedBoxes = 0;
fiore@0: 			for(JCheckBox check : checkBoxes){
fiore@0: 				if(check.isSelected())
fiore@0: 					numCheckedBoxes++;
fiore@0: 			}
fiore@0: 			String[] result = new String[numCheckedBoxes];
fiore@0: 			numCheckedBoxes = 0;
fiore@0: 			for(int i=0; i<checkBoxes.length;i++){
fiore@0: 				/* store the text value of the check boxes, if it's the prefix or suffix */
fiore@0: 				/* append the text entered by the user in the text areas                  */
fiore@0: 				if(checkBoxes[i].isSelected()){
fiore@0: 					String text = checkBoxes[i].getText();
fiore@0: 					if(i == 3)
fiore@0: 						modifier.affix.values[PREFIX_INDEX] = prefixTextField.getText();
fiore@0: 					else if(i == 4)
fiore@0: 						modifier.affix.values[SUFFIX_INDEX] = suffixTextField.getText();
fiore@0: 					result[numCheckedBoxes++] = text;
fiore@0: 				}
fiore@0: 			}
fiore@0: 			modifier.format.values = result;
fiore@0: 			Model.Modifier newModifier = new Model.Modifier();
fiore@0: 			Model.copy(modifier,newModifier);
fiore@0: 			property.modifiers.put(newModifier.id,newModifier);
fiore@0: 			super.next();
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public void update(){
fiore@0: 			/* set the check boxes and text field according to the modifier.format. so if we are editing an existing *
fiore@0: 			 * modifier we find the old values, else if it's a new modifier we find everything blank                 */
fiore@0: 			if(modifier.format != null){
fiore@0: 				prefixTextField.setText("");
fiore@0: 				suffixTextField.setText("");
fiore@0: 				for(JCheckBox check : checkBoxes){
fiore@0: 					/* temporarily remove the speech Item listener in order to avoid bla bla bla not triggered by user */
fiore@0: 					check.removeItemListener(SpeechUtilities.getCheckBoxSpeechItemListener());
fiore@0: 					check.setSelected(false);
fiore@0: 					for(String checkedValue : modifier.format.values){
fiore@0: 						if(checkedValue.equals(check.getText())){//for bold,italic,underline
fiore@0: 							check.setSelected(true);
fiore@0: 							if(checkedValue.equals(resources.getString("modifier.format.prefix"))){
fiore@0: 								prefixTextField.setText(modifier.affix.values[PREFIX_INDEX]);
fiore@0: 							}else if(checkedValue.equals(resources.getString("modifier.format.suffix"))){
fiore@0: 								suffixTextField.setText(modifier.affix.values[SUFFIX_INDEX]);
fiore@0: 							}
fiore@0: 							break;
fiore@0: 						}
fiore@0: 					}
fiore@0: 					check.addItemListener(SpeechUtilities.getCheckBoxSpeechItemListener());
fiore@0: 				}
fiore@0: 			}
fiore@0: 			super.update();
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		protected Component assignFocus(){
fiore@0: 			/* focus on the first item */
fiore@0: 			checkBoxes[0].requestFocus();
fiore@0: 			return checkBoxes[0];
fiore@0: 		}
fiore@0: 		
fiore@0: 		JTextField prefixTextField;
fiore@0: 		JTextField suffixTextField;
fiore@0: 		JPanel checkBoxPanel;
fiore@0: 		JCheckBox checkBoxes[];
fiore@0: 	}
fiore@0: 	
fiore@0: 	@SuppressWarnings("serial")
fiore@0: 	private class ArrowHeadPanel extends SpeechWizardPanel {
fiore@0: 		ArrowHeadPanel(){
fiore@0: 			super(dialog.getWizardComponents(),resources.getString("panel.edge_arrow_head.title"),EDGES,EDGE_YESNO_ARROW_HEAD);
fiore@0: 			JPanel panel = new JPanel(new GridBagLayout());
fiore@0: 			final JScrollPane scrollPane = new JScrollPane(panel);
fiore@0: 			scrollPane.setFocusable(false);
fiore@0: 			GridBagUtilities gridBagUtils = new GridBagUtilities(); 
fiore@0: 			int numArrowHeads = ArrowHead.values().length;
fiore@0: 			arrowsCheckBoxes = new JCheckBox[numArrowHeads];
fiore@0: 			arrowsTextDescriptions = new JTextField[numArrowHeads];
fiore@0: 			for(int i=0; i<numArrowHeads; i++){
fiore@0: 				/* set up the key bindings for all the check boxes and text fields */
fiore@0: 				/* by pressing enter the wizard switches the next panel            */
fiore@0: 				arrowsCheckBoxes[i] = new JCheckBox(ArrowHead.values()[i].toString());
fiore@0: 				arrowsCheckBoxes[i].getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,0), "enter");
fiore@0: 				arrowsCheckBoxes[i].getActionMap().put("enter", new AbstractAction(){
fiore@0: 					@Override
fiore@0: 					public void actionPerformed(ActionEvent arg0) {
fiore@0: 						getWizardComponents().getNextButton().doClick();
fiore@0: 					}
fiore@0: 				});
fiore@0: 				arrowsTextDescriptions[i] = new JTextField();
fiore@0: 				arrowsTextDescriptions[i].getInputMap().put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,0), "enter");
fiore@0: 				arrowsTextDescriptions[i].getActionMap().put("enter", new AbstractAction(){
fiore@0: 					@Override
fiore@0: 					public void actionPerformed(ActionEvent arg0) {
fiore@0: 						getWizardComponents().getNextButton().doClick();
fiore@0: 					}
fiore@0: 				});
fiore@0: 				/* add the speech to the check boxes */
fiore@0: 				arrowsCheckBoxes[i].addItemListener(SpeechUtilities.getCheckBoxSpeechItemListener());
fiore@0: 				
fiore@0: 				arrowsTextDescriptions[i].setPreferredSize(new Dimension(TEXTFIELD_SIZE, arrowsTextDescriptions[i].getPreferredSize().height));
fiore@0: 				arrowsTextDescriptions[i].getAccessibleContext().setAccessibleName(arrowsCheckBoxes[i].getText());
fiore@0: 				arrowsTextDescriptions[i].addKeyListener(SpeechUtilities.getSpeechKeyListener(true));
fiore@0: 				panel.add(arrowsCheckBoxes[i], gridBagUtils.label());
fiore@0: 				panel.add(arrowsTextDescriptions[i],gridBagUtils.field());
fiore@0: 			}
fiore@0: 			layoutComponents(scrollPane);
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		public void update(){
fiore@0: 			/* restore the values (checkbox + text) currently in edge.arrowHeads into the panel components */
fiore@0: 			if(edge.arrowHeads != null){
fiore@0: 				for(int i=0; i<arrowsCheckBoxes.length;i++){
fiore@0: 					arrowsCheckBoxes[i].setSelected(false);
fiore@0: 					arrowsTextDescriptions[i].setText("");
fiore@0: 					for(int j=0; j< edge.arrowHeads.values.length; j++){
fiore@0: 						if(arrowsCheckBoxes[i].getText().equals(edge.arrowHeads.values[j])){
fiore@0: 							arrowsCheckBoxes[i].setSelected(true);
fiore@0: 							arrowsTextDescriptions[i].setText(edge.arrowHeadsDescriptions.values[j]);
fiore@0: 							break;
fiore@0: 						}
fiore@0: 					}
fiore@0: 				}
fiore@0: 			}
fiore@0: 			super.update();
fiore@0: 		}
fiore@0: 		@Override
fiore@0: 		public void next(){
fiore@0: 			/* check that the user has entered a text for all of the selected check boxes */
fiore@0: 			int numChecked = 0;//this is to keep count of the checked boxes, used after the check 
fiore@0: 			for(int i=0; i<arrowsCheckBoxes.length;i++){
fiore@0: 				JCheckBox checkBox = arrowsCheckBoxes[i];
fiore@0: 				if(checkBox.isSelected()){
fiore@0: 					numChecked++;
fiore@0: 					/* there cannot be a checked check box without the related textField filled in */
fiore@0: 					if(arrowsTextDescriptions[i].getText().trim().isEmpty()){
fiore@0: 						NarratorFactory.getInstance().speak(
fiore@0: 								MessageFormat.format(
fiore@0: 										resources.getString("dialog.error.empty_desc"),
fiore@0: 										checkBox.getText())
fiore@0: 						);		
fiore@0: 						return;
fiore@0: 					}
fiore@0: 				}
fiore@0: 			}
fiore@0: 			/* copy the label of the checked boxes and the text of the JTextField into the edge fields */
fiore@0: 			edge.arrowHeads.values = new String[numChecked];
fiore@0: 			edge.arrowHeadsDescriptions.values = new String[numChecked];
fiore@0: 			numChecked = 0;
fiore@0: 			for(int i=0; i<arrowsCheckBoxes.length;i++){
fiore@0: 				if(arrowsCheckBoxes[i].isSelected()){
fiore@0: 					edge.arrowHeads.values[numChecked] = arrowsCheckBoxes[i].getText();
fiore@0: 					edge.arrowHeadsDescriptions.values[numChecked] = arrowsTextDescriptions[i].getText().trim();
fiore@0: 					numChecked++;
fiore@0: 				}
fiore@0: 			}
fiore@0: 			/* put the edge (copy of) into the model */
fiore@0: 			Model.Edge newEdge = new Model.Edge();
fiore@0: 			Model.copy(edge, newEdge);
fiore@0: 			model.edges.put(newEdge.id,newEdge);
fiore@0: 			super.next();
fiore@0: 		}
fiore@0: 		
fiore@0: 		@Override
fiore@0: 		protected Component assignFocus(){
fiore@0: 			/* focus on the first item */
fiore@0: 			arrowsCheckBoxes[0].requestFocus();
fiore@0: 			return arrowsCheckBoxes[0];
fiore@0: 		}
fiore@0: 		
fiore@0: 		JCheckBox arrowsCheckBoxes[];
fiore@0: 		JTextField arrowsTextDescriptions[];
fiore@0: 		final int TEXTFIELD_SIZE = 100;
fiore@0: 	}
fiore@0: }