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: HelpBroker.java,v 1.3 2005/05/16 23:06:57 pietschy Exp $
20: */package org.pietschy.wizard;
21:
22: import javax.swing.*;
23:
24: /**
25: * An interface for handling wizard help requests. If this interface is implemented by a {@link WizardModel}, the
26: * help button will be automatically displayed and help request fowwareded the model. Otherwise, you'll need to
27: * call {@link Wizard#setHelpBroker(HelpBroker)} explicitly with an instance of this interface.
28: * @author andrewp
29: * @version $Revision: 1.3 $
30: */
31: public interface HelpBroker {
32: /**
33: * Activated when the user presses help. Implementors will typically query the model to determine the current
34: * step and display the appropriate information.
35: * @param parent the component that is requesting the help. This is typically the {@link Wizard} itself.
36: * @param model the wizard model.
37: */
38: public void activateHelp(JComponent parent, WizardModel model);
39: }
|