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:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
- public class PropertyTag
- extends javax.servlet.jsp.tagext.TagSupport
bpe:details
DetailsTag
tag. A bpe:property
tag must be enclosed within
a bpe:details
tag. If the model used provides meta data, the label and converter information is
retrieved from the model, unless it is explicitly set on the tag.
Table of tag attributes:
Tag attribute | Mandatory? | Description |
---|---|---|
converterID | false | The ID used to register the converter in the JavaServer Faces (JSF) configuration file. |
label | false | The label for the property. If this attribute is not set, a default label is provided by the client model class. |
name | true | The name of the property to be displayed. This name must correspond to a named property as defined in the corresponding client model class. |
rendered | false | The render information. |
escapeValue | false | The escape information for the property value field. |
notRenderedIfNoValue | false | Determines whether the property is rendered if the property value is null. If this attribute is not set the property is rendered. If the rendered attribute is specified this attribute is ignored. |
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:property name="documentation" converterID="HtmlOutputTextConverter" escapeValue="false" /> </bpe:details>
See Also:
Field Summary
Modifier and Type | Field and Description |
---|---|
|
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 |
Constructor Summary
Constructor and Description |
---|
PropertyTag()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
doStartTag()
|
|
getConverterID()
Returns the explicitly set converter ID.
|
|
getEscapeValue()
|
|
getLabel()
Returns the explicitly set label of the column header.
|
|
getName()
Returns the name of the property that is displayed in the column.
|
|
getNotRenderedIfNoValue()
|
|
getRendered()
Returns the render information.
|
|
release()
|
|
setConverterID(java.lang.String converterID)
Sets the converter ID for the column.
|
|
setEscapeValue(java.lang.String escapeValue)
|
|
setLabel(java.lang.String label)
Sets the label of the column header.
|
|
setName(java.lang.String name)
Sets the name of the property that is displayed in the column.
|
|
setNotRenderedIfNoValue(java.lang.String notRenderedIfNoValue)
|
|
setRendered(java.lang.String rendered)
Sets the render information for the property.
|
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 |
Field Detail
COPYRIGHT
- public static final java.lang.String COPYRIGHT
See Also:
Constructor Detail
PropertyTag
- public PropertyTag()
Method Detail
getName
- public java.lang.String getName( )
Returns the name of the property that is displayed in the column. According to the Java Bean Convention,
the name must match a property name of the
model bean associated with the details panel.
Returns:
The property name
setName
- public void setName(java.lang.String name)
Sets the name of the property that is displayed in the column. According to the Java Bean Convention,
the name must match a property name of the
model bean associated with the details panel.
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
uses the label specified in the metadata of the model bean associated with the surrounding details panel.
Returns:
The label, 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 is looked up in the metadata
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
uses the converter ID specified in the metadata of the model bean associated with the surrounding details panel.
Returns:
The converter ID, or null
setConverterID
- public void setConverterID(java.lang.String converterID)
Sets the converter ID for the column. The ID must 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 getRendered
- public java.lang.String getRendered( )
Returns the render information.
Returns:
The render information
setRendered
- public void setRendered(java.lang.String rendered)
Sets the render information for the property. The called method must return true or false.
Parameters:
rendered
- The render information getEscapeValue
- public java.lang.String getEscapeValue( )
setEscapeValue
- public void setEscapeValue(java.lang.String escapeValue)
getNotRenderedIfNoValue
- public java.lang.String getNotRenderedIfNoValue( )
setNotRenderedIfNoValue
- public void setNotRenderedIfNoValue( java.lang.String notRenderedIfNoValue)
doStartTag
- public int doStartTag()
- throws javax.servlet.jsp.JspException
Specified by:
doStartTag
in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag
in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException
release
- public void release()
Specified by:
release
in interface javax.servlet.jsp.tagext.Tag
Overrides:
release
in class javax.servlet.jsp.tagext.TagSupport