Package org.apache.myfaces.tobago.webapp
Class TobagoResponseWriter
- java.lang.Object
-
- java.io.Writer
-
- javax.faces.context.ResponseWriter
-
- org.apache.myfaces.tobago.webapp.TobagoResponseWriter
-
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
- Direct Known Subclasses:
DebugResponseWriterWrapper
,TobagoResponseWriterBase
,TobagoResponseWriterWrapper
public abstract class TobagoResponseWriter extends javax.faces.context.ResponseWriter
This provides an alternative ResponseWriter interfaces, which allows optimizations. E. g. some attributes needed to to be escaped.
-
-
Constructor Summary
Constructors Constructor Description TobagoResponseWriter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract javax.faces.context.ResponseWriter
cloneWithWriter(Writer writer)
void
endCDATA()
abstract void
endElement(String name)
Deprecated.Should not directly called via this interface.abstract void
endElement(HtmlElements name)
abstract void
flush()
String
getContentTypeWithCharSet()
void
startCDATA()
abstract void
startElement(String name, javax.faces.component.UIComponent component)
Deprecated.Should not directly called via this interface.abstract void
startElement(HtmlElements name)
abstract void
write(String string)
abstract void
writeAttribute(String name, Object value, String property)
Deprecated.since 1.0.11, should not directly called via this interface.void
writeAttribute(MarkupLanguageAttributes name, boolean on)
Writes a boolean attribute.void
writeAttribute(MarkupLanguageAttributes name, Integer number)
Writes aInteger
attribute, if the value is notnull
.abstract void
writeAttribute(MarkupLanguageAttributes name, String string, boolean escape)
Writes a string attribute.abstract void
writeAttribute(MarkupLanguageAttributes name, HtmlTypes type)
void
writeClassAttribute(CssItem... first)
Write the class attribute.void
writeClassAttribute(CssItem first, CssItem[] second, CssItem... third)
Write the class attribute.void
writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem... fourth)
Write the class attribute.void
writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem[] fourth, CssItem... fifth)
Write the class attribute.void
writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem[] fourth, CssItem[] fifth, CssItem... sixth)
void
writeCommandMapAttribute(String map)
Write the command map data attribute.abstract void
writeComment(Object comment)
void
writeIcon(Icons icon, CssItem... cssItems)
Deprecated.4.0.0.void
writeIdAttribute(String id)
Write the id attribute.void
writeNameAttribute(String name)
Write the name attribute.void
writeStyleAttribute(Style style)
Deprecated.since 4.0.0.abstract void
writeText(Object text, String property)
Deprecated.Should not directly called via this interface.void
writeText(String text)
Write text content.abstract void
writeURIAttribute(String name, Object value, String property)
Deprecated.since 1.0.11, should not directly called via this interface.abstract void
writeURIAttribute(MarkupLanguageAttributes name, String string)
Writes a string attribute URL encoded.-
Methods inherited from class javax.faces.context.ResponseWriter
endDocument, getCharacterEncoding, getContentType, startDocument, writeText, writeText
-
-
-
-
Method Detail
-
startElement
@Deprecated public abstract void startElement(String name, javax.faces.component.UIComponent component) throws IOException
Deprecated.Should not directly called via this interface. There is be a special method which might be better.- Specified by:
startElement
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
startElement
public abstract void startElement(HtmlElements name) throws IOException
- Throws:
IOException
-
endElement
@Deprecated public abstract void endElement(String name) throws IOException
Deprecated.Should not directly called via this interface. There is be a special method which might be better.- Specified by:
endElement
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
endElement
public abstract void endElement(HtmlElements name) throws IOException
- Throws:
IOException
-
write
public abstract void write(String string) throws IOException
- Overrides:
write
in classWriter
- Throws:
IOException
-
writeComment
public abstract void writeComment(Object comment) throws IOException
- Specified by:
writeComment
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
cloneWithWriter
public abstract javax.faces.context.ResponseWriter cloneWithWriter(Writer writer)
- Specified by:
cloneWithWriter
in classjavax.faces.context.ResponseWriter
-
writeAttribute
@Deprecated public abstract void writeAttribute(String name, Object value, String property) throws IOException
Deprecated.since 1.0.11, should not directly called via this interface. There is be a special method which might be better.- Specified by:
writeAttribute
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
writeURIAttribute
@Deprecated public abstract void writeURIAttribute(String name, Object value, String property) throws IOException
Deprecated.since 1.0.11, should not directly called via this interface. There is be a special method which might be better.- Specified by:
writeURIAttribute
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
writeText
@Deprecated public abstract void writeText(Object text, String property) throws IOException
Deprecated.Should not directly called via this interface. There is be a special method which might be better.- Specified by:
writeText
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
flush
public abstract void flush() throws IOException
- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
writeAttribute
public abstract void writeAttribute(MarkupLanguageAttributes name, String string, boolean escape) throws IOException
Writes a string attribute. The renderer may set escape=false to switch of escaping of the string, if it is not necessary.- Throws:
IOException
-
writeAttribute
public abstract void writeAttribute(MarkupLanguageAttributes name, HtmlTypes type) throws IOException
- Throws:
IOException
-
writeURIAttribute
public abstract void writeURIAttribute(MarkupLanguageAttributes name, String string) throws IOException
Writes a string attribute URL encoded.- Throws:
IOException
-
writeAttribute
public void writeAttribute(MarkupLanguageAttributes name, boolean on) throws IOException
Writes a boolean attribute. The value will not escaped.- Throws:
IOException
-
writeAttribute
public void writeAttribute(MarkupLanguageAttributes name, Integer number) throws IOException
Writes aInteger
attribute, if the value is notnull
. The value will not be escaped.- Throws:
IOException
-
writeIdAttribute
public void writeIdAttribute(String id) throws IOException
Write the id attribute. The value will not escaped.- Throws:
IOException
-
writeNameAttribute
public void writeNameAttribute(String name) throws IOException
Write the name attribute. The value will not escaped.- Throws:
IOException
-
writeCommandMapAttribute
public void writeCommandMapAttribute(String map) throws IOException
Write the command map data attribute.- Throws:
IOException
-
writeClassAttribute
public void writeClassAttribute(CssItem... first) throws IOException
Write the class attribute. The value will not escaped.- Throws:
IOException
-
writeClassAttribute
public void writeClassAttribute(CssItem first, CssItem[] second, CssItem... third) throws IOException
Write the class attribute. The value will not escaped.- Throws:
IOException
-
writeClassAttribute
public void writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem... fourth) throws IOException
Write the class attribute. The value will not escaped.- Throws:
IOException
-
writeClassAttribute
public void writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem[] fourth, CssItem... fifth) throws IOException
Write the class attribute. The value will not escaped.- Throws:
IOException
-
writeClassAttribute
public void writeClassAttribute(CssItem first, CssItem[] second, CssItem[] third, CssItem[] fourth, CssItem[] fifth, CssItem... sixth) throws IOException
- Throws:
IOException
-
writeStyleAttribute
@Deprecated public void writeStyleAttribute(Style style) throws IOException
Deprecated.since 4.0.0. UIStyle now renders itself.Write the style attribute. The value may be escaped (depending of the content).- Throws:
IOException
-
writeIcon
@Deprecated public void writeIcon(Icons icon, CssItem... cssItems) throws IOException
Deprecated.4.0.0. Use normal rendering methods.Writes an supported icon.- Throws:
IOException
-
writeText
public void writeText(String text) throws IOException
Write text content. The text will be escaped.- Throws:
IOException
-
getContentTypeWithCharSet
public String getContentTypeWithCharSet()
-
startCDATA
public void startCDATA() throws IOException
- Overrides:
startCDATA
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
endCDATA
public void endCDATA() throws IOException
- Overrides:
endCDATA
in classjavax.faces.context.ResponseWriter
- Throws:
IOException
-
-