tapestry/tapestry-framework/src/java/org/apache/tapestry/spec/IContainedComponent.java

// Copyright 2004, 2005 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry.spec;

import java.util.Collection;

import org.apache.hivemind.Locatable;
import org.apache.hivemind.LocationHolder;
import org.apache.tapestry.util.IPropertyHolder;

/**
 * Defines a contained component. This includes the information needed to get
 * the contained component's specification, as well as any bindings for the
 * component.
 * 
 * @author glongman@intelligentworks.com
 */
public interface IContainedComponent extends IPropertyHolder, LocationHolder,
        Locatable, PropertyInjectable
{

    /**
     * Returns the named binding, or null if the binding does not exist.
     */
    IBindingSpecification getBinding(String name);

    /**
     * Returns an umodifiable <code>Collection</code> of Strings, each the
     * name of one binding for the component.
     */
    Collection getBindingNames();

    String getType();

    void setBinding(String name, IBindingSpecification spec);

    void setType(String value);
    
    /**
     * Sets the String Id of the component being copied from. For use by IDE
     * tools like Spindle.
     * 
     * @since 1.0.9
     */
    void setCopyOf(String id);

    /**
     * Returns the id of the component being copied from. For use by IDE tools
     * like Spindle.
     * 
     * @since 1.0.9
     */
    String getCopyOf();

    /**
     * Returns whether the contained component will inherit the informal
     * parameters of its parent.
     * 
     * @since 3.0
     */
    boolean getInheritInformalParameters();

    /**
     * Sets whether the contained component will inherit the informal parameters
     * of its parent.
     * 
     * @since 3.0
     */
    void setInheritInformalParameters(boolean value);

    /**
     * Returns the name of the property to be created for this component, or
     * null if no property should be created.
     * 
     * @since 4.0
     */
    String getPropertyName();

    /**
     * @since 4.0
     */

    void setPropertyName(String propertyName);
}