|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
com.opensymphony.webwork.components
Class Bean
java.lang.Objectcom.opensymphony.webwork.components.Component
public class Bean
- extends Component
Instantiates a class that conforms to the JavaBeans specification. This tag has a body which can contain
a number of Param elements to set any mutator methods on that class.
If the id attribute is set on the BeanTag, it will place the instantiated bean into the stack's Context.
- id - the stack's context id (if supplied) that the created bean will be store under
- name* - the class name of the bean to be instantiated (must respect JavaBean specification)
Examples:
<-- in freemarker form --> [ww.bean name="com.opensymphony.webwork.example.counter.SimpleCounter" id="counter"] [ww:param name="foo" value="BAR"/] The value of foo is : [ww:property value="foo"/], when inside the bean tag.
[/ww:bean] <-- in jsp form --> <ww:bean name="com.opensymphony.webwork.example.counter.SimpleCounter" id="counter"> <ww:param name="foo" value="BAR" /> The value of foot is : <ww:property value="foo"/>, when inside the bean tag <br /> </ww:bean>
This example instantiates a bean called SimpleCounter and sets the foo property (setFoo('BAR')). The SimpleCounter object is then pushed onto the Valuestack, which means that we can called its accessor methods (getFoo()) with the Property tag and get their values.
In the above example, the id has been set to a value of counter. This means that the SimpleCounter class will be placed into the stack's context. You can access the SimpleCounter class using WW's tag:
<-- jsp form --> <ww:property value="#counter" /> <-- freemarker form --> [ww:property value="#counter.foo"/]
In the property tag example, the # tells Ognl to search the context for the SimpleCounter class which has an id(key) of counter
- Since:
- 2.2
- Version:
- $Revision: 2468 $
- Author:
- $author$, Rick Salsa (rsal@mb.sympatico.ca), Brock Bulger, Rene Gielen
- See Also:
Param
| Field Summary | |
|---|---|
protected Object |
bean
|
protected static org.apache.commons.logging.Log |
log
|
protected String |
name
|
| Fields inherited from class com.opensymphony.webwork.components.Component |
|---|
COMPONENT_STACK, id, parameters, stack |
| Constructor Summary | |
|---|---|
Bean(OgnlValueStack stack)
|
|
| Method Summary | |
|---|---|
void |
addParameter(String key,
Object value)
Add's the given key and value to this components own parameter. |
boolean |
end(Writer writer,
String body)
Callback for the end tag of this component. |
void |
setName(String name)
the class name of the bean to be instantiated (must respect JavaBean specification) |
boolean |
start(Writer writer)
Callback for the start tag of this component. |
| Methods inherited from class com.opensymphony.webwork.components.Component |
|---|
addAllParameters, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, toString, usesBody |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
log
protected static org.apache.commons.logging.Log log
bean
protected Object bean
name
protected String name
| Constructor Detail |
|---|
Bean
public Bean(OgnlValueStack stack)
| Method Detail |
|---|
start
public boolean start(Writer writer)
- Description copied from class:
Component - Callback for the start tag of this component.
Should the body be evaluated?
- Parameters:
writer- the output writer.- Returns:
- true if the body should be evaluated
end
public boolean end(Writer writer, String body)
- Description copied from class:
Component - Callback for the end tag of this component.
Should the body be evaluated again?
NOTE: will pop component stack.
- Parameters:
writer- the output writer.body- the rendered body.- Returns:
- true if the body should be evaluated again
addParameter
public void addParameter(String key, Object value)
- Description copied from class:
Component - Add's the given key and value to this components own parameter.
If the provided key is null nothing happends.
If the provided value is null any existing parameter with
the given key name is removed.
- Overrides:
addParameterin classComponent
- Parameters:
key- the key of the new parameter to add.value- the value assoicated with the key.
setName
public void setName(String name)
- the class name of the bean to be instantiated (must respect JavaBean specification)
|
WebWork Project Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||