001: /*
002: * The Unified Mapping Platform (JUMP) is an extensible, interactive GUI
003: * for visualizing and manipulating spatial features with geometry and attributes.
004: *
005: * Copyright (C) 2003 Vivid Solutions
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License
009: * as published by the Free Software Foundation; either version 2
010: * of the License, or (at your option) any later version.
011: *
012: * This program is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
015: * GNU General Public License for more details.
016: *
017: * You should have received a copy of the GNU General Public License
018: * along with this program; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
020: *
021: * For more information, contact:
022: *
023: * Vivid Solutions
024: * Suite #1A
025: * 2328 Government Street
026: * Victoria BC V8T 5G5
027: * Canada
028: *
029: * (250)385-6040
030: * www.vividsolutions.com
031: */
032:
033: package com.vividsolutions.jump.workbench.ui;
034:
035: import java.awt.BorderLayout;
036: import java.awt.event.ActionListener;
037:
038: import javax.swing.JPanel;
039:
040: import com.vividsolutions.jts.util.Assert;
041:
042: /**
043: * UI for AbstractDrivers. Must supply OK and Cancel buttons (for example, using
044: * OKCancelPanel).
045: */
046:
047: //JBuilder displays this component as a "Red Bean". There's a trick to
048: //displaying it -- see test.AbstractDriverPanelProxy and
049: //http://www.visi.com/~gyles19/fom-serve/cache/97.html. [Jon Aquino]
050: public abstract class AbstractDriverPanel extends JPanel {
051: BorderLayout borderLayout = new BorderLayout();
052:
053: public AbstractDriverPanel() {
054: //Don't let JBuilder create a jbInit method and call it here.
055: //It will cause a tricky bug:
056: // 1. The subclass' jbInit will be called
057: // 2. A NullPointerException will occur because the subclass' jbInit
058: // will perform operations on instance variables that have not yet been
059: // initialized.
060: //[Jon Aquino]
061: }
062:
063: /**
064: * Adds an ActionListener that should be notified when the user presses
065: * this panel's OK or Cancel button.
066: */
067: public abstract void addActionListener(ActionListener l);
068:
069: public abstract void removeActionListener(ActionListener l);
070:
071: public abstract boolean wasOKPressed();
072:
073: public boolean isInputValid() {
074: return null == getValidationError();
075: }
076:
077: /**
078: * Attempts to restore as many panel values as possible to a previous state,
079: * to save the user some typing. Subclasses overriding this method should
080: * call the superclass method first.
081: * @param cache not null
082: */
083: public void setCache(DriverPanelCache cache) {
084: Assert.isTrue(cache != null);
085: }
086:
087: /**
088: * Returns the current panel values. Subclasses overriding this method should
089: * call the superclass method first. DriverDialog takes care of merging
090: * the returned cache with the original cache.
091: */
092: public DriverPanelCache getCache() {
093: return new DriverPanelCache();
094: }
095:
096: /**
097: * @return null if there are no validation errors; otherwise, an error message
098: */
099: public String getValidationError() {
100: return null;
101: }
102: }
|