org.apache.tiles
Interface AttributeContext

Package class diagram package AttributeContext
All Known Implementing Classes:
BasicAttributeContext, BasicAttributeContext, Definition

public interface AttributeContext

Encapsulation of the current state of execution.

Since:
Tiles 2.0

Method Summary
 void addAll(java.util.Map<java.lang.String,Attribute> newAttributes)
          Add all attributes to the context.
 void addMissing(java.util.Map<java.lang.String,Attribute> defaultAttributes)
          Add all attributes to the context.
 void clear()
          Clear the attributes.
 Attribute getAttribute(java.lang.String name)
          Retrieve the named attribute, either cascaded or not.
 java.util.Iterator<java.lang.String> getAttributeNames()
          Deprecated. Use getLocalAttributeNames() or getCascadedAttributeNames().
 Attribute getCascadedAttribute(java.lang.String name)
          Retrieve the attribute that has been cascaded at upper levels.
 java.util.Set<java.lang.String> getCascadedAttributeNames()
          Returns the names of the cascaded attributes.
 Attribute getLocalAttribute(java.lang.String name)
          Retrieve the attribute that has been defined in this context (i.e. not cascaded).
 java.util.Set<java.lang.String> getLocalAttributeNames()
          Returns the names of the local attributes, i.e. the one that have not been cascaded.
 java.lang.String getPreparer()
          Get associated preparer instance.
 java.lang.String getRole()
          Access method for the role property.
 java.util.Set<java.lang.String> getRoles()
          Returns the roles that can render this attribute.
 java.lang.String getTemplate()
          Access method for the template property.
 void inherit(AttributeContext parent)
          Copies all missing attributes from the parent attribute context to this one.
 void inheritCascadedAttributes(AttributeContext parent)
          Copies the cascaded attributes to this attribute context.
 void putAttribute(java.lang.String name, Attribute value)
          Add the specified attribute.
 void putAttribute(java.lang.String name, Attribute value, boolean cascade)
          Add the specified attribute.
 void setPreparer(java.lang.String url)
          Set associated preparer instance.
 void setRole(java.lang.String role)
          Sets the value of the role property.
 void setRoles(java.util.Set<java.lang.String> roles)
          Sets the roles that can render this attribute.
 void setTemplate(java.lang.String template)
          Sets the value of the template property.
 

Method Detail

getTemplate

java.lang.String getTemplate()
Access method for the template property.

Returns:
the current value of the template property
Since:
2.1.0

setTemplate

void setTemplate(java.lang.String template)
Sets the value of the template property.

Parameters:
template - the new value of the path property
Since:
2.1.0

getRole

java.lang.String getRole()
Access method for the role property.

Returns:
the current value of the role property
Since:
2.1.0

getRoles

java.util.Set<java.lang.String> getRoles()
Returns the roles that can render this attribute.

Returns:
The enabled roles.
Since:
2.1.0

setRole

void setRole(java.lang.String role)
Sets the value of the role property.

Parameters:
role - the new value of the role property
Since:
2.1.0

setRoles

void setRoles(java.util.Set<java.lang.String> roles)
Sets the roles that can render this attribute.

Parameters:
roles - The enabled roles.
Since:
2.1.0

getPreparer

java.lang.String getPreparer()
Get associated preparer instance.

Returns:
The preparer name.
Since:
2.1.0

setPreparer

void setPreparer(java.lang.String url)
Set associated preparer instance.

Parameters:
url - The preparer name.
Since:
2.1.0

addAll

void addAll(java.util.Map<java.lang.String,Attribute> newAttributes)
Add all attributes to the context.

Parameters:
newAttributes - the attributes to be added.

addMissing

void addMissing(java.util.Map<java.lang.String,Attribute> defaultAttributes)
Add all attributes to the context.

Parameters:
defaultAttributes - attributes which should be present.

inheritCascadedAttributes

void inheritCascadedAttributes(AttributeContext parent)
Copies the cascaded attributes to this attribute context.

Parameters:
parent - The parent context to be used.
Since:
2.1.0

inherit

void inherit(AttributeContext parent)
Copies all missing attributes from the parent attribute context to this one.

Parameters:
parent - The attribute context to copy attributes from.
Since:
2.1.0

getAttribute

Attribute getAttribute(java.lang.String name)
Retrieve the named attribute, either cascaded or not.

Parameters:
name - key name for the attribute.
Returns:
Attribute associated with the given name.

getLocalAttribute

Attribute getLocalAttribute(java.lang.String name)
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

Attribute getCascadedAttribute(java.lang.String name)
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

getAttributeNames

@Deprecated
java.util.Iterator<java.lang.String> getAttributeNames()
Deprecated. Use getLocalAttributeNames() or getCascadedAttributeNames().

Iterator of all attribute names.

Returns:
iterator of all names.

getLocalAttributeNames

java.util.Set<java.lang.String> 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

java.util.Set<java.lang.String> getCascadedAttributeNames()
Returns the names of the cascaded attributes.

Returns:
The cascaded attribute names.
Since:
2.1.0

putAttribute

void putAttribute(java.lang.String name,
                  Attribute value)
Add the specified attribute. The attribute value will be available only in the current context, i.e. it is like calling putAttribute(String, Attribute, boolean) with cascade = false.

Parameters:
name - name of the attribute
value - value of the attribute

putAttribute

void putAttribute(java.lang.String name,
                  Attribute value,
                  boolean cascade)
Add the specified attribute.

Parameters:
name - name of the attribute
value - value of the attribute
cascade - If true, the attribute value will be available in all nested contexts. If false, it will be available only in the current context.
Since:
2.1.0

clear

void clear()
Clear the attributes.