org.apache.tapestry.markup

Class MarkupWriterImpl

java.lang.Object

org.apache.tapestry.markup.MarkupWriterImpl

All Implemented Interfaces:

IMarkupWriter

Direct Known Subclasses:

NestedMarkupWriterImpl

public class MarkupWriterImpl
extends java.lang.Object
implements IMarkupWriter

Completely revised (for 4.0) implementation of IMarkupWriter. No longer does internal buffering (since the servlet/portlet APIs support that natively) and wraps around a PrintWriter (rather than an OutputStream).

Since:

4.0

Author:

Howard M. Lewis Ship

Constructor Summary

Constructors

Constructor and Description
MarkupWriterImpl(java.lang.String contentType, java.io.PrintWriter writer, MarkupFilter filter)

Method Summary

Methods

Modifier and Type	Method and Description
void	attribute(java.lang.String name, boolean value) Writes a boolean attribute into the currently open tag.
void	attribute(java.lang.String name, int value) Writes an integer attribute into the currently open tag.
void	attribute(java.lang.String name, java.lang.String value) Writes an attribute into the most recently opened tag.
void	attribute(java.lang.String name, java.lang.String value, boolean raw)
void	attributeRaw(java.lang.String name, java.lang.String value) Similar to IMarkupWriter.attribute(String, String)but no escaping of invalid elements is done for the value.
void	begin(java.lang.String name) Closes any existing tag then starts a new element.
void	beginEmpty(java.lang.String name) Starts an element that will not later be matched with an end() call.
boolean	checkError() Invokes checkError() on the PrintWriter used to format output.
void	close() Closes this IMarkupWriter.
void	closeTag() Closes the most recently opened element by writing the '>' that ends it.
void	comment(java.lang.String value) Writes an XML/HTML comment.
void	end() Ends the element most recently started by .
void	end(java.lang.String name) Ends the most recently started element with the given name.
void	flush() Forwards flush() to this IMarkupWriter's PrintWriter.
java.lang.String	getContentType() Returns the type of content generated by this response writer, as a MIME type.
NestedMarkupWriter	getNestedWriter() Returns a nested writer, one that accumulates its changes in a buffer.
void	print(char value) Prints a single character, or its equivalent entity.
void	print(char[] data, int offset, int length) Version of IMarkupWriter.print(char[], int, int, boolean) that assumes filter is enabled.
void	print(char[] buffer, int offset, int length, boolean raw) The primary print() method, used by most other methods.
void	print(int value) Prints an integer.
void	print(java.lang.String value) As with IMarkupWriter.print(char[], int, int, boolean), but the data to print is defined by the String.
void	print(java.lang.String value, boolean raw) As with IMarkupWriter.print(char[], int, int, boolean), but the data to print is defined by the String.
void	println() Closes the open tag (if any), then prints a line seperator to the output stream.
void	printRaw(char[] buffer, int offset, int length) Version of IMarkupWriter.print(char[], int, int, boolean)that assumes filter is enabled.
void	printRaw(java.lang.String value) As with IMarkupWriter.print(char[], int, int, boolean), but the data to print is defined by the String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MarkupWriterImpl

public MarkupWriterImpl(java.lang.String contentType,
                java.io.PrintWriter writer,
                MarkupFilter filter)

Method Detail

attribute

public void attribute(java.lang.String name,
             int value)

Description copied from interface: IMarkupWriter

Writes an integer attribute into the currently open tag.

Specified by:

attribute in interface IMarkupWriter

attribute

public void attribute(java.lang.String name,
             boolean value)

Description copied from interface: IMarkupWriter

Writes a boolean attribute into the currently open tag.

Specified by:

attribute in interface IMarkupWriter

attribute

public void attribute(java.lang.String name,
             java.lang.String value)

Description copied from interface: IMarkupWriter

Writes an attribute into the most recently opened tag. This must be called after IMarkupWriter.begin(String)and before any other kind of writing (which closes the tag).

The value may be null.

Specified by:

attribute in interface IMarkupWriter

attribute

public void attribute(java.lang.String name,
             java.lang.String value,
             boolean raw)

attributeRaw

public void attributeRaw(java.lang.String name,
                java.lang.String value)

Description copied from interface: IMarkupWriter

Similar to IMarkupWriter.attribute(String, String)but no escaping of invalid elements is done for the value.

Specified by:

attributeRaw in interface IMarkupWriter

begin

public void begin(java.lang.String name)

Description copied from interface: IMarkupWriter

Closes any existing tag then starts a new element. The new element is pushed onto the active element stack.

Specified by:

begin in interface IMarkupWriter

beginEmpty

public void beginEmpty(java.lang.String name)

Description copied from interface: IMarkupWriter

Starts an element that will not later be matched with an end() call. This is useful for elements that do not need closing tags.

Specified by:

beginEmpty in interface IMarkupWriter

checkError

public boolean checkError()

Description copied from interface: IMarkupWriter

Invokes checkError() on the PrintWriter used to format output.

Specified by:

checkError in interface IMarkupWriter

close

public void close()

Description copied from interface: IMarkupWriter

Closes this IMarkupWriter. Close tags are written for any active elements. The PrintWriter is then sent close(). A nested writer will commit its buffer to its containing writer.

Specified by:

close in interface IMarkupWriter

closeTag

public void closeTag()

Description copied from interface: IMarkupWriter

Closes the most recently opened element by writing the '>' that ends it. Once this is invoked, the attribute() methods may not be used until a new element is opened with IMarkupWriter.begin(String)or or IMarkupWriter.beginEmpty(String).

Specified by:

closeTag in interface IMarkupWriter

comment

public void comment(java.lang.String value)

Description copied from interface: IMarkupWriter

Writes an XML/HTML comment. Any open tag is first closed. The method takes care of providing the <!-- and -->, and provides a blank line after the close of the comment.

Most characters are valid inside a comment, so no check of the contents is made (much like IMarkupWriter.printRaw(String).

Specified by:

comment in interface IMarkupWriter

end

public void end()

Description copied from interface: IMarkupWriter

Ends the element most recently started by . The name of the tag is popped off of the active element stack and used to form an HTML close tag.

Specified by:

end in interface IMarkupWriter

end

public void end(java.lang.String name)

Description copied from interface: IMarkupWriter

Ends the most recently started element with the given name. This will also end any other intermediate elements. This is very useful for easily ending a table or even an entire page.

Specified by:

end in interface IMarkupWriter

flush

public void flush()

Description copied from interface: IMarkupWriter

Forwards flush() to this IMarkupWriter's PrintWriter.

Specified by:

flush in interface IMarkupWriter

getNestedWriter

public NestedMarkupWriter getNestedWriter()

Description copied from interface: IMarkupWriter

Returns a nested writer, one that accumulates its changes in a buffer. When the nested writer is closed, it writes its buffer of markup into its containing IMarkupWriter using IMarkupWriter.printRaw(String).

Specified by:

getNestedWriter in interface IMarkupWriter

print

public void print(char[] data,
         int offset,
         int length)

Description copied from interface: IMarkupWriter

Version of IMarkupWriter.print(char[], int, int, boolean) that assumes filter is enabled.

Specified by:

print in interface IMarkupWriter

printRaw

public void printRaw(char[] buffer,
            int offset,
            int length)

Description copied from interface: IMarkupWriter

Version of IMarkupWriter.print(char[], int, int, boolean)that assumes filter is enabled.

Specified by:

printRaw in interface IMarkupWriter

print

public void print(char[] buffer,
         int offset,
         int length,
         boolean raw)

Description copied from interface: IMarkupWriter

The primary print() method, used by most other methods.

Prints the character array, first closing any open tag. Problematic characters ('<', '>' and '&') are converted to appropriate entities.

Does nothing if data is null.

Closes any open tag.

Specified by:

print in interface IMarkupWriter

Parameters:

buffer - contains the characters to print, or null to not print anything

offset - offset into the array to start printing from

length - number of characters to print

raw - if true, filtering is disabled

print

public void print(java.lang.String value)

Description copied from interface: IMarkupWriter

As with IMarkupWriter.print(char[], int, int, boolean), but the data to print is defined by the String. Assumes filtering is enabled.

Specified by:

print in interface IMarkupWriter

printRaw

public void printRaw(java.lang.String value)

Description copied from interface: IMarkupWriter

As with IMarkupWriter.print(char[], int, int, boolean), but the data to print is defined by the String. Assumes filtering is disabled.

Specified by:

printRaw in interface IMarkupWriter

print

public void print(java.lang.String value,
         boolean raw)

Description copied from interface: IMarkupWriter

As with IMarkupWriter.print(char[], int, int, boolean), but the data to print is defined by the String.

Specified by:

print in interface IMarkupWriter

print

public void print(char value)

Description copied from interface: IMarkupWriter

Prints a single character, or its equivalent entity.

Closes any open tag.

Specified by:

print in interface IMarkupWriter

print

public void print(int value)

Description copied from interface: IMarkupWriter

Prints an integer.

Closes any open tag.

Specified by:

print in interface IMarkupWriter

println

public void println()

Description copied from interface: IMarkupWriter

Closes the open tag (if any), then prints a line seperator to the output stream.

Specified by:

println in interface IMarkupWriter

getContentType

public java.lang.String getContentType()

Description copied from interface: IMarkupWriter

Returns the type of content generated by this response writer, as a MIME type.

Specified by:

getContentType in interface IMarkupWriter