org.apache.tapestry.spec
Class ContainedComponent

java.lang.Object
  extended by org.apache.tapestry.util.BasePropertyHolder
      extended by org.apache.tapestry.spec.LocatablePropertyHolder
          extended by org.apache.tapestry.spec.ContainedComponent
All Implemented Interfaces:
ILocatable, ILocationHolder, IContainedComponent, IPropertyHolder

public class ContainedComponent
extends LocatablePropertyHolder
implements IContainedComponent

Defines a contained component. This includes the information needed to get the contained component's specification, as well as any bindings for the component.

Version:
$Id: ContainedComponent.java 243791 2004-02-19 17:38:13Z hlship $
Author:
Howard Lewis Ship

Field Summary
protected  Map bindings
           
 
Constructor Summary
ContainedComponent()
           
 
Method Summary
 IBindingSpecification getBinding(String name)
          Returns the named binding, or null if the binding does not exist.
 Collection getBindingNames()
          Returns an umodifiable Collection of Strings, each the name of one binding for the component.
 String getCopyOf()
          Returns the id of the component being copied from.
 boolean getInheritInformalParameters()
          Returns whether the contained component will inherit the informal parameters of its parent.
 String getType()
           
 void setBinding(String name, IBindingSpecification spec)
           
 void setCopyOf(String id)
          Sets the String Id of the component being copied from.
 void setInheritInformalParameters(boolean value)
          Sets whether the contained component will inherit the informal parameters of its parent.
 void setType(String value)
           
 
Methods inherited from class org.apache.tapestry.spec.LocatablePropertyHolder
getLocation, setLocation
 
Methods inherited from class org.apache.tapestry.util.BasePropertyHolder
getProperty, getPropertyNames, removeProperty, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.tapestry.util.IPropertyHolder
getProperty, getPropertyNames, removeProperty, setProperty
 
Methods inherited from interface org.apache.tapestry.ILocationHolder
setLocation
 
Methods inherited from interface org.apache.tapestry.ILocatable
getLocation
 

Field Detail

bindings

protected Map bindings
Constructor Detail

ContainedComponent

public ContainedComponent()
Method Detail

getBinding

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

Specified by:
getBinding in interface IContainedComponent

getBindingNames

public Collection getBindingNames()
Returns an umodifiable Collection of Strings, each the name of one binding for the component.

Specified by:
getBindingNames in interface IContainedComponent

getType

public String getType()
Specified by:
getType in interface IContainedComponent

setBinding

public void setBinding(String name,
                       IBindingSpecification spec)
Specified by:
setBinding in interface IContainedComponent

setType

public void setType(String value)
Specified by:
setType in interface IContainedComponent

setCopyOf

public void setCopyOf(String id)
Sets the String Id of the component being copied from. For use by IDE tools like Spindle.

Specified by:
setCopyOf in interface IContainedComponent
Since:
1.0.9

getCopyOf

public String getCopyOf()
Returns the id of the component being copied from. For use by IDE tools like Spindle.

Specified by:
getCopyOf in interface IContainedComponent
Since:
1.0.9

getInheritInformalParameters

public boolean getInheritInformalParameters()
Returns whether the contained component will inherit the informal parameters of its parent.

Specified by:
getInheritInformalParameters in interface IContainedComponent
Since:
3.0

setInheritInformalParameters

public void setInheritInformalParameters(boolean value)
Sets whether the contained component will inherit the informal parameters of its parent.

Specified by:
setInheritInformalParameters in interface IContainedComponent
Since:
3.0