org.apache.struts.tiles
public class ComponentDefinition extends Object implements Serializable
Field Summary | |
---|---|
static String | ACTION
Controller name type. |
protected Map | attributes
Attributes defined for the component. |
protected String | controller Associated Controller URL or classname, if defined |
Controller | controllerInstance
Controller associated to Definition.
|
protected String | controllerType
Associated Controller typename, if controllerName defined.
|
static String | CONTROLLER
Controller name type. |
protected static Log | log
Commons Logging instance. |
protected String | name
Definition name |
protected String | path
Component / template path (URL). |
protected String | role
Role associated to definition. |
static String | URL
Controller name type. |
Constructor Summary | |
---|---|
ComponentDefinition()
Constructor. | |
ComponentDefinition(ComponentDefinition definition)
Copy Constructor.
| |
ComponentDefinition(XmlDefinition definition)
Constructor.
| |
ComponentDefinition(String name, String path, Map attributes)
Constructor. |
Method Summary | |
---|---|
static Controller | createController(String name, String controllerType)
Create a new instance of controller named in parameter.
|
static Controller | createControllerFromClassname(String classname)
Create a controller from specified classname |
Object | getAttribute(String key)
Returns the value of the named attribute as an Object, or null if no
attribute of the given name exists.
|
Map | getAttributes()
Access method for the attributes property.
|
String | getController()
Get associated controller local URL.
|
Controller | getControllerInstance()
Get controller instance. |
String | getControllerType()
Get associated controller type.
|
String | getName()
Access method for the name property.
|
Controller | getOrCreateController()
Get or create controller.
|
String | getPage()
Access method for the path property.
|
String | getPath()
Access method for the path property.
|
String | getRole()
Access method for the role property. |
String | getTemplate()
Access method for the template property.
|
void | put(String name, Object content)
Put an attribute in component / template definition.
|
void | put(String name, Object content, boolean direct)
Put an attribute in template definition.
|
void | put(String name, Object content, boolean direct, String role)
Put an attribute in template definition.
|
void | put(String name, Object content, String type, String role)
Put an attribute in template definition.
|
void | putAttribute(String key, Object value)
Put a new attribute in this component
|
void | setController(String url)
Set associated controller URL.
|
void | setControllerClass(String controller)
Set associated controller name as a classtype, and controller
type as "classname".
|
void | setControllerInstance(Controller controller)
Set controller. |
void | setControllerType(String controllerType)
Set associated controller type.
|
void | setControllerUrl(String controller)
Set associated controller name as an url, and controller
type as "url".
|
void | setName(String aName)
Sets the value of the name property.
|
void | setPage(String page)
Sets the value of the path property.
|
void | setPath(String aPath)
Sets the value of the path property.
|
void | setRole(String role)
Sets the value of the role property.
|
void | setTemplate(String template)
Sets the value of the template property.
|
String | toString()
Returns a description of the attributes. |
Throws: InstantiationException if an error occur while instanciating Controller : (classname can't be instanciated, Illegal access with instanciated class, Error while instanciating class, classname can't be instanciated.
Parameters: name Controller name (classname, url, ...) controllerType Expected Controller type
Returns: org.apache.struts.tiles.Controller
Throws: InstantiationException if an error occur while instanciating Controller : (classname can't be instanciated, Illegal access with instanciated class, Error while instanciating class, classname can't be instanciated.
Parameters: classname Controller classname.
Returns: org.apache.struts.tiles.Controller
Throws: InstantiationException if an error occur while instanciating Controller : (classname can't be instanciated, Illegal access with instanciated class, Error while instanciating class, classname can't be instanciated.
Returns: requested attribute or null if not found
Returns: the current value of the attributes property
Returns: controller instance.
Returns: the current value of the name property
Returns: controller if controller or controllerType is set, null otherwise.
Throws: InstantiationException if an error occur while instanciating Controller : (classname can't be instanciated, Illegal access with instanciated class, Error while instanciating class, classname can't be instanciated.
Returns: The current value of the path property.
Returns: the current value of the path property
Returns: the current value of the role property
Returns: the current value of the template property
Parameters: name Attribute name content Attribute value
Parameters: name Attribute name content Attribute value o?= direct Determines how content is handled by get tag: true means content is printed directly; false, the default, means content is included
Parameters: name Attribute name content Attribute value direct Determines how content is handled by get tag: true means content is printed directly; false, the default, means content is included role Determine if content is used by get tag. If user is in role, content is used.
Parameters: name Attribute name content Attribute value type attribute type: template, string, definition role Determine if content is used by get tag. If user is in role, content is used.
Parameters: key String key for attribute value Attibute value.
Parameters: url Url called locally
Parameters: controller Controller classname.
Parameters: controllerType Typeof associated controller
Parameters: controller Controller url
Parameters: aName the new value of the name property
Parameters: page the new value of the path property
Parameters: aPath the new value of the path property
Parameters: role the new value of the path property
Parameters: template the new value of the path property