com.atlassian.confluence.tinymceplugin.service

Interface CommentRenderService

All Known Implementing Classes:

CommentRenderServiceImpl

public interface CommentRenderService

Method Summary

Modifier and Type	Method and Description
CommentResult	render(Comment comment, boolean actions, javax.servlet.http.HttpServletRequest req)
CommentResult	render(Comment comment, boolean actions, javax.servlet.http.HttpServletRequest req, int maxLength, boolean plainTextOnly) Create the JSON representation of a Comment

Method Detail

render

CommentResult render(Comment comment,
                     boolean actions,
                     javax.servlet.http.HttpServletRequest req)
              throws XMLStreamException,
                     XhtmlException

Throws:

XMLStreamException

XhtmlException

render

CommentResult render(Comment comment,
                     boolean actions,
                     javax.servlet.http.HttpServletRequest req,
                     int maxLength,
                     boolean plainTextOnly)
              throws XMLStreamException,
                     XhtmlException

Create the JSON representation of a Comment

Parameters:

comment - the comment to be rendered

actions - determine whether the returned object includes the action information

req -

maxLength - the maximum length of the rendered comment's content

plainTextOnly - the content will be rendered as plain text if this flag is true

Returns:

the transfer object (to be serialized to JSON)

Throws:

XMLStreamException

XhtmlException