Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.filter.rules
Class BreakRule

java.lang.Object
  extended by com.jivesoftware.sitemesh.html.BasicRule
      extended by com.jivesoftware.forum.renderer.filter.rules.BreakRule
All Implemented Interfaces:
com.jivesoftware.sitemesh.html.TagRule, com.jivesoftware.sitemesh.html.TextFilter

public class BreakRule
extends com.jivesoftware.sitemesh.html.BasicRule
implements com.jivesoftware.sitemesh.html.TextFilter

A filter which converts
tags to newlines or \\ if the break tag has a clear="all' attribute. This filter is smart enough to know when to trim newline characters from the input stream and when not to.

This filter is the 'unapply' equivalent of the NewlineTextFilter text filter.


Field Summary
 
Fields inherited from class com.jivesoftware.sitemesh.html.BasicRule
context
 
Constructor Summary
BreakRule(FormatExclusion excludedBlocks)
           
 
Method Summary
 java.lang.String filter(java.lang.String string, int position, com.jivesoftware.sitemesh.html.HTMLProcessorContext context)
           
 boolean isNoBrEnabled()
           
 boolean process(com.jivesoftware.sitemesh.html.Tag tag)
           
 void setNoBrEnabled(boolean noBrEnabled)
           
 boolean shouldProcess(java.lang.String string)
           
 
Methods inherited from class com.jivesoftware.sitemesh.html.BasicRule
currentBuffer, setContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BreakRule

public BreakRule(FormatExclusion excludedBlocks)
Method Detail

shouldProcess

public boolean shouldProcess(java.lang.String string)
Specified by:
shouldProcess in interface com.jivesoftware.sitemesh.html.TagRule
Overrides:
shouldProcess in class com.jivesoftware.sitemesh.html.BasicRule

process

public boolean process(com.jivesoftware.sitemesh.html.Tag tag)
Specified by:
process in interface com.jivesoftware.sitemesh.html.TagRule
Specified by:
process in class com.jivesoftware.sitemesh.html.BasicRule

filter

public java.lang.String filter(java.lang.String string,
                               int position,
                               com.jivesoftware.sitemesh.html.HTMLProcessorContext context)
Specified by:
filter in interface com.jivesoftware.sitemesh.html.TextFilter

isNoBrEnabled

public boolean isNoBrEnabled()

setNoBrEnabled

public void setNoBrEnabled(boolean noBrEnabled)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.