com.anrisoftware.prefdialog.spreadsheetimportdialog.dialog.SpreadsheetImportDialog Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of prefdialog-spreadsheetimportdialog Show documentation
Show all versions of prefdialog-spreadsheetimportdialog Show documentation
Dialog to import spreadsheet data.
The newest version!
/*
* Copyright 2015 Erwin Müller
*
* This file is part of prefdialog-spreadsheetimportdialog.
*
* prefdialog-spreadsheetimportdialog 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.
*
* prefdialog-spreadsheetimportdialog 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 General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with prefdialog-spreadsheetimportdialog. If not, see
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @param properties
* the {@link SpreadsheetImportProperties}.
*
* @param dialog
* the {@link JDialog}.
*
* @param frame
* the {@link Window} owner or {@code null}.
*
* @param locale
* the {@link Locale}.
*
* @param importerFactory
* the {@link SpreadsheetImporterFactory}.
*
* @return the {@link SpreadsheetImportDialog}.
*/
@OnAwt
public static SpreadsheetImportDialog decorateSpreadsheetImportDialog(
SpreadsheetImportProperties properties, JDialog dialog,
Window frame, Locale locale,
SpreadsheetImporterFactory importerFactory) {
return decorate(properties, dialog, frame, locale, importerFactory);
}
/**
* Decorates the dialog with the spreadsheet import panel and dialog
* actions.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @param properties
* the {@link SpreadsheetImportProperties}.
*
* @param dialog
* the {@link JDialog}.
*
* @param frame
* the {@link Window} owner or {@code null}.
*
* @param locale
* the {@link Locale}.
*
* @param importerFactory
* the {@link SpreadsheetImporterFactory}.
*
* @return the {@link SpreadsheetImportDialog}.
*/
@OnAwt
public static SpreadsheetImportDialog decorate(
SpreadsheetImportProperties properties, JDialog dialog,
Window frame, Locale locale,
SpreadsheetImporterFactory importerFactory) {
SpreadsheetImportDialog importDialog;
importDialog = getFactory().create(properties);
importDialog.setDialog(dialog);
importDialog.setLocale(locale);
importDialog.createDialog(frame, importerFactory);
return importDialog;
}
private final SpreadsheetImportProperties properties;
private final PropertyChangeListener propertyChangeListener;
private final Dock dock;
@Inject
private SpreadsheetImportPanelDock importPanelDock;
@Inject
private SpreadsheetPreviewPanelDock previewPanelDock;
@Inject
private Injector parentInjector;
@Inject
private ValidListener validListener;
@Inject
private PropertiesWorkerFactory propertiesWorkerFactory;
private Texts texts;
/**
* @see SpreadsheetImportDialogFactory#create(SpreadsheetImportProperties)
*/
@Inject
SpreadsheetImportDialog(DockFactory dockFactory,
@Assisted SpreadsheetImportProperties properties) {
this.dock = dockFactory.create();
this.properties = properties;
this.propertyChangeListener = new PropertyChangeListener() {
@Override
public void propertyChange(PropertyChangeEvent evt) {
previewPanelDock.setProperties(importPanelDock.getProperties());
}
};
}
/**
* Sets the texts resources factory.
*
* @param factory
* the {@link TextsFactory}.
*/
@Inject
public void setSpreadsheetImportDialogTextsFactory(TextsFactory factory) {
this.texts = factory.create(SpreadsheetImportDialog.class
.getSimpleName());
}
/**
* Sets the parent dependency modules.
*
* @param parent
* the parent {@link Inject}.
*/
public void setParentInjector(Injector parent) {
this.parentInjector = parent;
}
/**
* Sets the locale for the dock.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @param locale
* the {@link Locale}.
*/
@Override
@OnAwt
public void setLocale(Locale locale) {
super.setLocale(locale);
}
/**
* Created the spreadsheet import dialog.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @param parentWindow
* the parent {@link Window} owner or {@code null}.
*
* @param importerFactory
* the {@link SpreadsheetImporterFactory}.
*
* @return this {@link SpreadsheetImportDialog}.
*/
@OnAwt
public SpreadsheetImportDialog createDialog(Window parentWindow,
SpreadsheetImporterFactory importerFactory) {
createDialog0(parentWindow, importerFactory);
return (SpreadsheetImportDialog) super.createDialog();
}
/**
* Returns the dock.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @return the {@link Dock}.
*/
@OnAwt
public Dock getDock() {
return dock;
}
/**
* Sets the properties to the dialog fields.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @param properties
* the {@link SpreadsheetImportProperties}.
*
* @throws PropertyVetoException
* if one of the values of the properties are vetoed.
*/
@OnAwt
public void setProperties(SpreadsheetImportProperties properties)
throws PropertyVetoException {
FieldComponent field = getImportPanelField();
SpreadsheetPanelProperties p = getProperties();
propertiesWorkerFactory.create(field, p).setProperties(properties);
previewPanelDock.setProperties(properties);
}
/**
* Sets the properties to the dialog fields. if one of the values of the
* properties is vetoed the value is skipped.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @param properties
* the {@link CsvImportProperties}.
*/
@OnAwt
public void setPropertiesNoChecks(SpreadsheetImportProperties properties) {
FieldComponent field = getImportPanelField();
SpreadsheetPanelProperties p = getProperties();
propertiesWorkerFactory.create(field, p).setPropertiesNoChecks(
properties);
previewPanelDock.setProperties(properties);
}
/**
* Returns the spreadsheet import properties.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @return the {@link SpreadsheetPanelProperties}.
*/
@OnAwt
public SpreadsheetPanelProperties getProperties() {
return importPanelDock.getImportPanel().getProperties();
}
/**
* Returns the import panel dock.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @return the {@link SpreadsheetImportPanelDock}.
*/
@OnAwt
public SpreadsheetImportPanelDock getImportPanelDock() {
return importPanelDock;
}
/**
* Returns the CSV import panel field.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @return the {@link FieldComponent}.
*/
@OnAwt
public FieldComponent getImportPanelField() {
return importPanelDock.getImportPanel().getPanel();
}
/**
* Saves the current layout under the specified name.
*
* @param name
* the name of the perspective.
*
* @param file
* the {@link File} file where to save the layout.
*
* @param listeners
* optionally, {@link PropertyChangeListener} listeners that are
* informed when the layout have been loaded and set.
*
* @throws LayoutException
* if there was an error saving the layout.
*/
public void saveLayout(String name, File file,
PropertyChangeListener... listeners) throws LayoutException {
dock.saveLayout(name, file, listeners);
}
/**
* Saves the current layout under the specified name.
*
* @param name
* the name of the layout.
*
* @param stream
* the {@link OutputStream} stream where to save the layout.
*
* @param listeners
* optionally, {@link PropertyChangeListener} listeners that are
* informed when the layout have been loaded and set.
*
* @throws LayoutException
* if there was an error saving the layout.
*/
public void saveLayout(String name, OutputStream stream,
PropertyChangeListener... listeners) throws LayoutException {
dock.saveLayout(name, stream, listeners);
}
/**
* Loads the previously saved layout with the specified name.
*
* @param name
* the name of the layout.
*
* @param file
* the {@link File} file from where to load the layout.
*
* @param listeners
* optionally, {@link PropertyChangeListener} listeners that are
* informed when the layout have been loaded and set.
*
* @throws LayoutException
* if there was an error loading the layout.
*/
public void loadLayout(String name, File file,
PropertyChangeListener... listeners) throws LayoutException {
dock.loadLayout(name, file, listeners);
dock.addEditorDock(importPanelDock);
}
/**
* Loads the previously saved layout with the specified name.
*
* @param name
* the name of the layout.
*
* @param stream
* the {@link InputStream} stream from where to load the layout.
*
* @param listeners
* optionally, {@link PropertyChangeListener} listeners that are
* informed when the layout have been loaded and set.
*
* @throws LayoutException
* if there was an error loading the layout.
*/
public void loadLayout(String name, InputStream stream,
PropertyChangeListener... listeners) throws LayoutException {
dock.loadLayout(name, stream, listeners);
dock.addEditorDock(importPanelDock);
}
/**
* Returns the current active layout.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @return the {@link LayoutTask}.
*/
@OnAwt
public LayoutTask getCurrentLayout() {
return dock.getCurrentLayout();
}
/**
* Sets a theme.
*
*
AWT Thread
* Should be called in the AWT event dispatch thread.
*
*
* @param name
* the theme name.
*/
@OnAwt
public void setTheme(String name) {
dock.setTheme(name);
}
@Override
@OnAwt
public void openDialog() throws PropertyVetoException {
importPanelDock.getImportPanel().requestFocus();
super.openDialog();
}
@Override
@OnAwt
public void restoreDialog() {
try {
importPanelDock.restoreInput();
} catch (PropertyVetoException e) {
}
}
/**
* @see SpreadsheetImportPanel#addVetoableChangeListener(VetoableChangeListener)
* @see SimpleDialog#addVetoableChangeListener(VetoableChangeListener)
*/
@Override
public void addVetoableChangeListener(VetoableChangeListener listener) {
importPanelDock.addVetoableChangeListener(listener);
super.addVetoableChangeListener(listener);
}
/**
* @see SpreadsheetImportPanel#removeVetoableChangeListener(VetoableChangeListener)
* @see SimpleDialog#removeVetoableChangeListener(VetoableChangeListener)
*/
@Override
public void removeVetoableChangeListener(VetoableChangeListener listener) {
importPanelDock.removeVetoableChangeListener(listener);
super.removeVetoableChangeListener(listener);
}
/**
* @see SpreadsheetImportPanel#addVetoableChangeListener(String,
* VetoableChangeListener)
* @see SimpleDialog#addVetoableChangeListener(String,
* VetoableChangeListener)
*/
@Override
public void addVetoableChangeListener(String propertyName,
VetoableChangeListener listener) {
importPanelDock.addVetoableChangeListener(propertyName, listener);
super.addVetoableChangeListener(propertyName, listener);
}
/**
* @see SpreadsheetImportPanel#removeVetoableChangeListener(String,
* VetoableChangeListener)
* @see SimpleDialog#removeVetoableChangeListener(String,
* VetoableChangeListener)
*/
@Override
public void removeVetoableChangeListener(String propertyName,
VetoableChangeListener listener) {
importPanelDock.removeVetoableChangeListener(propertyName, listener);
super.removeVetoableChangeListener(propertyName, listener);
}
private static final String IMPORT_ACTION_NAME = "import_action";
private void createDialog0(Window parentWindow,
SpreadsheetImporterFactory importerFactory) {
Locale locale = getLocale();
dock.createDock(parentWindow);
setApproveActionName(IMPORT_ACTION_NAME);
importPanelDock.setLocale(locale);
importPanelDock
.createPanel(parentInjector, properties, importerFactory);
importPanelDock.addPropertyChangeListener(propertyChangeListener);
setFieldsPanel(dock.getAWTComponent());
previewPanelDock.setLocale(locale);
previewPanelDock.createPanel(parentInjector, importerFactory);
previewPanelDock.setProperties(properties);
dock.addViewDock(previewPanelDock);
dock.addEditorDock(importPanelDock);
validListener.installDialog(this);
setTexts(texts);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy