01: /*
02: * Copyright 1990-2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
04: *
05: * This program is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU General Public License version
07: * 2 only, as published by the Free Software Foundation.
08: *
09: * This program is distributed in the hope that it will be useful, but
10: * WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * General Public License version 2 for more details (a copy is
13: * included at /legal/license.txt).
14: *
15: * You should have received a copy of the GNU General Public License
16: * version 2 along with this work; if not, write to the Free Software
17: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18: * 02110-1301 USA
19: *
20: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
21: * Clara, CA 95054 or visit www.sun.com if you need additional
22: * information or have any questions.
23: */
24: package com.sun.jump.executive;
25:
26: import java.net.URL;
27:
28: /**
29: * <Code>JUMPUserInputManager</code> defines methods that allow JUMP
30: * modules to request user feedback as part of their functionality. Examples
31: * that need user feedback are asking the user if a particular application
32: * can be downloaded or not. The implementation of the manager can present
33: * an appropriate User Interface (GUI or CLI) to get the user feedback.
34: * An instance of <code>JUMPUserInputManager</code> is got from
35: * {@link JUMPExecutive#getUserInputManager()}
36: * <p>
37: * All the methods block till the user performs some action with the UI
38: * presented. All the strings that are passed as arguments that are shown by
39: * the dialog MUST be a localized string. The implementation of the API will
40: * simply render those strings.
41: * <p>
42: * The following sample code shows how the download module can ask the
43: * user whether to allow installing an unsigned application.
44: * <pre>
45: *
46: * public boolean allowUnsignedApp() {
47: * JUMPExecutive executive = JUMPExecutive.getInstance();
48: * JUMPUserInputManager uiManager = executive.getUserInputManager();
49: * return uiManager.showDialog("Allow installing of unsigned app ..."
50: * "OK",
51: * "Cancel");
52: * }
53: *
54: * </pre>
55: */
56: public abstract class JUMPUserInputManager {
57:
58: /** Creates a new instance of JUMPUserInputManager */
59: protected JUMPUserInputManager() {
60: }
61:
62: /**
63: * Show the <i>message</i> in a dialog and wait for the user to select
64: * <b>OK</b> or <b>Cancel</b> and return the user selection.
65: *
66: * @param message the message to be displayed in the dialog box
67: * @param okString the string that is used to display the OK action.
68: * @param cancelString the string that is used to display the OK action.
69: *
70: * @return <code>true</code> if the user pressed OK and <Code>false</code>
71: * if the user pressed cancel or dismissed the dialog.
72: */
73: public abstract boolean showDialog(String message, URL imageURL,
74: String okString, String cancelString);
75:
76: /**
77: * Show the <i>message</i> in a dialog and wait for the user to select
78: * <b>OK</b> or <b>Cancel</b> and return the user selection.
79: *
80: * @param title the message to be displayed in the choice box
81: * @param choices a list of strings to show as the choices for the user
82: * to select
83: * @param defaultChoices a list of strings (typically a subset of
84: * <i>choices</i>) that should be selected as the default choice.
85: * @param isMultiSelection indicates if the user can select one or more
86: * choices.
87: * @param okString the string that is used to display the OK action.
88: * @param cancelString the string that is used to display the OK action.
89: * @return <Code>null</code>
90: * if the user pressed cancel or dismissed the choice box or the
91: * list of choices the user selected, which can have one or more
92: * items depending on the multiselection option.
93: */
94: public abstract String[] showChoices(String title, URL imageURL,
95: String[] choices, String[] defaultChoices,
96: boolean isMultiSelection, String okString,
97: String cancelString);
98: }
|