org.omnifaces.component.input.componentidparam
Class ConditionalResponseWriter

java.lang.Object
  extended by java.io.Writer
      extended by javax.faces.context.ResponseWriter
          extended by javax.faces.context.ResponseWriterWrapper
              extended by org.omnifaces.component.input.componentidparam.ConditionalResponseWriter
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable, java.lang.Appendable, javax.faces.FacesWrapper<javax.faces.context.ResponseWriter>

public class ConditionalResponseWriter
extends javax.faces.context.ResponseWriterWrapper

ResponseWriter intended to work in conjunction with the ComponentIdParam component.

This allows rendering to proceed to the output if the current component matches any of the given ids, otherwise simply does not send anything to the output.

Since:
1.1
Author:
Arjan Tijms

Field Summary
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
ConditionalResponseWriter(javax.faces.context.ResponseWriter responseWriter, javax.faces.context.FacesContext facesContext, java.util.List<java.lang.String> componentIds, java.util.List<java.lang.String> clientIds, boolean renderChildren)
           
 
Method Summary
 java.io.Writer append(char c)
           
 java.io.Writer append(java.lang.CharSequence csq)
           
 java.io.Writer append(java.lang.CharSequence csq, int start, int end)
           
 void endCDATA()
           
 void endDocument()
           
 void endElement(java.lang.String name)
           
 javax.faces.context.ResponseWriter getWrapped()
           
 void startCDATA()
           
 void startDocument()
           
 void startElement(java.lang.String name, javax.faces.component.UIComponent component)
           
 void write(char[] cbuf)
           
 void write(char[] cbuf, int off, int len)
           
 void write(int c)
           
 void write(java.lang.String str)
           
 void write(java.lang.String str, int off, int len)
           
 void writeAttribute(java.lang.String name, java.lang.Object value, java.lang.String property)
           
 void writeComment(java.lang.Object comment)
           
 void writeText(char[] text, int off, int len)
           
 void writeText(java.lang.Object text, java.lang.String property)
           
 void writeText(java.lang.Object text, javax.faces.component.UIComponent component, java.lang.String property)
           
 void writeURIAttribute(java.lang.String name, java.lang.Object value, java.lang.String property)
           
 
Methods inherited from class javax.faces.context.ResponseWriterWrapper
cloneWithWriter, close, flush, getCharacterEncoding, getContentType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConditionalResponseWriter

public ConditionalResponseWriter(javax.faces.context.ResponseWriter responseWriter,
                                 javax.faces.context.FacesContext facesContext,
                                 java.util.List<java.lang.String> componentIds,
                                 java.util.List<java.lang.String> clientIds,
                                 boolean renderChildren)
Method Detail

endCDATA

public void endCDATA()
              throws java.io.IOException
Overrides:
endCDATA in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

endElement

public void endElement(java.lang.String name)
                throws java.io.IOException
Overrides:
endElement in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

endDocument

public void endDocument()
                 throws java.io.IOException
Overrides:
endDocument in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

startCDATA

public void startCDATA()
                throws java.io.IOException
Overrides:
startCDATA in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

startDocument

public void startDocument()
                   throws java.io.IOException
Overrides:
startDocument in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

startElement

public void startElement(java.lang.String name,
                         javax.faces.component.UIComponent component)
                  throws java.io.IOException
Overrides:
startElement in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws java.io.IOException
Overrides:
write in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

writeAttribute

public void writeAttribute(java.lang.String name,
                           java.lang.Object value,
                           java.lang.String property)
                    throws java.io.IOException
Overrides:
writeAttribute in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

writeComment

public void writeComment(java.lang.Object comment)
                  throws java.io.IOException
Overrides:
writeComment in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

writeText

public void writeText(char[] text,
                      int off,
                      int len)
               throws java.io.IOException
Overrides:
writeText in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

writeText

public void writeText(java.lang.Object text,
                      java.lang.String property)
               throws java.io.IOException
Overrides:
writeText in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

writeText

public void writeText(java.lang.Object text,
                      javax.faces.component.UIComponent component,
                      java.lang.String property)
               throws java.io.IOException
Overrides:
writeText in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

writeURIAttribute

public void writeURIAttribute(java.lang.String name,
                              java.lang.Object value,
                              java.lang.String property)
                       throws java.io.IOException
Overrides:
writeURIAttribute in class javax.faces.context.ResponseWriterWrapper
Throws:
java.io.IOException

append

public java.io.Writer append(char c)
                      throws java.io.IOException
Specified by:
append in interface java.lang.Appendable
Overrides:
append in class java.io.Writer
Throws:
java.io.IOException

append

public java.io.Writer append(java.lang.CharSequence csq)
                      throws java.io.IOException
Specified by:
append in interface java.lang.Appendable
Overrides:
append in class java.io.Writer
Throws:
java.io.IOException

append

public java.io.Writer append(java.lang.CharSequence csq,
                             int start,
                             int end)
                      throws java.io.IOException
Specified by:
append in interface java.lang.Appendable
Overrides:
append in class java.io.Writer
Throws:
java.io.IOException

write

public void write(char[] cbuf)
           throws java.io.IOException
Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

write

public void write(int c)
           throws java.io.IOException
Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

write

public void write(java.lang.String str)
           throws java.io.IOException
Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

write

public void write(java.lang.String str,
                  int off,
                  int len)
           throws java.io.IOException
Overrides:
write in class java.io.Writer
Throws:
java.io.IOException

getWrapped

public javax.faces.context.ResponseWriter getWrapped()
Specified by:
getWrapped in interface javax.faces.FacesWrapper<javax.faces.context.ResponseWriter>
Overrides:
getWrapped in class javax.faces.context.ResponseWriterWrapper