/**
* This file is part of JSurveyLib.
*
* JSurveyLib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JSurveyLib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JSurveyLib. If not, see <http://www.gnu.org/licenses/>.
**/
package org.jsurveylib.gui.swing;
import org.jsurveylib.ClientSurvey;
import org.jsurveylib.Survey;
import org.jsurveylib.gui.swing.widget.WarnIfExistsChooser;
import org.jsurveylib.gui.swing.widget.Chooser;
import org.jsurveylib.gui.swing.util.ChooserUtil;
import org.jsurveylib.model.Menu;
import org.jsurveylib.model.Page;
import org.jsurveylib.model.question.Question;
import org.jsurveylib.model.listeners.AnswerListener;
import org.jsurveylib.model.listeners.PageListener;
import org.xml.sax.SAXException;
import javax.swing.JFileChooser;
import javax.swing.JFrame;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.KeyStroke;
import javax.swing.JOptionPane;
import javax.swing.filechooser.FileNameExtensionFilter;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;
import java.io.IOException;
/**
* A SurveyMenu adds the menu bar and menu items to a JFrame. It uses the ClientSurvey you pass in to configure itself. If
* the ClientSurvey is configured without a menu bar, attaching this to a JFrame will have no visible effect.
* <p/>
* Copyright (c)2007, Daniel Kaplan
*
* @author Daniel Kaplan
* @since 8.01.29
*/
public class SurveyMenu extends JMenuBar implements PageListener, AnswerListener {
private JMenuItem firstPage;
private JMenuItem previousPage;
private JMenuItem nextPage;
private JMenuItem lastPage;
private Survey survey;
public SurveyMenu(ClientSurvey clientSurvey, JFrame frame) {
survey = (Survey) clientSurvey;
if (!survey.getMenu().exists()) {
return;
}
addListeners();
if (hasFileMenu(survey.getMenu())) {
JMenu fileMenu = new JMenu(survey.getStrings().getFileString());
fileMenu.setMnemonic(KeyEvent.VK_F);
add(fileMenu);
addOpen(fileMenu, frame);
addSave(fileMenu, frame);
addSaveAs(fileMenu, frame);
}
if (hasGoToMenu(survey.getMenu())) {
JMenu viewMenu = new JMenu(survey.getStrings().getViewString());
viewMenu.setMnemonic(KeyEvent.VK_V);
add(viewMenu);
addFirstPage(viewMenu);
addPreviousPage(viewMenu);
addNextPage(viewMenu);
addLastPage(viewMenu);
}
setMenuItemState();
}
private void addListeners() {
survey.addPageListener(this);
for (Page p : survey.getPages()) {
for (Question q : p.getQuestions()) {
q.addAnswerListener(this);
}
}
}
private void addPreviousPage(JMenu menu) {
if (survey.getMenu().hasPreviousPage()) {
previousPage = new JMenuItem(survey.getStrings().getPreviousPageString());
previousPage.setAccelerator(KeyStroke.getKeyStroke("control P"));
previousPage.setMnemonic(KeyEvent.VK_P);
previousPage.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
if (survey.isPreviousPageAvailable())
survey.goToPreviousPage();
}
});
menu.add(previousPage);
}
}
private void addNextPage(JMenu menu) {
if (survey.getMenu().hasNextPage()) {
nextPage = new JMenuItem(survey.getStrings().getNextPageString());
nextPage.setAccelerator(KeyStroke.getKeyStroke("control N"));
nextPage.setMnemonic(KeyEvent.VK_N);
nextPage.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
if (survey.isNextPageAvailable())
survey.goToNextPage();
}
});
menu.add(nextPage);
}
}
private void addFirstPage(JMenu menu) {
if (survey.getMenu().hasPreviousPage()) {
firstPage = new JMenuItem(survey.getStrings().getFirstPageString());
firstPage.setAccelerator(KeyStroke.getKeyStroke("control F"));
firstPage.setMnemonic(KeyEvent.VK_F);
firstPage.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
if (survey.isPreviousPageAvailable())
survey.goToFirstPage();
}
});
menu.add(firstPage);
}
}
private void addLastPage(JMenu menu) {
if (survey.getMenu().hasNextPage()) {
lastPage = new JMenuItem(survey.getStrings().getLastPageString());
lastPage.setAccelerator(KeyStroke.getKeyStroke("control L"));
lastPage.setMnemonic(KeyEvent.VK_L);
lastPage.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
if (survey.isNextPageAvailable())
survey.goToLastPage();
}
});
menu.add(lastPage);
}
}
private boolean hasGoToMenu(Menu menu) {
return (menu.hasNextPage() || menu.hasPreviousPage());
}
private void useSaveChooser(JFrame frame) {
ChooserUtil.saveSurveyChooser(frame, survey);
}
private void addSaveAs(JMenu menu, final JFrame frame) {
if (survey.getMenu().hasSaveAs()) {
JMenuItem saveAs = new JMenuItem(survey.getStrings().getSaveAsString());
saveAs.setMnemonic(KeyEvent.VK_A);
saveAs.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
useSaveChooser(frame);
}
});
menu.add(saveAs);
}
}
private boolean hasFileMenu(Menu menu) {
return menu.hasOpen() || menu.hasSave() || menu.hasSaveAs();
}
private void addSave(JMenu menu, final JFrame frame) {
if (survey.getMenu().hasSave()) {
JMenuItem save = new JMenuItem(survey.getStrings().getSaveString());
save.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_S, ActionEvent.CTRL_MASK));
save.setMnemonic(KeyEvent.VK_S);
save.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
if (survey.getWorkingFilePath() == null) {
useSaveChooser(frame);
} else {
try {
survey.saveXMLAnswers(survey.getWorkingFilePath()); //overwrite the working file
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
});
menu.add(save);
}
}
private void addOpen(JMenu menu, final JFrame frame) {
if (survey.getMenu().hasOpen()) {
JMenuItem open = new JMenuItem(survey.getStrings().getOpenString());
open.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_O, ActionEvent.CTRL_MASK));
open.setMnemonic(KeyEvent.VK_O);
open.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent ae) {
Chooser chooser = new Chooser();
chooser.addChoosableFileFilter(new FileNameExtensionFilter("XML Files", "xml"));
if (chooser.showOpenDialog(frame) == JFileChooser.APPROVE_OPTION) {
try {
survey.loadXMLAnswers(chooser.getSelectedFile().getAbsolutePath());
} catch (IOException e) {
//TODO: i18n this error message
JOptionPane.showMessageDialog(frame, e.getMessage(), survey.getTitle(), JOptionPane.ERROR_MESSAGE);
throw new RuntimeException(e);
} catch (SAXException e) {
//TODO: i18n this error message
JOptionPane.showMessageDialog(frame, e.getMessage(), survey.getTitle(), JOptionPane.ERROR_MESSAGE);
throw new RuntimeException(e);
} catch (IllegalArgumentException e) {
//TODO: i18n this error message
JOptionPane.showMessageDialog(frame, e.getMessage(), survey.getTitle(), JOptionPane.WARNING_MESSAGE);
e.printStackTrace();
}
}
setMenuItemState();
}
});
menu.add(open);
}
}
private void setMenuItemState() {
if (firstPage != null) {
//features in the future may cause this to break
firstPage.setEnabled(survey.isPreviousPageAvailable());
}
if (previousPage != null) {
previousPage.setEnabled(survey.isPreviousPageAvailable());
}
if (nextPage != null) {
nextPage.setEnabled(survey.isNextPageAvailable());
}
if (lastPage != null) {
lastPage.setEnabled(survey.isNextPageAvailable());
}
}
/**
* <u><b><font color="red">FOR INTERNAL USE ONLY.</font></b></u> This method is meant to be called by internal
* JSurveyLib code.
*/
public void currentPageChanged() {
setMenuItemState();
}
/**
* <u><b><font color="red">FOR INTERNAL USE ONLY.</font></b></u> This method is meant to be called by internal
* JSurveyLib code.
*/
public void answerChanged(Question question, boolean evaluateScript) {
setMenuItemState();
}
}