|
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.filter.JIRAFilter
public class JIRAFilter
A filter for transforming JIRA issue numbers into more detailed issue information as well as a link to the actual issue. The filter looks for properly formed issue ID's, such as FORUMS-123.
Constructor Summary | |
---|---|
JIRAFilter()
|
Method Summary | |
---|---|
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 . |
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 |
getJiraInstance()
Returns the base URL for the JIRA instance. |
java.lang.String |
getName()
Returns the unique name of the filter. |
java.lang.String |
getPassword()
Returns the password used to connect to the JIRA instance or null if no password is used. |
java.lang.String |
getProjectNames()
Returns the list of comma-delimited project names to be looked for. |
java.lang.String |
getUsername()
Returns the username used to connect to the JIRA instance or null if no username is used. |
protected boolean |
isEnabledByDefault()
Returns true if the filter should be enabled by default, false otherwise. |
boolean |
isOpenWindow()
Returns true if link clicks should pen a new window. |
boolean |
isTrackbackEnabled()
Returns true if trackabck information is sent to the JIRA instance. |
boolean |
isUseNewStyle()
Returns true if the filter should use the new RSS feeds available in Jira 3.7. |
void |
setJiraInstance(java.lang.String jiraInstance)
Sets the base URL for the JIRA instance. |
void |
setOpenWindow(boolean openWindow)
Toggle for opening a new window when clicking an issue link. |
void |
setPassword(java.lang.String password)
Sets the password used to connect to the JIRA instance or null if no password is used. |
void |
setProjectNames(java.lang.String projectNames)
Sets the list of comma-delimited project names to be looked for. |
void |
setTrackbackEnabled(boolean trackbackEnabled)
Sets whether trackabck information is sent to the JIRA instance. |
void |
setUseNewStyle(boolean useNewStyle)
True to use new style, false to use RSS URL style from versions less than 3.7. |
void |
setUsername(java.lang.String username)
Sets the username used to connect to the JIRA instance or null if no username is used. |
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 |
Constructor Detail |
---|
public JIRAFilter()
Method Detail |
---|
public java.lang.String getName()
RenderFilter
getName
in interface RenderFilter
getName
in class AbstractRenderFilter
protected boolean isEnabledByDefault()
AbstractRenderFilter
isEnabledByDefault
in class AbstractRenderFilter
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 java.lang.String getProjectNames()
public void setProjectNames(java.lang.String projectNames)
projectNames
- the list of comma-delimited project names to look for.public java.lang.String getJiraInstance()
public void setJiraInstance(java.lang.String jiraInstance)
jiraInstance
- the base URL of the JIRA instance.public boolean isOpenWindow()
public void setOpenWindow(boolean openWindow)
openWindow
- toggle for opening a new window.public boolean isUseNewStyle()
true
if the filter should use the new RSS feeds available in
Jira 3.7public void setUseNewStyle(boolean useNewStyle)
useNewStyle
- true to use new style, false to use RSS URL style from versions
less than 3.7.public java.lang.String getUsername()
public void setUsername(java.lang.String username)
username
- the username used to connect to JIRA or null if no username.public java.lang.String getPassword()
public void setPassword(java.lang.String password)
password
- the password used to connect to JIRA or null if no password.public boolean isTrackbackEnabled()
public void setTrackbackEnabled(boolean trackbackEnabled)
trackbackEnabled
- true if trackback is enabled.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |