MessageFormatTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.deltava.taglib.format.MessageFormatTag

All Implemented Interfaces:: Serializable, IterationTag, JspTag, Tag

public class MessageFormatTag extends TagSupport

A JSP tag to support writing formatted text with URLs and emoticons.

Since:

1.0

Version:

11.1

Author:

Luke

See Also:

Field Summary

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

Constructors

Constructor

Description

MessageFormatTag()
Method Summary

Modifier and Type

Method

Description

int

doEndTag()

Renders the formatted message text to the JSP output stream.

int

doStartTag()

Checks for the inclusion of common.js in the request.

void

release()

void

setBbCode(boolean useBBCode)

Sets whether BBCodes are to be translated.

void

setValue(String msg)

Updates the text to format.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, 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

Constructor Details
- MessageFormatTag
  
  public MessageFormatTag()
Method Details
- setBbCode
  
  public void setBbCode(boolean useBBCode)
  
  Sets whether BBCodes are to be translated.
  
  Parameters:
  
  useBBCode - TRUE to translate, otherwise FALSE
- setValue
  
  public void setValue(String msg)
  
  Updates the text to format.
  
  Parameters:
  
  msg - the text to format
- doStartTag
  
  public int doStartTag() throws JspException
  
  Checks for the inclusion of common.js in the request.
  
  Specified by:
  
  doStartTag in interface Tag
  
  Overrides:
  
  doStartTag in class TagSupport
  
  Returns:
  
  TagSupport.SKIP_BODY
  
  Throws:
  
  JspException - if common.js is not included
- release
  
  public void release()
  
  Specified by:
  
  release in interface Tag
  
  Overrides:
  
  release in class TagSupport
- doEndTag
  
  public int doEndTag() throws JspException
  
  Renders the formatted message text to the JSP output stream.
  
  Specified by:
  
  doEndTag in interface Tag
  
  Overrides:
  
  doEndTag in class TagSupport
  
  Returns:
  
  the formatted text
  
  Throws:
  
  JspException - if an error occurs