PageRenderTime 24ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/bundles/plugins-trunk/CommonControls/common/gui/itemfinder/ItemFinder.java

#
Java | 65 lines | 10 code | 6 blank | 49 comment | 0 complexity | 19ee416fc0231609e2fd7e93d5f2bb03 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0
  1. /*
  2. * ItemFinder.java
  3. * :tabSize=8:indentSize=8:noTabs=false:
  4. * :folding=explicit:collapseFolds=1:
  5. *
  6. * Copyright (C) 2011 Matthieu Casanova
  7. *
  8. * This program is free software; you can redistribute it and/or
  9. * modify it under the terms of the GNU General Public License
  10. * as published by the Free Software Foundation; either version 2
  11. * of the License, or any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  21. */
  22. package common.gui.itemfinder;
  23. import javax.swing.*;
  24. /**
  25. * @author Matthieu Casanova
  26. */
  27. public interface ItemFinder<E>
  28. {
  29. /**
  30. * Returns the label for that ItemFinder.
  31. * If it is null, there is no label.
  32. * Otherwise the label will be displayed on top of the textfield,
  33. * if the panel is in an ItemFinderWindow, and on the left otherwise.
  34. * @return the label or null
  35. */
  36. String getLabel();
  37. /**
  38. * The list model that is used by the ItemFinderWindow
  39. * @return a listmodel
  40. */
  41. ListModel getModel();
  42. /**
  43. * Returns a ListCellRenderer that will render the celles of the dropdown list.
  44. * If null, the default one is used
  45. * @return the ListCellRenderer
  46. */
  47. ListCellRenderer getListCellRenderer();
  48. /**
  49. * Some chars were typed, update the list
  50. * @param s the searched string
  51. */
  52. void updateList(String s);
  53. /**
  54. * A selection has been made.
  55. * Do an action
  56. * @param item the selected item
  57. */
  58. void selectionMade(E item);
  59. }