01: /**
02: * Wizard Framework
03: * Copyright 2004 - 2005 Andrew Pietsch
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library; if not, write to the Free Software
17: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18: *
19: * $Id: OverviewProvider.java,v 1.7 2005/05/16 23:06:58 pietschy Exp $
20: */package org.pietschy.wizard;
21:
22: import javax.swing.*;
23:
24: /**
25: * An interface that marks a model as providing an overview component for the wizard.
26: * <p>
27: * If the models implements this interface, the overview will be displayed in the left pane of
28: * the wizard. The overview can be hidden by calling {@link Wizard#setOverviewVisible} with a
29: * value of <tt>false</tt>.
30: */
31: public interface OverviewProvider {
32: /**
33: * Called to get a component that provides an overview of the wizard. This component will be
34: * shown in the wizard on the side corresponding the {@link java.awt.BorderLayout#LINE_START}.
35: * @return a componet that provides an overview of the wizard progress.
36: */
37: public JComponent getOverviewComponent();
38: }
|