PageRenderTime 89ms CodeModel.GetById 86ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-2-pre14/org/gjt/sp/jedit/OptionPane.java

#
Java | 62 lines | 9 code | 6 blank | 47 comment | 0 complexity | b867744b10509cba996ab0179fe8151d 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.<p>
26 *
27 * See {@link EditPlugin} for information on how jEdit obtains and constructs
28 * option pane instances.<p>
29 *
30 * Note that in most cases it is much easier to extend
31 * {@link AbstractOptionPane} instead.
32 *
33 * @author Slava Pestov
34 * @version $Id: OptionPane.java 4669 2003-05-01 02:21:27Z spestov $
35 */
36public interface OptionPane
37{
38	/**
39	 * Returns the internal name of this option pane. The option pane's label
40	 * is set to the value of the property named
41	 * <code>options.<i>name</i>.label</code>.
42	 * @see jEdit#getProperty(String)
43	 */
44	String getName();
45
46	/**
47	 * Returns the component that should be displayed for this option pane.
48	 */
49	Component getComponent();
50
51	/**
52	 * This method is called every time the option pane is displayed.
53	 */
54	void init();
55
56	/**
57	 * Called when the options dialog's "ok" button is clicked.
58	 * This should save any properties being edited in this option
59	 * pane.
60	 */
61	void save();
62}