DataComboBoxModel


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.modules.db.util;
21  
22  import javax.swing.ComboBoxModel  ;
23  
24  /**
25   * Serves as a model for {@link DataComboBoxSupport}.
26   *
27   * @author Andrei Badea
28   */
29  public interface DataComboBoxModel {
30  
31      /**
32       * Returns the combo box model; cannot be null.
33       */
34      ComboBoxModel   getListModel();
35  
36      /**
37       * Returns the display name for the given item. The given item
38       * is one of the items in the model returned by {@link #getListModel}.
39       */
40      String   getItemDisplayName(Object   item);
41  
42      /**
43       * Returns the tooltip text for the given item. The given item
44       * is one of the items in the model returned by {@link #getListModel}.
45       */
46      String   getItemTooltipText(Object   item);
47  
48      /**
49       * Returns the text for the "Add item" item (used to add new items 
50       * to the combo box).
51       */
52      String   getNewItemDisplayName();
53  
54      /**
55       * Invoked when the "Add item" is selected. This method should do 
56       * whatever is necessary to retrieve the new item to be added (e.g.
57       * by prompting the user) and add the new item to {@link #getListModel},
58       * firing a contentsChanged event.
59       */
60      void newItemActionPerformed();
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags