com.ibm.bpe.jsf.component.taglib
Class PropertyTag
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
com.ibm.bpe.jsf.component.taglib.PropertyTag
- All Implemented Interfaces:
- javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag
- public class PropertyTag
- extends javax.servlet.jsp.tagext.TagSupport
This class is used to configure a property shown by the Details Component.
The details panel itself is specified by the bpe:details DetailsTag
tag. A bpe:property tag must be surrounded by
a bpe:details tag. If the used model provides meta information, the label and converter information will
be retrieved from the model unless they are explicitly set on the tag.
Table of tag attributes:
tag attribute | description | mandatory |
name |
The name of the property that is shown. |
true |
label |
A literal or a Value Binding Expression that used as label. If not specified, any label provided by the
model for this property is used.
|
false |
converterID |
The Faces Converter Id used for converting the property value.
If not specified, any Faces Converter Id provided by the model for this property is used.
|
false |
Example:
<bpe:details model="#{TaskInstanceDetails}" styleClass="details"
columnClasses="detailsProperty,detailsValue">
<bpe:property name="ID" />
<bpe:property name="kind" />
<bpe:property name="state" converterID="my.task.state.converter" />
<bpe:property name="escalated" /&g;
<bpe:property name="suspended" />
<bpe:property name="owner" label="Working on the task:" />
<bpe:property name="originator" />
<bpe:property name="activationTime" />
<bpe:property name="firstActivationTime" />
<bpe:property name="completionTime" />
<bpe:property name="lastModificationTime" />
<bpe:property name="lastStateChangeTime" />
<bpe:property name="expirationTime" />
</bpe:details>
- See Also:
- Serialized Form
Field Summary |
static java.lang.String |
COPYRIGHT
|
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
id, pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Method Summary |
int |
doStartTag()
|
java.lang.String |
getConverterID()
Returns the explicitly set converter id. |
java.lang.String |
getLabel()
Returns the explicitly set label of the column header. |
java.lang.String |
getName()
Returns the name of the property that is display in the column. |
void |
release()
|
void |
setConverterID(java.lang.String converterID)
Sets the converterId for the column. |
void |
setLabel(java.lang.String label)
Sets the label of the column header. |
void |
setName(java.lang.String name)
Sets the name of the property that is display in the column. |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- See Also:
- Constant Field Values
PropertyTag
public PropertyTag()
getName
public java.lang.String getName()
- Returns the name of the property that is display in the column. The name is equal to a property name of the
model bean associated with the details panel according to the Java Bean Convention.
- Returns:
- The property name
setName
public void setName(java.lang.String name)
- Sets the name of the property that is display in the column. The name should be a property name of the
model bean associated with the details panel according to the Java Bean Convention.
- Parameters:
name
- The property name
getLabel
public java.lang.String getLabel()
- Returns the explicitly set label of the column header. If no label has been explicitly set on the tag, the component
will use the label specified in the meta information of the model bean associated with the surrounding details panel.
- Returns:
- The label or a Value Binding Expression or null
setLabel
public void setLabel(java.lang.String label)
- Sets the label of the column header. If this tag property is not set, the label will be looked up in the meta information
of the model bean associated with the details panel.
- Parameters:
label
- The lable or a Value Binding Expression
getConverterID
public java.lang.String getConverterID()
- Returns the explicitly set converter id. If no converter id has been explicitly set on the tag, the component
will use the converter id that is specified in the meta information of the model bean associated with the surrouding details panel.
- Returns:
- The converter ID or null
setConverterID
public void setConverterID(java.lang.String converterID)
- Sets the converterId for the column. The id should match the id of a converter that is registered in the Faces Application.
If no converter is explicitly specified, the converter id specified on the model associated with the surronding details panel is used.
- Parameters:
converterID
- The converter ID
doStartTag
public int doStartTag()
throws javax.servlet.jsp.JspException
- Throws:
javax.servlet.jsp.JspException
release
public void release()