GetPropertyTag Class

DEPRECATED

com.bea.p13n.content.servlets.jsp.taglib
GetPropertyTag Class

public class GetPropertyTag

    extends com.bea.p13n.content.servlets.jsp.taglib.BaseTag

Tag to retrieve or print a property of a ConfigurableEntity.

Hierarchy
Object
  TagSupport
    com.bea.p13n.content.servlets.jsp.taglib.BaseTag
      GetPropertyTag
All Implemented Interfaces

IterationTag, Serializable, Tag
Direct Known Subclasses

com.bea.p13n.content.servlets.jsp.taglib.PrintPropertyTag

Field Summary
protected String
dateFormat
The date format to use.
protected String
defValue
The default value to print if the property is not found.
protected String
encodeType
The encode type.
protected com.bea.p13n.property.ConfigurableEntity
entity
The document to use.
protected int
maxLength
The max length to print.
protected String
name
The name of the property to print.
protected String
numFormat
The number format to use.
protected String
resultId
The id of the script variable to put the result into.
protected String
resultType
The type of the property.
protected String
scope
The property set name of the property to print.
   
Fields from  com.bea.p13n.content.servlets.jsp.taglib.com.bea.p13n.content.servlets.jsp.taglib.BaseTag
cacheId, cacheScope, cacheTimeout, failOnError, readOnly, useCache
 
Fields from  javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 

Constructor Summary
GetPropertyTag()
 

Method Summary
public int
doStartTag()
Start the tag.
public String
encode(String in)
Encode a string with the current encodeType.
public static String
encode(String encodeType, String in)
Encode a string according to the specified encodeType.
public String
getDateFormat()
Get the date format to use.
public String
getDefault()
Get the default value.
public String
getEncode()
Get the value of GetPropertyTag.encodeType.
public String
getMaxLength()
Get the value of GetPropertyTag.maxLength as a String.
public String
getName()
Get the value of GetPropertyTag.name.
public String
getNumFormat()
Get the number format to use.
public String
getResultId()
Get the GetPropertyTag.resultId.
public String
getResultType()
Get the GetPropertyTag.resultType.
public String
getScope()
Get the value of GetPropertyTag.scope.
public void
release()
Release the tag.
public void
setDateFormat(String s)
Set the date format to use.
public void
setDefault(String v)
Set the default value.
public void
setEncode(String v)
Set the value of GetPropertyTag.encodeType.
public void
setEntity(ConfigurableEntity entity)
Set the GetPropertyTag.entity to use.
public void
setMaxLength(String v)
Set the value of GetPropertyTag.maxLength.
public void
setMaxLength(int length)
Set the value of GetPropertyTag.maxLength.
public void
setName(String v)
Set the value of GetPropertyTag.name.
public void
setNumFormat(String s)
Set the number format to use.
public void
setResultId(String resultId)
Set the GetPropertyTag.resultId.
public void
setResultType(String resultType)
Set the GetPropertyTag.resultType.
public void
setScope(String v)
Set the value of GetPropertyTag.scope.
public String
toString(Object obj)
Convert an object property value to a string with our current formatting.
public String
toString(Date d)
Convert a date to our date format.
public String
toString(Number n)
Convert a number to our date format.
 
Methods from  com.bea.p13n.content.servlets.jsp.taglib.com.bea.p13n.content.servlets.jsp.taglib.BaseTag
getCacheId, getCacheScope, getCacheTimeout, getFailOnError, getHttpSession, getReadOnly, getUseCache, getUserId, setCacheId, setCacheScope, setCacheTimeout, setCacheTimeout, setFailOnError, setFailOnError, setReadOnly, setReadOnly, setUseCache, setUseCache, toDictionary
 
Methods from  javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
 
Methods from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, release, setPageContext, setParent
 

Field Detail

dateFormat

protected String dateFormat
The date format to use.

defValue

protected String defValue
The default value to print if the property is not found.

encodeType

protected String encodeType
The encode type.

entity

protected com.bea.p13n.property.ConfigurableEntity entity
The document to use.

maxLength

protected int maxLength
The max length to print.

name

protected String name
The name of the property to print.

numFormat

protected String numFormat
The number format to use.

resultId

protected String resultId
The id of the script variable to put the result into.

resultType

protected String resultType
The type of the property.

scope

protected String scope
The property set name of the property to print.

 

Constructor Detail

GetPropertyTag

public GetPropertyTag()
 

Method Detail

doStartTag() Method

public int doStartTag()
     throws JspException
Start the tag.

Overrides
TagSupport.doStartTag()

Exceptions

JspException

encode(String) Method

public String encode(String in)
Encode a string with the current encodeType.

encode(String, String) Method

public static String encode(String encodeType, 
                            String in)
Encode a string according to the specified encodeType.

Parameters

encodeType
"html", "url", or anything else for no encoding.
in
the string

Returns

the encoded string.

getDateFormat() Method

public String getDateFormat()
Get the date format to use.

getDefault() Method

public String getDefault()
Get the default value.

getEncode() Method

public String getEncode()
Get the value of GetPropertyTag.encodeType.

getMaxLength() Method

public String getMaxLength()
Get the value of GetPropertyTag.maxLength as a String.

getName() Method

public String getName()
Get the value of GetPropertyTag.name.

getNumFormat() Method

public String getNumFormat()
Get the number format to use.

getResultId() Method

public String getResultId()
Get the GetPropertyTag.resultId.

getResultType() Method

public String getResultType()
Get the GetPropertyTag.resultType.

getScope() Method

public String getScope()
Get the value of GetPropertyTag.scope.

release() Method

public void release()
Release the tag.

Overrides
BaseTag.release()

setDateFormat(String) Method

public void setDateFormat(String s)
Set the date format to use.

setDefault(String) Method

public void setDefault(String v)
Set the default value.

setEncode(String) Method

public void setEncode(String v)
Set the value of GetPropertyTag.encodeType.

setEntity(ConfigurableEntity) Method

public void setEntity(ConfigurableEntity entity)
Set the GetPropertyTag.entity to use.

setMaxLength(String) Method

public void setMaxLength(String v)
Set the value of GetPropertyTag.maxLength.

setMaxLength(int) Method

public void setMaxLength(int length)
Set the value of GetPropertyTag.maxLength.

setName(String) Method

public void setName(String v)
Set the value of GetPropertyTag.name.

setNumFormat(String) Method

public void setNumFormat(String s)
Set the number format to use.

setResultId(String) Method

public void setResultId(String resultId)
Set the GetPropertyTag.resultId.

setResultType(String) Method

public void setResultType(String resultType)
Set the GetPropertyTag.resultType.

setScope(String) Method

public void setScope(String v)
Set the value of GetPropertyTag.scope.

toString(Object) Method

public String toString(Object obj)
     throws JspException
Convert an object property value to a string with our current formatting.

Exceptions

JspException
thrown on conversion failure when failOnError is true.

Related Topics

GetPropertyTag.getDefault()
GetPropertyTag.toString(Date)
GetPropertyTag.toString(Number)

toString(Date) Method

public String toString(Date d)
     throws JspException
Convert a date to our date format.

Exceptions

JspException
thrown on conversion failure when failOnError is true.

toString(Number) Method

public String toString(Number n)
     throws JspException
Convert a number to our date format.

Exceptions

JspException
thrown on conversion failure when failOnError is true.