org.apache.tapestry.spec

Class ContainedComponent

java.lang.Object

org.apache.tapestry.util.BasePropertyHolder

org.apache.tapestry.spec.LocatablePropertyHolder

org.apache.tapestry.spec.ContainedComponent

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IContainedComponent, PropertyInjectable, 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.

Author:

Howard Lewis Ship

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map	bindings

Constructor Summary

Constructors

Constructor and Description
ContainedComponent()

Method Summary

Methods

Modifier and Type	Method and Description
IBindingSpecification	getBinding(java.lang.String name) Returns the named binding, or null if the binding does not exist.
java.util.Collection	getBindingNames() Returns an umodifiable Collection of Strings, each the name of one binding for the component.
java.lang.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.
java.lang.String	getPropertyName() Returns the name of the property to be created for this component, or null if no property should be created.
java.lang.String	getType()
void	setBinding(java.lang.String name, IBindingSpecification spec)
void	setCopyOf(java.lang.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	setPropertyName(java.lang.String propertyName)
void	setType(java.lang.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.hivemind.LocationHolder

setLocation

Methods inherited from interface org.apache.hivemind.Locatable

getLocation

Field Detail

bindings

protected java.util.Map bindings

Constructor Detail

ContainedComponent

public ContainedComponent()

Method Detail

getBinding

public IBindingSpecification getBinding(java.lang.String name)

Returns the named binding, or null if the binding does not exist.

Specified by:

getBinding in interface IContainedComponent

getBindingNames

public java.util.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 java.lang.String getType()

Specified by:

getType in interface IContainedComponent

setBinding

public void setBinding(java.lang.String name,
              IBindingSpecification spec)

Specified by:

setBinding in interface IContainedComponent

setType

public void setType(java.lang.String value)

Specified by:

setType in interface IContainedComponent

setCopyOf

public void setCopyOf(java.lang.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 java.lang.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

getPropertyName

public java.lang.String getPropertyName()

Description copied from interface: IContainedComponent

Returns the name of the property to be created for this component, or null if no property should be created.

Specified by:

getPropertyName in interface IContainedComponent

Specified by:

getPropertyName in interface PropertyInjectable

Since:

4.0

setPropertyName

public void setPropertyName(java.lang.String propertyName)

Specified by:

setPropertyName in interface IContainedComponent

Specified by:

setPropertyName in interface PropertyInjectable

Since:

4.0