com.caucho.portal.generic
Class AbstractRenderer

java.lang.Object
  com.caucho.portal.generic.AbstractRenderer

All Implemented Interfaces:

Renderer

Direct Known Subclasses:

HtmlRenderer

public abstract class AbstractRenderer
extends java.lang.Object
implements Renderer

Template

To implement a renderer that adds decoration to content rendered with the PrintWriter, the following are overridden:

 protected void beginPage( PrintWriter out, RenderRequest request, String namespace )
  throws IOException
 {
   ... 
 }

 protected void beginWindow( PrintWriter out, RenderRequest request, String namespace )
  throws IOException
 {
   ... 
 }

 protected void endWindow( PrintWriter out, RenderRequest request, String namespace )
  throws IOException
 {
   ... 
 }

 protected void endPage( PrintWriter out, RenderRequest request, String namespace )
  throws IOException
 {
   ... 
 }

 
Helper methods
 
 

 
printEscaped(out, string);
 
String contentType = getContentType(request); 
 
Locale locale = getLocale(request); 
 
String title = getTitle(request); 
 
String shortTitle = getShortTitle(request); 
 
PortletURL url = getControlURL(request); 
 
Set portletModes = getPortletModes(request); 
 
Set windowStates = getWindowStates(request); 
 
ResourceBundle resourceBundle = getResourceBundle(request); 
 
PortletConfig portletConfig = getPortletConfig(request); 
 
RenderResponse renderResponse = getRenderResponse(request); 









Field Summary




protected static java.util.logging.Logger
log



           



static java.lang.String
PAGE_HEADER_RENDERED



           


 



Constructor Summary
AbstractRenderer()



           
 



Method Summary




protected  void
beginPage(java.io.OutputStream out,
          RenderRequest request,
          java.lang.String namespace)



          Derived classes override to insert header content for a page,
 called only when beginPage() has not been called on some instance of
 AbstractRenderer for this request.



protected  void
beginPage(java.io.PrintWriter out,
          RenderRequest request,
          java.lang.String namespace)



          Derived classes override to insert header content for a page,
 called only when beginPage() has not been called on some instance of
 AbstractRenderer for this request.



protected  void
beginWindow(java.io.OutputStream out,
            RenderRequest request,
            java.lang.String namespace)



          Derived classes override to insert header content before a portlet
 has been rendered.



protected  void
beginWindow(java.io.PrintWriter out,
            RenderRequest request,
            java.lang.String namespace)



          Derived classes override to insert header content before a portlet
 has been rendered.



protected  PortletURL
createControlURL(RenderRequest request)



          Create a PortletURL for a control, such as a link to change the window
 state or portlet mode.



protected  void
endPage(java.io.OutputStream out,
        RenderRequest request,
        java.lang.String namespace)



          Derived classes override to insert footer content for a page,
 called from  only when beginPage() has been called for the Window.



protected  void
endPage(java.io.PrintWriter out,
        RenderRequest request,
        java.lang.String namespace)



          Derived classes override to insert footer content for a page,
 called from  only when beginPage() has been called for the Window.



protected  void
endWindow(java.io.OutputStream out,
          RenderRequest request,
          java.lang.String namespace)



          Derived classes override to append footer content after a portlet
 has been rendered.



protected  void
endWindow(java.io.PrintWriter out,
          RenderRequest request,
          java.lang.String namespace)



          Derived classes override to append footer content after a portlet
 has been rendered.



 void
finish(java.io.OutputStream out,
       RenderRequest request,
       java.lang.String namespace,
       boolean isDiscarded)



          Finish with an OutputStream produced by this factory.



 void
finish(java.io.PrintWriter out,
       RenderRequest request,
       java.lang.String namespace,
       boolean isDiscarded)



          Finish with a Writer produced by this factory.



 int
getBufferSize()



           



protected  java.lang.String
getContentType(RenderRequest request)



          Return the content type to use for the response.



 java.lang.String
getDefaultContentType()



          If Renderer.isAlwaysWrite() or Renderer.isAlwaysStream() is true, then a
 Writer or OutputStream might be obtained before the content type of the
 response has been set.



protected  java.util.Locale
getLocale(RenderRequest request)



          Return the locale to use for the response.



 java.io.OutputStream
getOutputStream(java.io.OutputStream out,
                RenderRequest request,
                java.lang.String namespace)



          Return an OutputStream that wraps the passed OutputStream, or null
 if there is no specialized writer for this request.



protected  PortletConfig
getPortletConfig(RenderRequest request)



          Get the PortletConfig for the portlet being rendered.



protected  java.util.Set<PortletMode>
getPortletModes(RenderRequest request)



          Return an Set of the possible portlet modes that the window can
 have.



protected  RenderResponse
getRenderResponse(RenderRequest request)



          Get the RenderResponse for the portlet being rendered.



protected  java.util.ResourceBundle
getResourceBundle(RenderRequest request)



          Get a resource bundle for the portlet being rendered.



protected  java.lang.String
getShortTitle(RenderRequest request)



          Return the short title for the window, or null if a title is not
 available.



protected  java.lang.String
getTitle(RenderRequest request)



          Return the title for the window, or null if it has not been set.



protected  java.util.Set<WindowState>
getWindowStates(RenderRequest request)



          Return an Set of the possible window states that the window can
 have.



 java.io.PrintWriter
getWriter(java.io.PrintWriter out,
          RenderRequest request,
          java.lang.String namespace)



          Return a Writer that wraps the passed PrintWriter, or null
 if there is no specialized writer for this request.



 boolean
isAlwaysStream()



          If true the portal will always call getOutputStream(), even if the portlet
 does not call getOutputStream(), unless getWriter() has been called.



 boolean
isAlwaysWrite()



          If true the portal will always call getWriter(), even if the portlet does
 not call getWriter(), unless getOutputStream() has been called.



 boolean
isPortletModeAllowed(PortletRequest request,
                     PortletMode portletMode)



          Return true if the WindowState is allowed.



 boolean
isWindowStateAllowed(PortletRequest request,
                     WindowState windowState)



          Return true if the WindowState is allowed.



protected  java.io.PrintWriter
printEscaped(java.io.PrintWriter out,
             java.lang.CharSequence string)



          Print a string with appropriate escaping for XML, for example '<'
 becomes '&lt;'.



 void
setAlwaysStream(boolean isAlwaysStream)



          If true the portal will always call getOutputStream(), even if the portlet
 does not call getOutputStream(), unless getWriter() has been called.



 void
setAlwaysWrite(boolean isAlwaysWrite)



          If true the portal will always call getWriter(), even if the portlet does
 not call getWriter(), unless getOutputStream() has been called.



 void
setBufferSize(int bufferSize)



          The default is -1, which allows the portal to choose a buffer size.



 void
setDecorateWindow(boolean isDecorateWindow)



          If true beginWindow() and endWindow() are always called, if false never
 called, the default is to call beginWindow() and endWindow() unless
 beginPage() and endPage() are called.



 void
setDefaultContentType(java.lang.String defaultContentType)



          The default content type used if isAlwaysWrite()
 or isAlwaysStream() is true and a 
 Writer or OutputStream is obtained before the content type of the
 response has been set, default is "text/html".


 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 





Field Detail



PAGE_HEADER_RENDERED
public static final java.lang.String PAGE_HEADER_RENDERED


See Also:
Constant Field Values




log
protected static final java.util.logging.Logger log








Constructor Detail



AbstractRenderer
public AbstractRenderer()






Method Detail



setDecorateWindow
public void setDecorateWindow(boolean isDecorateWindow)

If true beginWindow() and endWindow() are always called, if false never
 called, the default is to call beginWindow() and endWindow() unless
 beginPage() and endPage() are called.











setAlwaysWrite
public void setAlwaysWrite(boolean isAlwaysWrite)

If true the portal will always call getWriter(), even if the portlet does
 not call getWriter(), unless getOutputStream() has been called.

 The default is true.











setAlwaysStream
public void setAlwaysStream(boolean isAlwaysStream)

If true the portal will always call getOutputStream(), even if the portlet
 does not call getOutputStream(), unless getWriter() has been called.

 The default is false.











setDefaultContentType
public void setDefaultContentType(java.lang.String defaultContentType)

The default content type used if isAlwaysWrite()
 or isAlwaysStream() is true and a 
 Writer or OutputStream is obtained before the content type of the
 response has been set, default is "text/html".











setBufferSize
public void setBufferSize(int bufferSize)

The default is -1, which allows the portal to choose a buffer size.
 0 disables buffering of the renderer output.











isWindowStateAllowed
public boolean isWindowStateAllowed(PortletRequest request,
                                    WindowState windowState)

Return true if the WindowState is allowed.

 portletRequest.getResponseContentType() can be used
 if the allowed window states is dependent on the mime type of the
 response.

 The default is to return true.


Specified by:
isWindowStateAllowed in interface Renderer








isPortletModeAllowed
public boolean isPortletModeAllowed(PortletRequest request,
                                    PortletMode portletMode)

Return true if the WindowState is allowed.

 portletRequest.getResponseContentType() can be used
 if the allowed portlet modes is dependent on the mime type of the
 response.

 The default is to return true.


Specified by:
isPortletModeAllowed in interface Renderer








isAlwaysWrite
public boolean isAlwaysWrite()

Description copied from interface: Renderer
If true the portal will always call getWriter(), even if the portlet does
 not call getWriter(), unless getOutputStream() has been called.


Specified by:
isAlwaysWrite in interface Renderer








isAlwaysStream
public boolean isAlwaysStream()

Description copied from interface: Renderer
If true the portal will always call getOutputStream(), even if the portlet
 does not call getOutputStream(), unless getWriter() has been called.


Specified by:
isAlwaysStream in interface Renderer








getDefaultContentType
public java.lang.String getDefaultContentType()

Description copied from interface: Renderer
If Renderer.isAlwaysWrite() or Renderer.isAlwaysStream() is true, then a
 Writer or OutputStream might be obtained before the content type of the
 response has been set.  IF that is the case, then this method is called to
 detrmine a default content type.


Specified by:
getDefaultContentType in interface Renderer








getBufferSize
public int getBufferSize()


Specified by:
getBufferSize in interface Renderer








getWriter
public java.io.PrintWriter getWriter(java.io.PrintWriter out,
                                     RenderRequest request,
                                     java.lang.String namespace)
                              throws java.io.IOException

Return a Writer that wraps the passed PrintWriter, or null
 if there is no specialized writer for this request.

 This implementation calls beginPage() if needed and beginWindow()
 before returning the writer.


Specified by:
getWriter in interface Renderer



Throws:
java.io.IOException





beginPage
protected void beginPage(java.io.PrintWriter out,
                         RenderRequest request,
                         java.lang.String namespace)
                  throws java.io.IOException

Derived classes override to insert header content for a page,
 called only when beginPage() has not been called on some instance of
 AbstractRenderer for this request.






Throws:
java.io.IOException





beginWindow
protected void beginWindow(java.io.PrintWriter out,
                           RenderRequest request,
                           java.lang.String namespace)
                    throws java.io.IOException

Derived classes override to insert header content before a portlet
 has been rendered.






Throws:
java.io.IOException





endWindow
protected void endWindow(java.io.PrintWriter out,
                         RenderRequest request,
                         java.lang.String namespace)
                  throws java.io.IOException

Derived classes override to append footer content after a portlet
 has been rendered.






Throws:
java.io.IOException





endPage
protected void endPage(java.io.PrintWriter out,
                       RenderRequest request,
                       java.lang.String namespace)
                throws java.io.IOException

Derived classes override to insert footer content for a page,
 called from  only when beginPage() has been called for the Window.






Throws:
java.io.IOException





finish
public void finish(java.io.PrintWriter out,
                   RenderRequest request,
                   java.lang.String namespace,
                   boolean isDiscarded)
            throws java.io.IOException

Finish with a Writer produced by this factory.
 This may be called even if the writer threw an Exception.

 This implementation calls endWindow() and endPage() if needed.


Specified by:
finish in interface Renderer


isDiscarded - true if the portal discarded the output.
 Output is discarded when the portal wishes to discard any output
 that has been made for the window, with the intention that the
 window should not be rendered at all.
Throws:
java.io.IOException





getOutputStream
public java.io.OutputStream getOutputStream(java.io.OutputStream out,
                                            RenderRequest request,
                                            java.lang.String namespace)
                                     throws java.io.IOException

Return an OutputStream that wraps the passed OutputStream, or null
 if there is no specialized writer for this request.


Specified by:
getOutputStream in interface Renderer



Throws:
java.io.IOException





beginPage
protected void beginPage(java.io.OutputStream out,
                         RenderRequest request,
                         java.lang.String namespace)
                  throws java.io.IOException

Derived classes override to insert header content for a page,
 called only when beginPage() has not been called on some instance of
 AbstractRenderer for this request.

 request.getResponseContentType() can be used
 to determine the content type.

 request.getAttribute("javax.portlet.title") may contain a title
 for the Window, if the portlet has set one.






Throws:
java.io.IOException





beginWindow
protected void beginWindow(java.io.OutputStream out,
                           RenderRequest request,
                           java.lang.String namespace)
                    throws java.io.IOException

Derived classes override to insert header content before a portlet
 has been rendered.

 request.getResponseContentType() is used
 to determine the content type.

 request.getAttribute("javax.portlet.title") may contain a title
 for the Window, if the portlet has set one.






Throws:
java.io.IOException





endWindow
protected void endWindow(java.io.OutputStream out,
                         RenderRequest request,
                         java.lang.String namespace)
                  throws java.io.IOException

Derived classes override to append footer content after a portlet
 has been rendered.

 request.getResponseContentType() can be used
 to determine the content type.






Throws:
java.io.IOException





endPage
protected void endPage(java.io.OutputStream out,
                       RenderRequest request,
                       java.lang.String namespace)
                throws java.io.IOException

Derived classes override to insert footer content for a page,
 called from  only when beginPage() has been called for the Window.

 request.getResponseContentType() can be used
 to determine the content type.






Throws:
java.io.IOException





finish
public void finish(java.io.OutputStream out,
                   RenderRequest request,
                   java.lang.String namespace,
                   boolean isDiscarded)
            throws java.io.IOException

Finish with an OutputStream produced by this factory.
 This may be called even if the outputStream threw an Exception.

 This implementation calls endWindow() and endPage() if needed.


Specified by:
finish in interface Renderer



Throws:
java.io.IOException





getContentType
protected java.lang.String getContentType(RenderRequest request)

Return the content type to use for the response.











getLocale
protected java.util.Locale getLocale(RenderRequest request)

Return the locale to use for the response.











getTitle
protected java.lang.String getTitle(RenderRequest request)

Return the title for the window, or null if it has not been set.
 The title is the first of:
 

 
A title set by the portlet using response.setTitle()
     or request.setAttribute("javax.portlet.title");
 
The value of a lookup in the windows resource bundle for
     "javax.portlet.title" using the locale dertmined by
     getLocale(request).
 











getShortTitle
protected java.lang.String getShortTitle(RenderRequest request)

Return the short title for the window, or null if a title is not
 available.

 

 
A title set by the portlet using 
     request.setAttribute("javax.portlet.short-title");
 
A title set by the portlet using response.setTitle()
     or request.setAttribute("javax.portlet.title");
 
The value of a lookup in the windows resource bundle for
     "javax.portlet.short-title" using the locale determined by
     getLocale(request).
 
The value of a lookup in the windows resource bundle for
     "javax.portlet.title" using the locale determined by
     getLocale(request).
 











createControlURL
protected PortletURL createControlURL(RenderRequest request)

Create a PortletURL for a control, such as a link to change the window
 state or portlet mode.  Control URLs are render urls that maintain
 existing render parameters.











getPortletModes
protected java.util.Set<PortletMode> getPortletModes(RenderRequest request)

Return an Set of the possible portlet modes that the window can
 have.  The list of all possibilities is first obtained from 
 PortalContext.getSupportedPortletModes(). 
 Each one is checked with 
 request.isPortletModeAllowed(),
 if it is allowed then it is included in the returned Set.











getWindowStates
protected java.util.Set<WindowState> getWindowStates(RenderRequest request)

Return an Set of the possible window states that the window can
 have.  The list of all possibilities is first obtained from 
 PortalContext.getSupportedWindowStates(). 
 Each one is checked with 
 request.isWindowStateAllowed(),
 if it is allowed then it is included in the returned Set.











getResourceBundle
protected java.util.ResourceBundle getResourceBundle(RenderRequest request)

Get a resource bundle for the portlet being rendered.











getPortletConfig
protected PortletConfig getPortletConfig(RenderRequest request)

Get the PortletConfig for the portlet being rendered.











getRenderResponse
protected RenderResponse getRenderResponse(RenderRequest request)

Get the RenderResponse for the portlet being rendered.











printEscaped
protected java.io.PrintWriter printEscaped(java.io.PrintWriter out,
                                           java.lang.CharSequence string)

Print a string with appropriate escaping for XML, for example '<'
 becomes '&lt;'.