org.apache.tapestry
Interface IMarkupWriter

All Known Implementing Classes:

AbstractMarkupWriter, HTMLWriter, NestedHTMLWriter, NestedWMLWriter, NullWriter, WMLWriter

public interface IMarkupWriter

Defines an object that can write markup (XML, HTML, XHTML) style output. A IMarkupWriter handles translation from unicode to the markup language (escaping characters such as '<' and '>' to their entity equivalents, '&lt;' and '&gt;') as well as assisting with nested elements, closing tags, etc.

Version:

$Id: IMarkupWriter.java 243791 2004-02-19 17:38:13Z hlship $

Author:

Howard Ship, David Solis

Method Summary

void	attribute(String name, boolean value) Writes a boolean attribute into the currently open tag.
void	attribute(String name, int value) Writes an integer attribute into the currently open tag.
void	attribute(String name, String value) Writes an attribute into the most recently opened tag.
void	attributeRaw(String name, String value) Similar to attribute(String, String) but no escaping of invalid elements is done for the value.
void	begin(String name) Closes any existing tag then starts a new element.
void	beginEmpty(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(String value) Writes an XML/HTML comment.
void	end() Ends the element most recently started by begin(String).
void	end(String name) Ends the most recently started element with the given name.
void	flush() Forwards flush() to this IMarkupWriter's PrintWriter.
String	getContentType() Returns the type of content generated by this response writer, as a MIME type.
IMarkupWriter	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) The primary print() method, used by most other methods.
void	print(int value) Prints an integer.
void	print(String value) Invokes print(char[], int, int) to print 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) Prints a portion of an output buffer to the stream.
void	printRaw(String value) Prints output to the stream.

Method Detail

attribute

void attribute(String name,
               int value)

Writes an integer attribute into the currently open tag.

Throws:

IllegalStateException - if there is no open tag.

attribute

void attribute(String name,
               boolean value)

Writes a boolean attribute into the currently open tag.

Throws:

IllegalStateException - if there is no open tag.

Since:

3.0

attribute

void attribute(String name,
               String value)

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

The value may be null.

Throws:

IllegalStateException - if there is no open tag.

attributeRaw

void attributeRaw(String name,
                  String value)

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

Throws:

IllegalStateException - if there is no open tag.

Since:

3.0

begin

void begin(String name)

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

beginEmpty

void beginEmpty(String name)

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

checkError

boolean checkError()

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

close

void close()

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.

closeTag

void closeTag()

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 begin(String) or or beginEmpty(String).

comment

void comment(String value)

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 printRaw(String).

end

void end()

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

end

void end(String name)

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.

flush

void flush()

Forwards flush() to this IMarkupWriter's PrintWriter.

getNestedWriter

IMarkupWriter getNestedWriter()

Returns a nested writer, one that accumulates its changes in a buffer. When the nested writer is closed, it writes its buffer into its containing IMarkupWriter.

print

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

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.

print

void print(char value)

Prints a single character, or its equivalent entity.

Closes any open tag.

print

void print(int value)

Prints an integer.

Closes any open tag.

print

void print(String value)

Invokes print(char[], int, int) to print the string. Use printRaw(String) if the character data is known to be safe.

Does nothing if value is null.

Closes any open tag.

See Also:

print(char[], int, int)

println

void println()

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

printRaw

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

Prints a portion of an output buffer to the stream. No escaping of invalid elements is done, which makes this more effecient than print(). Does nothing if buffer is null.

Closes any open tag.

printRaw

void printRaw(String value)

Prints output to the stream. No escaping of invalid elements is done, which makes this more effecient than print().

Does nothing if value is null.

Closes any open tag.

getContentType

String getContentType()

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