|
| |
|
| javax.portlet.RenderResponse
All known Subclasses: com.sun.portal.portlet.impl.RenderResponseImpl,
| RenderResponse | | public interface RenderResponse extends PortletResponse(Code) | | The RenderResponse defines an object to assist a portlet in
sending a response to the portal.
It extends the PortletResponse interface to provide specific
render response functionality to portlets.
The portlet container creates a RenderResponse object and
passes it as argument to the portlet's render method.
See Also: RenderRequest
See Also: PortletResponse |
| Field Summary | |
| final public static String | EXPIRATION_CACHE
Property to set the expiration time in seconds for this
response using the setProperty method. |
| Method Summary | |
| public PortletURL | createActionURL()
Creates a portlet URL targeting the portlet. | | public PortletURL | createRenderURL()
Creates a portlet URL targeting the portlet. | | public void | flushBuffer()
Forces any content in the buffer to be written to the client. | | public int | getBufferSize()
Returns the actual buffer size used for the response. | | public String | getCharacterEncoding()
Returns the name of the charset used for
the MIME body sent in this response. | | public String | getContentType()
Returns the MIME type that can be used to contribute
markup to the render response. | | public java.util.Locale | getLocale()
Returns the locale assigned to the response. | | public String | getNamespace()
The value returned by this method should be prefixed or appended to
elements, such as JavaScript variables or function names, to ensure
they are unique in the context of the portal page. | | public java.io.OutputStream | getPortletOutputStream()
Returns a OutputStream suitable for writing binary
data in the response. | | public java.io.PrintWriter | getWriter()
Returns a PrintWriter object that can send character
text to the portal. | | public boolean | isCommitted()
Returns a boolean indicating if the response has been
committed. | | public void | reset()
Clears any data that exists in the buffer as well as the properties set. | | public void | resetBuffer()
Clears the content of the underlying buffer in the response without
clearing properties set. | | public void | setBufferSize(int size)
Sets the preferred buffer size for the body of the response. | | public void | setContentType(String type)
Sets the MIME type for the render response. | | public void | setTitle(String title)
This method sets the title of the portlet. |
| EXPIRATION_CACHE | | final public static String EXPIRATION_CACHE(Code) | | Property to set the expiration time in seconds for this
response using the setProperty method.
If the expiration value is set to 0, caching is disabled
for this portlet; if the value is set to -1,
the cache does not expire.
The value is "portlet.expiration-cache".
|
| createActionURL | | public PortletURL createActionURL()(Code) | | Creates a portlet URL targeting the portlet. If no portlet mode,
window state or security modifier is set in the PortletURL the
current values are preserved. If a request is triggered by the
PortletURL, it results in an action request.
The returned URL can be further extended by adding
portlet-specific parameters and portlet modes and window states.
The created URL will per default not contain any parameters
of the current render request.
a portlet action URL |
| createRenderURL | | public PortletURL createRenderURL()(Code) | | Creates a portlet URL targeting the portlet. If no portlet mode,
window state or security modifier is set in the PortletURL the
current values are preserved. If a request is triggered by the
PortletURL, it results in a render request.
The returned URL can be further extended by adding
portlet-specific parameters and portlet modes and window states.
The created URL will per default not contain any parameters
of the current render request.
a portlet render URL |
| getCharacterEncoding | | public String getCharacterEncoding()(Code) | | Returns the name of the charset used for
the MIME body sent in this response.
See RFC 2047
for more information about character encoding and MIME.
a String specifying thename of the charset, forexample, ISO-8859-1 |
| getLocale | | public java.util.Locale getLocale()(Code) | | Returns the locale assigned to the response.
Locale of this response |
| getNamespace | | public String getNamespace()(Code) | | The value returned by this method should be prefixed or appended to
elements, such as JavaScript variables or function names, to ensure
they are unique in the context of the portal page.
the namespace |
| setBufferSize | | public void setBufferSize(int size)(Code) | | Sets the preferred buffer size for the body of the response.
The portlet container will use a buffer at least as large as
the size requested.
This method must be called before any response body content is
written; if content has been written, or the portlet container
does not support buffering, this method may throw an
IllegalStateException.
Parameters:
size - the preferred buffer size
exception:
java.lang.IllegalStateException - if this method is called aftercontent has been written, or theportlet container does not support buffering
See Also: RenderResponse.getBufferSize
See Also: RenderResponse.flushBuffer
See Also: RenderResponse.isCommitted
See Also: RenderResponse.reset |
| setTitle | | public void setTitle(String title)(Code) | | This method sets the title of the portlet.
The value can be a text String
Parameters:
title - portlet title as text String or resource URI |
|
|
|