View Javadoc
1 /*
2 * Copyright (c) 2003 Scott Howlett & Paul Libbrecht.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
16 *
17 * 3. The end-user documentation included with the redistribution,
18 * if any, must include the following acknowledgment:
19 * "This product includes software developed by the Xwing
20 * Project ( http://xwing.sourceforge.net/ )."
21 * Alternately, this acknowledgment may appear in the software itself,
22 * if and wherever such third-party acknowledgments normally appear.
23 *
24 * 4. The name "Xwing" must not be used to endorse or promote products
25 * derived from this software without prior written permission. For
26 * written permission, please contact the project authors via
27 * the Xwing project site, http://xwing.sourceforge.net/ .
28 *
29 * 5. Products derived from this software may not be called "Xwing",
30 * nor may "Xwing" appear in their name, without prior written
31 * permission of the Xwing project.
32 *
33 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36 * DISCLAIMED. IN NO EVENT SHALL THE XWING AUTHORS OR THE PROJECT
37 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44 * SUCH DAMAGE.
45 *
46 * For more information on Xwing, please see
47 * < http://xwing.sourceforge.net/ >.
48 */
49
50 package net.sourceforge.xwing;
51
52 import javax.swing.AbstractListModel;
53 import javax.swing.ListModel;
54 import javax.swing.event.ListDataEvent;
55 import javax.swing.event.ListDataListener;
56
57 /***
58 * A base class for ListModel implementations that filter the
59 * values retrieved from some underlying ListModel.
60 *
61 * @author Scott Howlett
62 * @version $Revision: 1.3 $
63 */
64 public abstract class FilteringListModel extends AbstractListModel {
65
66 private ListModel src;
67
68 /***
69 * Create a new FilteringListModel.
70 * @param src The underlying ListModel that we filter.
71 */
72
73 public FilteringListModel(ListModel src) {
74 this.src = src;
75 src.addListDataListener(new ListDataListener() {
76 public void contentsChanged(ListDataEvent e) {
77 fireContentsChanged(
78 FilteringListModel.this,
79 e.getIndex0(),
80 e.getIndex1());
81 }
82
83 public void intervalAdded(ListDataEvent e) {
84 fireIntervalAdded(
85 FilteringListModel.this,
86 e.getIndex0(),
87 e.getIndex1());
88 }
89
90 public void intervalRemoved(ListDataEvent e) {
91 fireIntervalRemoved(
92 FilteringListModel.this,
93 e.getIndex0(),
94 e.getIndex1());
95 }
96 });
97 }
98
99 public int getSize() {
100 return src.getSize();
101 }
102
103 public Object getElementAt(int index) {
104 return readFilter(src.getElementAt(index));
105 }
106
107 /***
108 * Overridden by all derived classes to provide specific
109 * filtering behavior.
110 * @param src The value from the underlying ListModel.
111 * @return The filtered value.
112 */
113 public abstract Object readFilter(Object src);
114 }
This page was automatically generated by Maven