org.apache.tapestry.services
Interface ComponentPropertySource

All Known Implementing Classes:

ComponentPropertySourceImpl

public interface ComponentPropertySource

Encapsulates the logic for searching for component meta-data. Deployed as service tapestry.props.ComponentPropertySource.

TODO: Adjust name, since it now provides access to namespace properties as well as component properties.

Since:

4.0

Author:

Howard M. Lewis Ship

Method Summary

String	getComponentProperty(IComponent component, String propertyName) Returns the property value for a particular named meta-data property of the component.
String	getLocalizedComponentProperty(IComponent component, Locale locale, String propertyName) Like getComponentProperty(IComponent, String), but the property name will be localized to the component's current locale (determined from its page).
String	getLocalizedNamespaceProperty(INamespace namespace, Locale locale, String propertyName) As with getLocalizedComponentProperty(IComponent, Locale, String), but with a INamespace.
String	getNamespaceProperty(INamespace namespace, String propertyName) Returns the property value for a particular named meta-data property of the namespace.

Method Detail

getComponentProperty

String getComponentProperty(IComponent component,
                            String propertyName)

Returns the property value for a particular named meta-data property of the component. The search order is:

• The component's specification
• The specification of the application (or the library containing the component).
• The chain of global property sources.

Parameters:

component - The IComponent to get the property of.

propertyName - Key of the property.

Returns:

the value of the given key, or null if not found.

getLocalizedComponentProperty

String getLocalizedComponentProperty(IComponent component,
                                     Locale locale,
                                     String propertyName)

Like getComponentProperty(IComponent, String), but the property name will be localized to the component's current locale (determined from its page). Localizing the property name means that a suffix may be appended to it. If the fully localized name is not found, then the locale is generalized (i.e., from "en_UK" to "en" to nothing) until a match is found.

Parameters:

component - The IComponent to get the property of.

locale - The Locale to get properties for.

propertyName - Key of the property.

Returns:

the value of the given property name, or null if not found.

getNamespaceProperty

String getNamespaceProperty(INamespace namespace,
                            String propertyName)

Returns the property value for a particular named meta-data property of the namespace. The search order is:

• The library or application specification for the namespace.
• The chain of global property sources.

Parameters:

namespace - The namespace to get the property from.

propertyName - The key of the property to get.

Returns:

the value of the given key, or null if not found.

getLocalizedNamespaceProperty

String getLocalizedNamespaceProperty(INamespace namespace,
                                     Locale locale,
                                     String propertyName)

As with getLocalizedComponentProperty(IComponent, Locale, String), but with a INamespace.

Parameters:

namespace - The namespace to get the property from.

locale - Locale to filter the properties for.

propertyName - The key of the property to get.

Returns:

The matching property, or null if not found.