|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.renderer.AbstractRenderFilter
com.jivesoftware.forum.renderer.impl.AbstractJiveClassicRenderFilter
com.jivesoftware.forum.renderer.filter.ImageFilter
public class ImageFilter
Format: servlet/JiveServlet/download/1-23-456-7890/test.gif
JiveServlet
Nested Class Summary | |
---|---|
static class |
ImageFilter.NntpImageResult
Simple class that contains both a parsed NNTP message, as well as a mapping between CID values (String) and the attachment that is associated with that CID ( Attachment ). |
Constructor Summary | |
---|---|
ImageFilter()
|
Method Summary | |
---|---|
static java.lang.String |
convertHtmlToMarkup(java.lang.String html)
|
static java.lang.String |
convertMarkupToHtml(ForumMessage msg,
java.lang.String markup)
|
static ImageFilter.NntpImageResult |
convertMarkupToNntp(ForumMessage msg,
java.lang.String source)
Parses a message body and returns both the NNTP-compatible body as well as a mapping between the CID values and the Attachment it is associated with. |
static java.lang.String |
convertNntpToMarkup(java.util.Map cidMap,
java.lang.String nntp)
Converts a new NNTP message to the proper markup to be stored in the DB. |
protected java.lang.String |
executeHtmlTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_HTML . |
protected java.lang.String |
executeNoMarkupTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_NO_MARKUP . |
protected java.lang.String |
executePlainEmailTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_EMAIL . |
protected java.lang.String |
executePlainTextTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_TEXT . |
protected java.lang.String |
executeWysiwygEditorTarget(java.lang.String string,
RenderContext renderContext)
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_WYSIWYG_EDITOR . |
static java.util.List |
getAttachmentsFromNntp(ForumMessage msg,
java.lang.String source)
|
protected java.lang.String[] |
getDefaultHelp()
Returns a String[section,title,body] for the default help for the filter. |
protected java.util.Map |
getDocumentationMap()
Returns a documentation Map keyed by languageCode -> String[section,title,body]. |
java.lang.String |
getName()
Returns the unique name of the filter. |
java.lang.String[] |
getTags()
Returns an array of string for the tag names a filter uses. |
protected boolean |
isEnabledByDefault()
Returns true if the filter should be enabled by default, false otherwise. |
Methods inherited from class com.jivesoftware.forum.renderer.impl.AbstractJiveClassicRenderFilter |
---|
isDisplayable, isTest, setTest |
Methods inherited from class com.jivesoftware.forum.renderer.AbstractRenderFilter |
---|
execute, getUserDocumentation, isEnabled, setEnabled |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.jivesoftware.forum.renderer.RenderFilter |
---|
execute, getUserDocumentation, isEnabled, setEnabled |
Methods inherited from interface com.jivesoftware.forum.renderer.impl.JiveClassicRenderFilter |
---|
isDisplayable |
Constructor Detail |
---|
public ImageFilter()
Method Detail |
---|
public java.lang.String getName()
RenderFilter
getName
in interface RenderFilter
getName
in class AbstractRenderFilter
protected boolean isEnabledByDefault()
AbstractRenderFilter
isEnabledByDefault
in class AbstractRenderFilter
public java.lang.String[] getTags()
TagFilter
getTags
in interface TagFilter
protected java.lang.String executePlainTextTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_PLAIN_TEXT
.
executePlainTextTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.lang.String executePlainEmailTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_PLAIN_EMAIL
.
executePlainEmailTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.lang.String executeHtmlTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_HTML
.
executeHtmlTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.lang.String executeWysiwygEditorTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_WYSIWYG_EDITOR
.
executeWysiwygEditorTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.lang.String executeNoMarkupTarget(java.lang.String string, RenderContext renderContext)
AbstractRenderFilter
RenderTarget.TARGET_NO_MARKUP
.
executeNoMarkupTarget
in class AbstractRenderFilter
string
- the String to filterrenderContext
- the context the filter is being executed within
protected java.util.Map getDocumentationMap()
AbstractRenderFilter
getDocumentationMap
in class AbstractRenderFilter
protected java.lang.String[] getDefaultHelp()
AbstractRenderFilter
getDefaultHelp
in class AbstractRenderFilter
public static java.lang.String convertHtmlToMarkup(java.lang.String html)
public static java.lang.String convertMarkupToHtml(ForumMessage msg, java.lang.String markup)
public static ImageFilter.NntpImageResult convertMarkupToNntp(ForumMessage msg, java.lang.String source)
Attachment
it is associated with.
msg
- - the message that is being parsedsource
- - the message body to parse
ImageFilter.NntpImageResult
public static java.lang.String convertNntpToMarkup(java.util.Map cidMap, java.lang.String nntp)
cidMap
- - a mapping of "cid:" values (without the "cid:" part) to attachment ids (Long)nntp
- - the NNTP message to be parsed
public static java.util.List getAttachmentsFromNntp(ForumMessage msg, java.lang.String source)
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |