org.apache.struts.tiles.xmlDefinition
Class XmlDefinition

java.lang.Object
  |
  +--org.apache.struts.tiles.ComponentDefinition
        |
        +--org.apache.struts.tiles.xmlDefinition.XmlDefinition
All Implemented Interfaces:
java.io.Serializable

public class XmlDefinition
extends ComponentDefinition

A definition red from an XML definitions file.

See Also:
Serialized Form

Field Summary
private  java.lang.String inherit
          Extends attribute value.
private  boolean isVisited
          Use for resolving inheritance.
protected static org.apache.commons.logging.Log log
          Commons Logging instance.
 
Fields inherited from class org.apache.struts.tiles.ComponentDefinition
ACTION, attributes, controller, CONTROLLER, controllerType, name, path, role, URL
 
Constructor Summary
XmlDefinition()
          Constructor.
 
Method Summary
 void addAttribute(XmlAttribute attribute)
          add an attribute to this component
 java.lang.String getExtends()
          Access method for the path property.
 boolean isExtending()
          Get the value of the extendproperty.
 void overload(XmlDefinition child)
          Overload this definition with passed child.
 void resolveInheritance(XmlDefinitionsSet definitionsSet)
          Resolve inheritance.
 void setExtends(java.lang.String name)
          Sets the value of the extend and path property.
 void setIsVisited(boolean isVisited)
          Get the value of the extendproperty.
 
Methods inherited from class org.apache.struts.tiles.ComponentDefinition
createController, createControllerFromClassname, getAttribute, getAttributes, getController, getControllerInstance, getControllerType, getName, getOrCreateController, getPage, getPath, getRole, getTemplate, put, put, put, put, putAttribute, setController, setControllerClass, setControllerInstance, setControllerType, setControllerUrl, setName, setPage, setPath, setRole, setTemplate, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

inherit

private java.lang.String inherit
Extends attribute value.


log

protected static org.apache.commons.logging.Log log
Commons Logging instance.


isVisited

private boolean isVisited
Use for resolving inheritance.

Constructor Detail

XmlDefinition

public XmlDefinition()
Constructor.

Method Detail

addAttribute

public void addAttribute(XmlAttribute attribute)
add an attribute to this component

Parameters:
attribute - Attribute to add.

setExtends

public void setExtends(java.lang.String name)
Sets the value of the extend and path property.


getExtends

public java.lang.String getExtends()
Access method for the path property.

Returns:
the current value of the path property

isExtending

public boolean isExtending()
Get the value of the extendproperty.


setIsVisited

public void setIsVisited(boolean isVisited)
Get the value of the extendproperty.


resolveInheritance

public void resolveInheritance(XmlDefinitionsSet definitionsSet)
                        throws NoSuchDefinitionException
Resolve inheritance. First, resolve parent's inheritance, then set path to the parent's path. Also copy attributes setted in parent, and not set in child If instance doesn't extends something, do nothing.

Throws:
NoSuchDefinitionException - If a inheritance can be solved.

overload

public void overload(XmlDefinition child)
Overload this definition with passed child. All attributes from child are copied to this definition. Previous attribute with same name are disguarded. Special attribute 'path','role' and 'extends' are overloaded if defined in child.

Parameters:
child - Child used to overload this definition.


Copyright 2000-2002 - Cedric Dumoulin and Apache Software Foundation