PageRenderTime 46ms CodeModel.GetById 42ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-0-pre3/org/gjt/sp/jedit/OptionPane.java

#
Java | 59 lines | 9 code | 6 blank | 44 comment | 0 complexity | 0628b827b1d8c807c1e9cf34706f9c25 MD5 | raw file
 1/*
 2 * OptionPane.java - Option pane interface
 3 * Copyright (C) 1999 Slava Pestov
 4 *
 5 * This program is free software; you can redistribute it and/or
 6 * modify it under the terms of the GNU General Public License
 7 * as published by the Free Software Foundation; either version 2
 8 * of the License, or any later version.
 9 *
10 * This program 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
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18 */
19
20package org.gjt.sp.jedit;
21
22import java.awt.Component;
23
24/**
25 * The interface all option panes must implement.  Internally, jEdit uses
26 * option panes to implement the tabs in the "Global Options" dialog box.
27 * Plugins can also create option panes for the "Plugin Options" dialog
28 * box.<p>
29 *
30 * The <i>name</i> of an option pane is returned by the <code>getName()</code>
31 * method. The label displayed in the option pane's tab is obtained from the
32 * <code>options.<i>name</i>.label</code> property.
33 *
34 * @see org.gjt.sp.jedit.AbstractOptionPane
35 */
36public interface OptionPane
37{
38	/**
39	 * Returns the internal name of this option pane.
40	 */
41	String getName();
42
43	/**
44	 * Returns the component that should be displayed for this option pane.
45	 */
46	Component getComponent();
47
48	/**
49	 * This method should create the option pane's GUI.
50	 */
51	void init();
52
53	/**
54	 * Called when the options dialog's "ok" button is clicked.
55	 * This should save any properties being edited in this option
56	 * pane.
57	 */
58	void save();
59}