import java.util.Iterator;
import java.util.List;
import java.util.Set;
-import java.util.Map.Entry;
import javax.swing.AbstractAction;
import javax.swing.Action;
import de.todesbaum.util.swing.TWizardPage;
/**
- * @author David Roden <droden@gmail.com>
- * @version $Id$
+ * Wizard page that lets the user manage the files of a project.
+ *
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
*/
public class ProjectFilesPage extends TWizardPage implements ActionListener, ListSelectionListener, DocumentListener, FileScannerListener, ChangeListener {
- protected Project project;
+ /** The project. */
+ private Project project;
+
+ /** The “scan files” action. */
+ private Action scanAction;
+
+ /** The “edit container” action. */
+ private Action editContainerAction;
- protected Action scanAction;
- protected Action editContainerAction;
- protected Action addContainerAction;
+ /** The “add container” action. */
+ private Action addContainerAction;
+
+ /** The “delete container” action. */
protected Action deleteContainerAction;
- protected JList projectFileList;
+ /** The list of project files. */
+ private JList projectFileList;
+
+ /** The “default file” checkbox. */
private JCheckBox defaultFileCheckBox;
+
+ /** The “insert” checkbox. */
private JCheckBox fileOptionsInsertCheckBox;
+
+ /** The “custom key” textfield. */
private JTextField fileOptionsCustomKeyTextField;
+
+ /** The “mime type” combo box. */
private JComboBox fileOptionsMIMETypeComboBox;
- protected DefaultComboBoxModel containerComboBoxModel;
+
+ /** The “mime type” combo box model. */
+ private DefaultComboBoxModel containerComboBoxModel;
+
+ /** The “container” combo box. */
private JComboBox fileOptionsContainerComboBox;
+
+ /** The “edition replacement range” spinner. */
private JSpinner replaceEditionRangeSpinner;
+
+ /** The “replacement” check box. */
private JCheckBox replacementCheckBox;
+ /**
+ * Creates a new project file page.
+ *
+ * @param wizard
+ * The wizard the page belongs to
+ */
public ProjectFilesPage(final TWizard wizard) {
super(wizard);
pageInit();
}
+ /**
+ * Initializes the page and all its actions and components.
+ */
private void pageInit() {
createActions();
setLayout(new BorderLayout(12, 12));
add(createProjectFilesPanel(), BorderLayout.CENTER);
}
+ /**
+ * Creates all actions.
+ */
private void createActions() {
scanAction = new AbstractAction(I18n.getMessage("jsite.project-files.action.rescan")) {
+ @SuppressWarnings("synthetic-access")
public void actionPerformed(ActionEvent actionEvent) {
actionScan();
}
addContainerAction = new AbstractAction(I18n.getMessage("jsite.project-files.action.add-container")) {
+ @SuppressWarnings("synthetic-access")
public void actionPerformed(ActionEvent actionEvent) {
actionAddContainer();
}
editContainerAction = new AbstractAction(I18n.getMessage("jsite.project-files.action.edit-container")) {
+ @SuppressWarnings("synthetic-access")
public void actionPerformed(ActionEvent actionEvent) {
actionEditContainer();
}
deleteContainerAction = new AbstractAction(I18n.getMessage("jsite.project-files.action.delete-container")) {
+ @SuppressWarnings("synthetic-access")
public void actionPerformed(ActionEvent actionEvent) {
actionDeleteContainer();
}
I18nContainer.getInstance().registerRunnable(new Runnable() {
+ @SuppressWarnings("synthetic-access")
public void run() {
scanAction.putValue(Action.NAME, I18n.getMessage("jsite.project-files.action.rescan"));
scanAction.putValue(Action.SHORT_DESCRIPTION, I18n.getMessage("jsite.project-files.action.rescan.tooltip"));
});
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void pageAdded(TWizard wizard) {
actionScan();
this.wizard.setQuitName(I18n.getMessage("jsite.wizard.quit"));
}
+ /**
+ * Creates the panel contains the project file list and options.
+ *
+ * @return The created panel
+ */
private JComponent createProjectFilesPanel() {
JPanel projectFilesPanel = new JPanel(new BorderLayout(12, 12));
fileOptionsMIMETypeComboBox.setToolTipText(I18n.getMessage("jsite.project-files.mime-type.tooltip"));
fileOptionsMIMETypeComboBox.setName("project-files.mime-type");
fileOptionsMIMETypeComboBox.addActionListener(this);
+ fileOptionsMIMETypeComboBox.setEditable(true);
fileOptionsMIMETypeComboBox.setEnabled(false);
final TLabel mimeTypeLabel = new TLabel(I18n.getMessage("jsite.project-files.mime-type") + ":", KeyEvent.VK_M, fileOptionsMIMETypeComboBox);
fileOptionsContainerComboBox.setName("project-files.container");
fileOptionsContainerComboBox.addActionListener(this);
fileOptionsContainerComboBox.setEnabled(false);
+ fileOptionsContainerComboBox.setVisible(false);
final TLabel containerLabel = new TLabel(I18n.getMessage("jsite.project-files.container") + ":", KeyEvent.VK_C, fileOptionsContainerComboBox);
+ containerLabel.setVisible(false);
+ JButton addContainerButton = new JButton(addContainerAction);
+ addContainerButton.setVisible(false);
+ JButton editContainerButton = new JButton(editContainerAction);
+ editContainerButton.setVisible(false);
+ JButton deleteContainerButton = new JButton(deleteContainerAction);
+ deleteContainerButton.setVisible(false);
fileOptionsPanel.add(containerLabel, new GridBagConstraints(0, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.NONE, new Insets(6, 18, 0, 0), 0, 0));
fileOptionsPanel.add(fileOptionsContainerComboBox, new GridBagConstraints(1, 6, 1, 1, 1.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
- fileOptionsPanel.add(new JButton(addContainerAction), new GridBagConstraints(2, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
- fileOptionsPanel.add(new JButton(editContainerAction), new GridBagConstraints(3, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
- fileOptionsPanel.add(new JButton(deleteContainerAction), new GridBagConstraints(4, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
+ fileOptionsPanel.add(addContainerButton, new GridBagConstraints(2, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
+ fileOptionsPanel.add(editContainerButton, new GridBagConstraints(3, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
+ fileOptionsPanel.add(deleteContainerButton, new GridBagConstraints(4, 6, 1, 1, 0.0, 0.0, GridBagConstraints.LINE_START, GridBagConstraints.HORIZONTAL, new Insets(6, 6, 0, 0), 0, 0));
JPanel fileOptionsReplacementPanel = new JPanel(new FlowLayout(FlowLayout.LEADING, 6, 6));
fileOptionsReplacementPanel.setBorder(new EmptyBorder(-6, -6, -6, -6));
I18nContainer.getInstance().registerRunnable(new Runnable() {
+ @SuppressWarnings("synthetic-access")
public void run() {
fileOptionsLabel.setText("<html><b>" + I18n.getMessage("jsite.project-files.file-options") + "</b></html>");
defaultFileCheckBox.setText(I18n.getMessage("jsite.project-files.default"));
return projectFilesPanel;
}
+ /**
+ * Sets the project whose files to manage.
+ *
+ * @param project
+ * The project whose files to manage
+ */
public void setProject(final Project project) {
this.project = project;
setHeading(MessageFormat.format(I18n.getMessage("jsite.project-files.heading"), project.getName()));
});
}
+ /**
+ * Returns a list of all project files.
+ *
+ * @return All project files
+ */
private List<String> getProjectFiles() {
List<String> files = new ArrayList<String>();
for (int index = 0, size = projectFileList.getModel().getSize(); index < size; index++) {
return files;
}
- protected void rebuildContainerComboBox() {
+ /**
+ * Updates the container combo box model.
+ */
+ private void rebuildContainerComboBox() {
/* scan files for containers */
List<String> files = getProjectFiles();
List<String> containers = new ArrayList<String>(); // ComboBoxModel
// sucks. No
// contains()!
containers.add("");
- for (String filename: files) {
+ for (String filename : files) {
String container = project.getFileOption(filename).getContainer();
if (!containers.contains(container)) {
containers.add(container);
}
Collections.sort(containers);
containerComboBoxModel.removeAllElements();
- for (String container: containers) {
+ for (String container : containers) {
containerComboBoxModel.addElement(container);
}
}
// ACTIONS
//
- protected void actionScan() {
+ /**
+ * Rescans the project’s files.
+ */
+ private void actionScan() {
projectFileList.clearSelection();
projectFileList.setListData(new Object[0]);
new Thread(fileScanner).start();
}
- protected void actionAddContainer() {
+ /**
+ * Adds a container.
+ */
+ private void actionAddContainer() {
String containerName = JOptionPane.showInputDialog(wizard, I18n.getMessage("jsite.project-files.action.add-container.message") + ":", null, JOptionPane.INFORMATION_MESSAGE);
if (containerName == null) {
return;
fileOptionsContainerComboBox.setSelectedItem(containerName);
}
- protected void actionEditContainer() {
+ /**
+ * Edits the container.
+ */
+ private void actionEditContainer() {
String selectedFilename = (String) projectFileList.getSelectedValue();
FileOption fileOption = project.getFileOption(selectedFilename);
String oldContainerName = fileOption.getContainer();
return;
}
List<String> files = getProjectFiles();
- for (String filename: files) {
+ for (String filename : files) {
fileOption = project.getFileOption(filename);
if (fileOption.getContainer().equals(oldContainerName)) {
fileOption.setContainer(containerName);
fileOptionsContainerComboBox.setSelectedItem(containerName);
}
- protected void actionDeleteContainer() {
+ /**
+ * Deletes the container.
+ */
+ private void actionDeleteContainer() {
if (JOptionPane.showConfirmDialog(wizard, I18n.getMessage("jsite.project-files.action.delete-container.message"), null, JOptionPane.OK_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE) == JOptionPane.OK_OPTION) {
String containerName = (String) fileOptionsContainerComboBox.getSelectedItem();
List<String> files = getProjectFiles();
- for (String filename: files) {
+ for (String filename : files) {
FileOption fileOption = project.getFileOption(filename);
if (fileOption.getContainer().equals(containerName)) {
fileOption.setContainer("");
}
}
+ /**
+ * {@inheritDoc}
+ * <p>
+ * Updates the file list.
+ */
public void fileScannerFinished(FileScanner fileScanner) {
final boolean error = fileScanner.isError();
if (!error) {
final List<String> files = fileScanner.getFiles();
SwingUtilities.invokeLater(new Runnable() {
+ @SuppressWarnings("synthetic-access")
public void run() {
projectFileList.setListData(files.toArray(new String[files.size()]));
projectFileList.clearSelection();
entriesToRemove.add(filename);
}
}
- for (String filename: entriesToRemove) {
+ for (String filename : entriesToRemove) {
project.setFileOption(filename, null);
}
} else {
}
SwingUtilities.invokeLater(new Runnable() {
+ @SuppressWarnings("synthetic-access")
public void run() {
wizard.setPreviousEnabled(true);
wizard.setNextEnabled(!error);
// INTERFACE DocumentListener
//
+ /**
+ * Updates the options of the currently selected file with the changes made
+ * in the “custom key” textfield.
+ *
+ * @param documentEvent
+ * The document event to process
+ */
private void processDocumentUpdate(DocumentEvent documentEvent) {
String filename = (String) projectFileList.getSelectedValue();
if (filename == null) {
String text = document.getText(0, document.getLength());
fileOption.setCustomKey(text);
} catch (BadLocationException ble1) {
+ /* ignore. */
}
}