com.jeta.open.support
Interface ComponentFinder

All Known Subinterfaces:
FormAccessor, SwingComponentSupport
All Known Implementing Classes:
CompositeComponentFinder, DefaultComponentFinder, FormPanel, HierarchicalComponentFinder, JETAPanel

public interface ComponentFinder

Interface used to define a service for locating child components within a container that have a given name. Specialized implementations of this interface are responsible for managing the parent container assocation.


Method Summary
 Collection getAllNamedComponents()
          Recursively searches an associated parent container for all components that are named.
 Component getComponentByName(String compName)
          Recursively searches an associated parent container for a component with the given name.
 Collection getComponentsByName(String compName)
          Recursively searches an associated parent container for all components with the given name.
 void reset()
          Tells the implementation that any cached components should be flushed and reloaded because the parent container might have changed.
 

Method Detail

getComponentByName

Component getComponentByName(String compName)
Recursively searches an associated parent container for a component with the given name. The first component found that has the name is returned. Null is returned if no component is found.


getComponentsByName

Collection getComponentsByName(String compName)
Recursively searches an associated parent container for all components with the given name. An empty collection is returned if no components are found with the given name.

Returns:
a collection of Component objects that have the given name.

getAllNamedComponents

Collection getAllNamedComponents()
Recursively searches an associated parent container for all components that are named. An empty collection is returned if no names components exist.

Returns:
a collection of all named Component objects.

reset

void reset()
Tells the implementation that any cached components should be flushed and reloaded because the parent container might have changed.



Copyright © 2005-2007 Jeff Tassin & Todd Viegut. All Rights Reserved.