View Javadoc

1   /*
2    *  XNap - A P2P framework and client.
3    *
4    *  See the file AUTHORS for copyright information.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation.
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  package org.xnap.gui.component;
20  
21  import javax.swing.text.JTextComponent;
22  
23  /***
24   * Classes implementing this interface can be adorned with a {@link
25   * CompletionModeMenu} or a {@link TextFieldMenu} which has a
26   * CompletionModeMenu as a submenu.
27   */
28  public interface Completable
29  {
30  	/***
31  	 * Sets the completion mode to one of the modes provided by the {@link
32  	 * CompletionModeFactory}.
33  	 *
34  	 * @param mode the unique id of the completion mode
35  	 */
36  	void setCompletionMode(String mode);
37  	/***
38  	 * Returns the currently set completion mode.  
39  	 */
40  	CompletionMode getCompletionMode();
41  	/***
42  	 * Sets the completion model.
43  	 */
44  	void setCompletionModel(CompletionModel model);
45  	/***
46  	 * Returns the currently used completion model.
47  	 */
48  	CompletionModel getCompletionModel();
49  	/***
50  	 * Returns the text component the completion mode should operate on.
51  	 */
52  	JTextComponent getTextComponent();
53  }