View Javadoc

1   /*
2    *  XNap Commons
3    *
4    *  Copyright (C) 2005  Felix Berger
5    *
6    *  This library is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU Lesser General Public
8    *  License as published by the Free Software Foundation; either
9    *  version 2.1 of the License, or (at your option) any later version.
10   *
11   *  This library is distributed in the hope that it will be useful,
12   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   *  Lesser General Public License for more details.
15   *
16   *  You should have received a copy of the GNU Lesser General Public
17   *  License along with this library; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package org.xnap.commons.gui.completion;
21  
22  /***
23   * Classes implementing this interface handle the way completion is 
24   * actually done.
25   *
26   * They decide when and how to offer completion to the user. Completion may be
27   * triggered using a special key, it may be visible all the time, it may use a
28   * {@link org.xnap.commons.gui.completion.CompletionPopup} to present all 
29   * possibilities or may insert the text directly.
30   * 
31   * @author Felix Berger
32   * TODO symmetrical interface + IllegalStateException
33   */
34  public interface CompletionMode
35  {
36  	/***
37  	 * Enables the completion mode letting it add its listeners to the text
38  	 * component.
39  	 * 
40  	 * @param completion provides all components and information the completion 
41  	 * mode must know about
42  	 */
43  	void enable(Completion completion);
44  	/***
45  	 * Disables the completion mode letting it remove its listeners from the
46  	 * text component.
47  	 */
48  	void disable();
49  }