01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.spi.editor;
43:
44: import java.awt.Dialog;
45: import java.awt.event.*;
46: import javax.swing.*;
47:
48: /**
49: * DialogFactory implementation is a class responsible for providing
50: * proper implementation of Dialog containing required widgets.
51: * It can provide the dialog itself or delegate the functionality
52: * to another piece of code, e.g some windowing system.
53: *
54: * @author pnejedly
55: * @version 1.0
56: */
57: public interface DialogFactory {
58:
59: /**
60: * The method for creating a dialog with specified properties.
61: *
62: * @param title The title of created dialog.
63: * @param panel The content of the dialog to be displayed.
64: * @param modal Whether the dialog should be modal.
65: * @param buttons The array of JButtons to be added to the dialog.
66: * @param sidebuttons The buttons could be placed under the panel (false),
67: * or on the right side of the panel (true).
68: * @param defaultIndex The index of default button in the buttons array,
69: * if <CODE>index < 0</CODE>, no default button is set.
70: * @param cancelIndex The index of cancel button - the button that will
71: * be <I>pressed</I> when closing the dialog.
72: * @param listener The listener which will be notified of all button
73: * events.
74: *
75: * @return newly created <CODE>Dialog</CODE>
76: */
77: public Dialog createDialog(String title, JPanel panel,
78: boolean modal, JButton[] buttons, boolean sidebuttons,
79: int defaultIndex, int cancelIndex, ActionListener listener);
80: }
|