io.guise.framework.component.Components Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
/*
* Copyright © 2005-2011 GlobalMentor, Inc.
* The navigation path is determined by finding the first {@link NavigationComponent} ancestor in the component's hierarchy.
*
* @param component The component for which the navigation path should be found.
* @return The navigation path for the given component.
*/
public static URIPath getNavigationPath(Component component) {
URIPath navigationPath = null;
do {
if(component instanceof NavigationComponent) { //if this component may have navigation information
navigationPath = ((NavigationComponent)component).getNavigationPath(); //ask the component for navigation information
}
component = component.getParent(); //get the component parent in case we need to keep looking
} while(component != null && navigationPath == null); //keep looking until we find the first navigation path---or we run out of components in the hierarchy
return navigationPath; //return the navigation path, if any
}
/**
* Retrieves all components, including the given component and all descendant components.
* @param component The component to search.
* @throws NullPointerException if the given component is null.
* @return The collection of components.
*/
public static Collection getComponents(final Component component) {
return getComponents(component, new HashSet()); //return all components in a hash set
}
/**
* Retrieves all components, including the given component and all descendant components.
* @param The type of the component collection.
* @param component The component to search.
* @param componentCollection The collection into which the components will be collected.
* @throws NullPointerException if the given component and/or collection is null.
* @return The component collection.
*/
public static > T getComponents(final Component component, final T componentCollection) {
return getComponents(component, Component.class, componentCollection, true, true); //get all components deeply
}
/**
* Retrieves all components, including the given component, that are instances of the of the given class. If deep is set to true, the
* component's child components are recursively searched if the component is a composite component. If below is set to true, the child
* components of any composite component that is an instance of the given class are also recursively searched.
* @param The type of the component.
* @param The type of the component collection.
* @param component The component to search.
* @param componentClass The type of component to retrieve.
* @param componentCollection The collection into which the components will be collected.
* @param deep true if the children of composite components should recursively be searched.
* @param below true if the children of composite components that are instances of the given class should recursively be searched, if
* deep is set to true.
* @throws NullPointerException if the given component, component class, and/or collection is null.
* @return The component collection.
*/
public static > T getComponents(final Component component, final Class componentClass, final T componentCollection,
final boolean deep, final boolean below) {
final boolean match = componentClass.isInstance(component); //determine if this component is an instance of the given class
if(match) { //if the component is an instance of the given class
componentCollection.add(componentClass.cast(component)); //add the component to the collection
}
if(deep && (!match || below) && component instanceof CompositeComponent) { //if we should go deep, see if this is not a match (or they want to search matches, too) and if this is is a composite component
getChildComponents((CompositeComponent)component, componentClass, componentCollection, deep, below); //get the components of the child components
}
return componentCollection; //return the collection
}
/**
* Retrieves all descendant components.
* @param compositeComponent The component to search.
* @throws NullPointerException if the given component is null.
* @return The collection of components.
*/
public static Collection getDescendantComponents(final CompositeComponent compositeComponent) {
return getDescendantComponents(compositeComponent, new HashSet()); //return all descendant components in a hash set
}
/**
* Retrieves all descendant components.
* @param The type of the components.
* @param compositeComponent The component to search.
* @param componentCollection The collection into which the components will be collected.
* @throws NullPointerException if the given component and/or collection is null.
* @return The component collection.
*/
public static > T getDescendantComponents(final CompositeComponent compositeComponent, final T componentCollection) {
return getChildComponents(compositeComponent, Component.class, componentCollection, true, true); //get all child components deeply
}
/**
* Retrieves all child components that are instances of the of the given class. If deep is set to true, a component's child components
* are recursively searched if that component is a composite component. If below is set to true, the child components of any composite
* component that is an instance of the given class are also recursively searched.
* @param The type of the component collection.
* @param The type of the objects from the collection.
* @param compositeComponent The component to search.
* @param componentClass The type of component to retrieve.
* @param componentCollection The collection into which the components will be collected.
* @param deep true if the children of composite components should recursively be searched.
* @param below true if the children of composite components that are instances of the given class should recursively be searched, if
* deep is set to true.
* @throws NullPointerException if the given component, component class, and/or collection is null.
* @return The component collection.
*/
public static > T getChildComponents(final CompositeComponent compositeComponent, final Class componentClass,
final T componentCollection, final boolean deep, final boolean below) {
for(final Component childComponent : compositeComponent.getChildComponents()) { //for each child component
getComponents(childComponent, componentClass, componentCollection, deep, below); //get the components under the child component
}
return componentCollection; //return the collection
}
/**
* Determines if the given component is or has as a descendant the given other component.
* @param component The component to search.
* @param hasComponent The component to find.
* @throws NullPointerException if one of the given components is null.
* @return true if the given component is the composite component or is a descendant of the given composite component.
*/
public static boolean hasComponent(final Component component, final Component hasComponent) {
return hasComponent(component, hasComponent, true); //do a deep search for the component
}
/**
* Determines if the given component is or has as a descendant the given other component.
* @param component The component to search.
* @param hasComponent The component to find.
* @param deep true if the children of composite components should recursively be searched.
* @throws NullPointerException if one of the given components is null.
* @return true if the given component is the composite component or is a descendant of the given composite component.
*/
public static boolean hasComponent(final Component component, final Component hasComponent, final boolean deep) {
if(component.equals(hasComponent)) { //if the components are equal
return true; //we found the component
} else if(deep && component instanceof CompositeComponent) { //if we should search deeply and this is a composite component
return hasChildComponent((CompositeComponent)component, hasComponent, deep); //check the children
}
return false; //this is not the component, and we were asked not to check deeply
}
/**
* Determines if the given composite component has the given component as one of its descendants.
* @param compositeComponent The component to search.
* @param component The component to find.
* @throws NullPointerException if the given composite component or component is null.
* @return Whether the given component is a descendant of the given composite component.
*/
public static boolean hasChildComponent(final CompositeComponent compositeComponent, final Component component) {
return hasChildComponent(compositeComponent, component, true); //do a deep search on the children
}
/**
* Determines if the given composite component has the given component as one of its descendants.
* @param compositeComponent The component to search.
* @param component The component to find.
* @param deep true if the children of composite components should recursively be searched.
* @throws NullPointerException if the given composite component or component is null.
* @return Whether the given component is a descendant of the given composite component.
*/
public static boolean hasChildComponent(final CompositeComponent compositeComponent, final Component component, final boolean deep) {
if(deep) { //if we should search deeply, do this a tree at a time so as not to redundantly iterate
for(final Component childComponent : compositeComponent.getChildComponents()) { //for each child component
if(hasComponent(childComponent, component, deep)) { //if this child is or has the component
return true; //we found the component
}
}
} else { //if we should not search deeply
for(final Component childComponent : compositeComponent.getChildComponents()) { //for each child component
if(compositeComponent.equals(component)) { //if the components are equal
return true; //we found the component
}
}
}
return false; //we couldn't find the component
}
}