Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter
Class ImageFilter

java.lang.Object
  extended by com.jivesoftware.forum.renderer.AbstractRenderFilter
      extended by com.jivesoftware.forum.renderer.impl.AbstractJiveClassicRenderFilter
          extended by com.jivesoftware.forum.renderer.filter.ImageFilter
All Implemented Interfaces:
com.jivesoftware.forum.renderer.impl.JiveClassicRenderFilter, com.jivesoftware.forum.renderer.impl.JiveSystemRenderFilter, RenderFilter, TagFilter

public class ImageFilter
extends AbstractJiveClassicRenderFilter
implements TagFilter, com.jivesoftware.forum.renderer.impl.JiveClassicRenderFilter

Format: servlet/JiveServlet/download/1-23-456-7890/test.gif

See Also:
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

ImageFilter

public ImageFilter()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: RenderFilter
Returns the unique name of the filter.

Specified by:
getName in interface RenderFilter
Specified by:
getName in class AbstractRenderFilter
Returns:
the unique name of the filter.

isEnabledByDefault

protected boolean isEnabledByDefault()
Description copied from class: AbstractRenderFilter
Returns true if the filter should be enabled by default, false otherwise.

Specified by:
isEnabledByDefault in class AbstractRenderFilter
Returns:
true if the filter should be enabled by default, false otherwise.

getTags

public java.lang.String[] getTags()
Description copied from interface: TagFilter
Returns an array of string for the tag names a filter uses. For example, a filter which filters upon the tags [url] and [ftp] should return a two element array of "url", "ftp"

Specified by:
getTags in interface TagFilter
Returns:
an array of string for the tag names a filter uses.

executePlainTextTarget

protected java.lang.String executePlainTextTarget(java.lang.String string,
                                                  RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_TEXT.

Specified by:
executePlainTextTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

executePlainEmailTarget

protected java.lang.String executePlainEmailTarget(java.lang.String string,
                                                   RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_EMAIL.

Specified by:
executePlainEmailTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

executeHtmlTarget

protected java.lang.String executeHtmlTarget(java.lang.String string,
                                             RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_HTML.

Specified by:
executeHtmlTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

executeWysiwygEditorTarget

protected java.lang.String executeWysiwygEditorTarget(java.lang.String string,
                                                      RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_WYSIWYG_EDITOR.

Specified by:
executeWysiwygEditorTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

executeNoMarkupTarget

protected java.lang.String executeNoMarkupTarget(java.lang.String string,
                                                 RenderContext renderContext)
Description copied from class: AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_NO_MARKUP.

Specified by:
executeNoMarkupTarget in class AbstractRenderFilter
Parameters:
string - the String to filter
renderContext - the context the filter is being executed within
Returns:
a filtered string

getDocumentationMap

protected java.util.Map getDocumentationMap()
Description copied from class: AbstractRenderFilter
Returns a documentation Map keyed by languageCode -> String[section,title,body].

Specified by:
getDocumentationMap in class AbstractRenderFilter
Returns:
a documentation Map keyed by languageCode -> String[section,title,body]

getDefaultHelp

protected java.lang.String[] getDefaultHelp()
Description copied from class: AbstractRenderFilter
Returns a String[section,title,body] for the default help for the filter.

Specified by:
getDefaultHelp in class AbstractRenderFilter
Returns:
a String[section,title,body] for the default help for the filter

convertHtmlToMarkup

public static java.lang.String convertHtmlToMarkup(java.lang.String html)

convertMarkupToHtml

public static java.lang.String convertMarkupToHtml(ForumMessage msg,
                                                   java.lang.String markup)

convertMarkupToNntp

public 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.

Parameters:
msg - - the message that is being parsed
source - - the message body to parse
Returns:
the result of the parse
See Also:
ImageFilter.NntpImageResult

convertNntpToMarkup

public 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.

Parameters:
cidMap - - a mapping of "cid:" values (without the "cid:" part) to attachment ids (Long)
nntp - - the NNTP message to be parsed
Returns:
the parsed message content, after the cid replacement

getAttachmentsFromNntp

public static java.util.List getAttachmentsFromNntp(ForumMessage msg,
                                                    java.lang.String source)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.