| java.lang.Object
 com.sun.portal.portlet.impl.PortletResponseImpl
com.sun.portal.portlet.impl.RenderResponseImpl
| Method Summary | |
| void | clear()
Clears the global variables. | | 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 portlet 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 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. | | void | init(HttpServletRequest req, HttpServletResponse res, RenderRequest rReq, PortletContainerRenderRequest pContReq, PortletContainerRenderResponse pContRes, StringWriter writer, ByteArrayOutputStream output, PortletDescriptor pDescriptor, Logger logger)
Initialize the global variables. | | 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 portlet response. | | public void | setProperty(String key, String value)
Sets a String property to be returned to the portal. | | public void | setTitle(String title)
This method sets the title of the portlet. |
| clear | | void clear()(Code) | | Clears the global variables.
|
| 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 (http://ds.internic.net/rfc/rfc2045.txt)
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 |
| setProperty | | public void setProperty(String key, String value)(Code) | | Sets a String property to be returned to the portal.
Properties can be used by portlets to provide vendor specific
information to the portal.
This method resets all properties previously added with the
same key.
Parameters:
key - the key of the property to be returned to the portal
Parameters:
value - the value of the property to be returned to the portal
exception:
java.lang.IllegalArgumentException - if key is null. |
| 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 |
|
|