|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tiles.BasicAttributeContext
org.apache.tiles.Definition
public class Definition
A definition, i.e. a template with (completely or not) filled attributes.
Attributes of a template can be defined with the help of this class.
It can be used as a data transfer object used for registering new
definitions with the Container.
Field Summary | |
---|---|
protected java.lang.String |
inherit
Extends attribute value. |
protected java.lang.String |
name
Definition name. |
Fields inherited from class org.apache.tiles.BasicAttributeContext |
---|
attributes, cascadedAttributes, preparer, templateAttribute |
Constructor Summary | |
---|---|
Definition()
Constructor. |
|
Definition(Definition definition)
Copy Constructor. |
|
Definition(java.lang.String name,
Attribute templateAttribute,
java.util.Map<java.lang.String,Attribute> attributes)
Constructor. |
|
Definition(java.lang.String name,
java.lang.String template,
java.util.Map<java.lang.String,Attribute> attributes)
Deprecated. Use Definition(String, Attribute, Map) . |
Method Summary | |
---|---|
void |
addAttribute(Attribute attribute)
Deprecated. Use BasicAttributeContext.putAttribute(String, Attribute) . |
boolean |
equals(java.lang.Object obj)
|
java.util.Map<java.lang.String,Attribute> |
getAttributes()
Deprecated. Use AttributeContext.getLocalAttributeNames() and
AttributeContext.getCascadedAttributeNames() . |
java.lang.String |
getExtends()
Get extends. |
java.lang.String |
getName()
Access method for the name property. |
java.lang.String |
getRole()
Deprecated. Use BasicAttributeContext.getTemplateAttribute() . |
java.lang.String |
getTemplate()
Deprecated. Use BasicAttributeContext.getTemplateAttribute() . |
boolean |
hasAttributeValue(java.lang.String key)
Deprecated. Check if the AttributeContext.getAttribute(String)
returns null. |
int |
hashCode()
|
boolean |
isExtending()
Get extends flag. |
void |
put(java.lang.String name,
java.lang.Object content)
Deprecated. Use AttributeContext.putAttribute(String, Attribute)
or AttributeContext.putAttribute(String, Attribute, boolean) . |
void |
put(java.lang.String name,
java.lang.Object content,
Attribute.AttributeType type,
java.lang.String role)
Deprecated. Use AttributeContext.putAttribute(String, Attribute)
or AttributeContext.putAttribute(String, Attribute, boolean) . |
void |
put(java.lang.String name,
java.lang.Object content,
java.lang.String role)
Deprecated. Use AttributeContext.putAttribute(String, Attribute)
or AttributeContext.putAttribute(String, Attribute, boolean) . |
void |
setExtends(java.lang.String name)
Set extends. |
void |
setName(java.lang.String aName)
Sets the value of the name property. |
void |
setRole(java.lang.String role)
Deprecated. Use BasicAttributeContext.getTemplateAttribute() . |
void |
setTemplate(java.lang.String template)
Deprecated. Use BasicAttributeContext.getTemplateAttribute() . |
java.lang.String |
toString()
Returns a description of the attributes. |
Methods inherited from class org.apache.tiles.BasicAttributeContext |
---|
addAll, addMissing, clear, getAttribute, getAttributeNames, getCascadedAttribute, getCascadedAttributeNames, getLocalAttribute, getLocalAttributeNames, getPreparer, getTemplateAttribute, inherit, inherit, inheritCascadedAttributes, putAttribute, putAttribute, setPreparer, setTemplateAttribute |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String inherit
protected java.lang.String name
Constructor Detail |
---|
public Definition()
public Definition(Definition definition)
definition
- The definition to copy.public Definition(java.lang.String name, java.lang.String template, java.util.Map<java.lang.String,Attribute> attributes)
Definition(String, Attribute, Map)
.
name
- The name of the definition.template
- The template of the definition.attributes
- The attribute map of the definition.public Definition(java.lang.String name, Attribute templateAttribute, java.util.Map<java.lang.String,Attribute> attributes)
name
- The name of the definition.templateAttribute
- The template attribute of the definition.attributes
- The attribute map of the definition.Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String aName)
aName
- the new value of the name property@Deprecated public java.lang.String getTemplate()
BasicAttributeContext.getTemplateAttribute()
.
@Deprecated public void setTemplate(java.lang.String template)
BasicAttributeContext.getTemplateAttribute()
.
template
- the new value of the path property@Deprecated public java.lang.String getRole()
BasicAttributeContext.getTemplateAttribute()
.
@Deprecated public void setRole(java.lang.String role)
BasicAttributeContext.getTemplateAttribute()
.
role
- the new value of the role property@Deprecated public java.util.Map<java.lang.String,Attribute> getAttributes()
AttributeContext.getLocalAttributeNames()
and
AttributeContext.getCascadedAttributeNames()
.
@Deprecated public void addAttribute(Attribute attribute)
BasicAttributeContext.putAttribute(String, Attribute)
.
attribute
- Attribute to add.@Deprecated public boolean hasAttributeValue(java.lang.String key)
AttributeContext.getAttribute(String)
returns null.
key
attribute has been set.
key
- The attribute key to check.
true
if the attribute has a value.@Deprecated public void put(java.lang.String name, java.lang.Object content)
AttributeContext.putAttribute(String, Attribute)
or AttributeContext.putAttribute(String, Attribute, boolean)
.
name
- Attribute namecontent
- Attribute value@Deprecated public void put(java.lang.String name, java.lang.Object content, java.lang.String role)
AttributeContext.putAttribute(String, Attribute)
or AttributeContext.putAttribute(String, Attribute, boolean)
.
name
- Attribute namecontent
- Attribute valuerole
- Determine if content is used by get tag. If user is in role, content is used.@Deprecated public void put(java.lang.String name, java.lang.Object content, Attribute.AttributeType type, java.lang.String role)
AttributeContext.putAttribute(String, Attribute)
or AttributeContext.putAttribute(String, Attribute, boolean)
.
name
- Attribute namecontent
- Attribute valuetype
- attribute type: template, string, definitionrole
- Determine if content is used by get tag. If user is in role, content is used.public void setExtends(java.lang.String name)
name
- Name of the extended definition.public java.lang.String getExtends()
public boolean equals(java.lang.Object obj)
equals
in class BasicAttributeContext
public int hashCode()
hashCode
in class BasicAttributeContext
public boolean isExtending()
true
if this definition extends another.public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |