01: /*
02: * Copyright (c) 2004 JETA Software, Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without modification,
05: * are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * o Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * o Neither the name of JETA Software nor the names of its contributors may
15: * be used to endorse or promote products derived from this software without
16: * specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
22: * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23: * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25: * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26: * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: */
29:
30: package com.jeta.open.support;
31:
32: import java.awt.Component;
33: import java.util.Collection;
34:
35: /**
36: * Interface used to define a service for locating child components within a
37: * container that have a given name. Specialized implementations of this
38: * interface are responsible for managing the parent container assocation.
39: *
40: * @author Jeff Tassin
41: */
42: public interface ComponentFinder {
43:
44: /**
45: * Recursively searches an associated parent container for a component with
46: * the given name. The first component found that has the name is returned.
47: * Null is returned if no component is found.
48: */
49: public Component getComponentByName(String compName);
50:
51: /**
52: * Recursively searches an associated parent container for all components
53: * with the given name. An empty collection is returned if no components are
54: * found with the given name.
55: *
56: * @return a collection of Component objects that have the given name.
57: */
58: public Collection getComponentsByName(String compName);
59:
60: /**
61: * Recursively searches an associated parent container for all components
62: * that are named. An empty collection is returned if no names components
63: * exist.
64: *
65: * @return a collection of all named Component objects.
66: */
67: public Collection getAllNamedComponents();
68:
69: /**
70: * Tells the implementation that any cached components should be flushed and
71: * reloaded because the parent container might have changed.
72: */
73: public void reset();
74: }
|