|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.io.Writer
javax.faces.context.ResponseWriter
javax.faces.context.ResponseWriterWrapper
javax.faces.context.PartialResponseWriter
public class PartialResponseWriter
PartialResponseWriter
decorates an existing ResponseWriter to support the
generation of a partial response suitable for Ajax operations.
In addition to the markup generation methods inherited from
javax.faces.context.ResponseWriter, this class provides
methods for constructing the standard partial response elements.
| Field Summary | |
|---|---|
static java.lang.String |
RENDER_ALL_MARKER
Reserved ID value to indicate entire ViewRoot. |
static java.lang.String |
VIEW_STATE_MARKER
Reserved ID value to indicate serialized ViewState. |
| Fields inherited from class java.io.Writer |
|---|
lock |
| Constructor Summary | |
|---|---|
PartialResponseWriter(ResponseWriter writer)
Create a |
|
| Method Summary | |
|---|---|
void |
delete(java.lang.String targetId)
Write a delete operation. |
void |
endDocument()
Write the end of a partial response. |
void |
endError()
Write the end of an error. |
void |
endEval()
Write the end of an eval operation. |
void |
endExtension()
Write the end of an extension operation. |
void |
endInsert()
Write the end of an insert operation. |
void |
endUpdate()
Write the end of an update operation. |
ResponseWriter |
getWrapped()
Return the wrapped
|
void |
redirect(java.lang.String url)
Write a redirect operation. |
void |
startDocument()
Write the start of a partial response. |
void |
startError(java.lang.String errorName)
Write the start of an error. |
void |
startEval()
Write the start of an eval operation. |
void |
startExtension(java.util.Map<java.lang.String,java.lang.String> attributes)
Write the start of an extension operation. |
void |
startInsertAfter(java.lang.String targetId)
Write the start of an insert operation where the contents will be inserted after the specified target node. |
void |
startInsertBefore(java.lang.String targetId)
Write the start of an insert operation where the contents will be inserted before the specified target node. |
void |
startUpdate(java.lang.String targetId)
Write the start of an update operation. |
void |
updateAttributes(java.lang.String targetId,
java.util.Map<java.lang.String,java.lang.String> attributes)
Write an attribute update operation. |
| Methods inherited from class javax.faces.context.ResponseWriterWrapper |
|---|
cloneWithWriter, close, endCDATA, endElement, flush, getCharacterEncoding, getContentType, startCDATA, startElement, write, writeAttribute, writeComment, writeText, writeText, writeText, writeURIAttribute |
| Methods inherited from class java.io.Writer |
|---|
append, append, append, write, write, write, write |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String RENDER_ALL_MARKER
Reserved ID value to indicate entire ViewRoot.
public static final java.lang.String VIEW_STATE_MARKER
Reserved ID value to indicate serialized ViewState.
| Constructor Detail |
|---|
public PartialResponseWriter(ResponseWriter writer)
Create a PartialResponseWriter.
writer - The writer to wrap.| Method Detail |
|---|
public ResponseWriter getWrapped()
Return the wrapped
ResponseWriter instance.
getWrapped in interface FacesWrapper<ResponseWriter>getWrapped in class ResponseWriterWrapperResponseWriterWrapper#getWrapped()
public void startDocument()
throws java.io.IOException
Write the start of a partial response.
startDocument in class ResponseWriterWrapperjava.io.IOException - if an input/output error occursResponseWriter#startDocument()
public void endDocument()
throws java.io.IOException
Write the end of a partial response.
endDocument in class ResponseWriterWrapperjava.io.IOException - if an input/output error occursResponseWriter#endDocument()
public void startInsertBefore(java.lang.String targetId)
throws java.io.IOException
Write the start of an insert operation where the contents will be inserted before the specified target node.
targetId - ID of the node insertion should occur before
java.io.IOException - if an input/output error occurs
public void startInsertAfter(java.lang.String targetId)
throws java.io.IOException
Write the start of an insert operation where the contents will be inserted after the specified target node.
targetId - ID of the node insertion should occur after
java.io.IOException - if an input/output error occurs
public void endInsert()
throws java.io.IOException
Write the end of an insert operation.
java.io.IOException - if an input/output error occurs
public void startUpdate(java.lang.String targetId)
throws java.io.IOException
Write the start of an update operation.
targetId - ID of the node to be updated
java.io.IOException - if an input/output error occurs
public void endUpdate()
throws java.io.IOException
Write the end of an update operation.
java.io.IOException - if an input/output error occurs
public void updateAttributes(java.lang.String targetId,
java.util.Map<java.lang.String,java.lang.String> attributes)
throws java.io.IOException
Write an attribute update operation.
targetId - ID of the node to be updatedattributes - Map of attribute name/value pairs to be updated
java.io.IOException - if an input/output error occurs
public void delete(java.lang.String targetId)
throws java.io.IOException
Write a delete operation.
targetId - ID of the node to be deleted
java.io.IOException - if an input/output error occurs
public void redirect(java.lang.String url)
throws java.io.IOException
Write a redirect operation.
url - URL to redirect to
java.io.IOException - if an input/output error occurs
public void startEval()
throws java.io.IOException
Write the start of an eval operation.
java.io.IOException - if an input/output error occurs
public void endEval()
throws java.io.IOException
Write the end of an eval operation.
java.io.IOException - if an input/output error occurs
public void startExtension(java.util.Map<java.lang.String,java.lang.String> attributes)
throws java.io.IOException
Write the start of an extension operation.
attributes - String name/value pairs for extension element attributes
java.io.IOException - if an input/output error occurs
public void endExtension()
throws java.io.IOException
Write the end of an extension operation.
java.io.IOException - if an input/output error occurs
public void startError(java.lang.String errorName)
throws java.io.IOException
Write the start of an error.
errorName - Descriptive string for the error
java.io.IOException - if an input/output error occurs
public void endError()
throws java.io.IOException
Write the end of an error.
java.io.IOException - if an input/output error occurs
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24