|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tapestry.util.BasePropertyHolder org.apache.tapestry.spec.LocatablePropertyHolder org.apache.tapestry.spec.ComponentSpecification
public class ComponentSpecification
A specification for a component, as read from an XML specification file.
A specification consists of
From this information, an actual component may be instantiated and initialized. Instantiating a component is usually a recursive process, since to initialize a container component, it is necessary to instantiate and initialize its contained components as well.
IComponent
,
IContainedComponent
,
IPageLoader
Field Summary | |
---|---|
protected Map |
_assets
Keyed on asset name, value is IAssetSpecification . |
protected Map |
_beans
Defines all helper beans. |
protected Map |
_components
Keyed on component id, value is IContainedComponent . |
protected Map |
_parameters
Defines all formal parameters. |
protected Set |
_reservedParameterNames
The names of all reserved informal parameter names (as lower-case). |
Constructor Summary | |
---|---|
ComponentSpecification()
|
Method Summary | |
---|---|
void |
addAsset(String name,
IAssetSpecification asset)
|
void |
addBeanSpecification(String name,
IBeanSpecification specification)
|
void |
addComponent(String id,
IContainedComponent component)
|
void |
addParameter(String name,
IParameterSpecification spec)
Adds the parameter. |
void |
addPropertySpecification(IPropertySpecification spec)
Adds a new property specification. |
void |
addReservedParameterName(String value)
Adds the value as a reserved name. |
boolean |
getAllowBody()
Returns true if the component is allowed to wrap other elements (static HTML or other components). |
boolean |
getAllowInformalParameters()
Returns true if the component allows informal parameters (parameters not formally defined). |
IAssetSpecification |
getAsset(String name)
Returns the IAssetSpecification with the given name, or null
if no such specification exists. |
List |
getAssetNames()
Returns a List
of the String names of all assets, in alphabetical
order |
Collection |
getBeanNames()
Returns an unmodifiable collection of the names of all beans. |
IBeanSpecification |
getBeanSpecification(String name)
Returns the IBeanSpecification for the given name, or null
if not such specification exists. |
IContainedComponent |
getComponent(String id)
Returns the specification of a contained component with the given id, or null if no such contained component exists. |
String |
getComponentClassName()
|
List |
getComponentIds()
Returns an List
of the String names of the IContainedComponent s
for this component. |
String |
getDescription()
Returns the documentation for this component. |
IParameterSpecification |
getParameter(String name)
Returns the specification of a parameter with the given name, or null if no such parameter exists. |
List |
getParameterNames()
Returns a List of of String names of all parameters. |
IPropertySpecification |
getPropertySpecification(String name)
Returns the named IPropertySpecification ,
or null if no such specification exist. |
List |
getPropertySpecificationNames()
Returns a sorted, immutable list of the names of all IPropertySpecification s. |
String |
getPublicId()
Returns the XML Public Id for the specification file, or null if not applicable. |
IResourceLocation |
getSpecificationLocation()
|
boolean |
isPageSpecification()
Returns true if the specification is known to be a page specification and not a component specification. |
boolean |
isReservedParameterName(String value)
Returns true if the value specified is in the reserved name list. |
void |
setAllowBody(boolean value)
|
void |
setAllowInformalParameters(boolean value)
|
void |
setComponentClassName(String value)
|
void |
setDescription(String description)
Sets the documentation for this component. |
void |
setPageSpecification(boolean pageSpecification)
|
void |
setPublicId(String publicId)
|
void |
setSpecificationLocation(IResourceLocation specificationLocation)
|
String |
toString()
|
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, 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 |
---|
protected Map _components
IContainedComponent
.
protected Map _assets
IAssetSpecification
.
protected Map _parameters
IParameterSpecification
.
protected Map _beans
IBeanSpecification
.
protected Set _reservedParameterNames
Constructor Detail |
---|
public ComponentSpecification()
Method Detail |
---|
public void addAsset(String name, IAssetSpecification asset)
addAsset
in interface IComponentSpecification
IllegalArgumentException
- if the name already exists.public void addComponent(String id, IContainedComponent component)
addComponent
in interface IComponentSpecification
IllegalArgumentException
- if the id is already defined.public void addParameter(String name, IParameterSpecification spec)
addParameter
in interface IComponentSpecification
IllegalArgumentException
- if the name already exists.public boolean getAllowBody()
getAllowBody
in interface IComponentSpecification
setAllowBody(boolean)
public boolean getAllowInformalParameters()
The default value is true.
getAllowInformalParameters
in interface IComponentSpecification
setAllowInformalParameters(boolean)
public IAssetSpecification getAsset(String name)
IAssetSpecification
with the given name, or null
if no such specification exists.
getAsset
in interface IComponentSpecification
addAsset(String,IAssetSpecification)
public List getAssetNames()
List
of the String names of all assets, in alphabetical
order
getAssetNames
in interface IComponentSpecification
public IContainedComponent getComponent(String id)
getComponent
in interface IComponentSpecification
addComponent(String, IContainedComponent)
public String getComponentClassName()
getComponentClassName
in interface IComponentSpecification
public List getComponentIds()
List
of the String names of the IContainedComponent
s
for this component.
getComponentIds
in interface IComponentSpecification
addComponent(String, IContainedComponent)
public IParameterSpecification getParameter(String name)
getParameter
in interface IComponentSpecification
addParameter(String, IParameterSpecification)
public List getParameterNames()
getParameterNames
in interface IComponentSpecification
addParameter(String, IParameterSpecification)
public void setAllowBody(boolean value)
setAllowBody
in interface IComponentSpecification
public void setAllowInformalParameters(boolean value)
setAllowInformalParameters
in interface IComponentSpecification
public void setComponentClassName(String value)
setComponentClassName
in interface IComponentSpecification
public void addBeanSpecification(String name, IBeanSpecification specification)
addBeanSpecification
in interface IComponentSpecification
IllegalArgumentException
- if the bean already has a specification.public IBeanSpecification getBeanSpecification(String name)
IBeanSpecification
for the given name, or null
if not such specification exists.
getBeanSpecification
in interface IComponentSpecification
public Collection getBeanNames()
getBeanNames
in interface IComponentSpecification
public void addReservedParameterName(String value)
addReservedParameterName
in interface IComponentSpecification
public boolean isReservedParameterName(String value)
isReservedParameterName
in interface IComponentSpecification
public String toString()
toString
in class Object
public String getDescription()
getDescription
in interface IComponentSpecification
public void setDescription(String description)
setDescription
in interface IComponentSpecification
public String getPublicId()
This method exists as a convienience for the Spindle plugin. A previous method used an arbitrary version string, the public id is more useful and less ambiguous.
getPublicId
in interface IComponentSpecification
public void setPublicId(String publicId)
setPublicId
in interface IComponentSpecification
public boolean isPageSpecification()
isPageSpecification
in interface IComponentSpecification
public void setPageSpecification(boolean pageSpecification)
setPageSpecification
in interface IComponentSpecification
public IResourceLocation getSpecificationLocation()
getSpecificationLocation
in interface IComponentSpecification
public void setSpecificationLocation(IResourceLocation specificationLocation)
setSpecificationLocation
in interface IComponentSpecification
public void addPropertySpecification(IPropertySpecification spec)
addPropertySpecification
in interface IComponentSpecification
public List getPropertySpecificationNames()
IPropertySpecification
s.
getPropertySpecificationNames
in interface IComponentSpecification
public IPropertySpecification getPropertySpecification(String name)
IPropertySpecification
,
or null if no such specification exist.
getPropertySpecification
in interface IComponentSpecification
addPropertySpecification(IPropertySpecification)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |