Package org.apache.tiles
Interface AttributeContext
- All Known Implementing Classes:
BasicAttributeContext
,Definition
public interface AttributeContext
Encapsulation of the current state of execution.
- Since:
- Tiles 2.0
- Version:
- $Rev: 829574 $ $Date: 2009-10-26 01:15:31 +1100 (Mon, 26 Oct 2009) $
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add all attributes to the context.void
addMissing
(Map<String, Attribute> defaultAttributes) Add all attributes to the context.void
clear()
Clear the attributes.getAttribute
(String name) Retrieve the named attribute, either cascaded or not.getCascadedAttribute
(String name) Retrieve the attribute that has been cascaded at upper levels.Returns the names of the cascaded attributes.getLocalAttribute
(String name) Retrieve the attribute that has been defined in this context (i.e.Returns the names of the local attributes, i.e.Get associated preparer instance.Returns the attribute that will be used to render a template.void
inherit
(AttributeContext parent) Copies all missing attributes from theparent
attribute context to this one.void
Copies the cascaded attributes to this attribute context.void
putAttribute
(String name, Attribute value) Add the specified attribute.void
putAttribute
(String name, Attribute value, boolean cascade) Add the specified attribute.void
setPreparer
(String url) Set associated preparer instance.void
setTemplateAttribute
(Attribute templateAttribute) Sets the template attribute, that will be used to render the template page.
-
Method Details
-
getTemplateAttribute
Attribute getTemplateAttribute()Returns the attribute that will be used to render a template.- Returns:
- The template attribute.
- Since:
- 2.1.2
-
setTemplateAttribute
Sets the template attribute, that will be used to render the template page.- Parameters:
templateAttribute
- The template attribute.- Since:
- 2.1.2
-
getPreparer
String getPreparer()Get associated preparer instance.- Returns:
- The preparer name.
- Since:
- 2.1.0
-
setPreparer
Set associated preparer instance.- Parameters:
url
- The preparer name.- Since:
- 2.1.0
-
addAll
Add all attributes to the context.- Parameters:
newAttributes
- the attributes to be added.
-
addMissing
Add all attributes to the context.- Parameters:
defaultAttributes
- attributes which should be present.
-
inheritCascadedAttributes
Copies the cascaded attributes to this attribute context.- Parameters:
parent
- The parent context to be used.- Since:
- 2.1.0
-
inherit
Copies all missing attributes from theparent
attribute context to this one.- Parameters:
parent
- The attribute context to copy attributes from.- Since:
- 2.1.0
-
getAttribute
Retrieve the named attribute, either cascaded or not.- Parameters:
name
- key name for the attribute.- Returns:
- Attribute associated with the given name.
-
getLocalAttribute
Retrieve the attribute that has been defined in this context (i.e. not cascaded).- Parameters:
name
- key name for the attribute.- Returns:
- Attribute The local attribute associated with the given name, if
present, or
null
otherwise. - Since:
- 2.1.0
-
getCascadedAttribute
Retrieve the attribute that has been cascaded at upper levels.- Parameters:
name
- key name for the attribute.- Returns:
- Attribute The cascaded attribute associated with the given name,
if present, or
null
otherwise. - Since:
- 2.1.0
-
getLocalAttributeNames
Returns the names of the local attributes, i.e. the one that have not been cascaded.- Returns:
- The local attribute names.
- Since:
- 2.1.0
-
getCascadedAttributeNames
Returns the names of the cascaded attributes.- Returns:
- The cascaded attribute names.
- Since:
- 2.1.0
-
putAttribute
Add the specified attribute. The attribute value will be available only in the current context, i.e. it is like callingputAttribute(String, Attribute, boolean)
withcascade = false
.- Parameters:
name
- name of the attributevalue
- value of the attribute
-
putAttribute
Add the specified attribute.- Parameters:
name
- name of the attributevalue
- value of the attributecascade
- Iftrue
, the attribute value will be available in all nested contexts. Iffalse
, it will be available only in the current context.- Since:
- 2.1.0
-
clear
void clear()Clear the attributes.
-