org.apache.tapestry.spec
Interface IContainedComponent

All Superinterfaces:

IPropertyHolder, org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, PropertyInjectable

All Known Implementing Classes:

ContainedComponent

public interface IContainedComponent
extends IPropertyHolder, org.apache.hivemind.LocationHolder, org.apache.hivemind.Locatable, PropertyInjectable

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

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	getPropertyName() Returns the name of the property to be created for this component, or null if no property should be created.
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	setPropertyName(String propertyName)
void	setType(String value)

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

Method Detail

getBinding

IBindingSpecification getBinding(String name)

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

getBindingNames

Collection getBindingNames()

Returns an umodifiable Collection of Strings, each the name of one binding for the component.

getType

String getType()

setBinding

void setBinding(String name,
                IBindingSpecification spec)

setType

void setType(String value)

setCopyOf

void setCopyOf(String id)

Sets the String Id of the component being copied from. For use by IDE tools like Spindle.

Since:

1.0.9

getCopyOf

String getCopyOf()

Returns the id of the component being copied from. For use by IDE tools like Spindle.

Since:

1.0.9

getInheritInformalParameters

boolean getInheritInformalParameters()

Returns whether the contained component will inherit the informal parameters of its parent.

Since:

3.0

setInheritInformalParameters

void setInheritInformalParameters(boolean value)

Sets whether the contained component will inherit the informal parameters of its parent.

Since:

3.0

getPropertyName

String getPropertyName()

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 PropertyInjectable

Since:

4.0

setPropertyName

void setPropertyName(String propertyName)

Specified by:

setPropertyName in interface PropertyInjectable

Since:

4.0