com.caucho.portal.alpharenderer
Class HtmlRenderer

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

All Implemented Interfaces:

Renderer

public class HtmlRenderer
extends AbstractRenderer

Preferences:

html.stylesheet

the css stylesheet to use, overrides the value set with setStylesheet()

ResourceBundle lookups:

portletMode.portletMode.title

The name to display when referring to the portletMode

portletMode.portletMode.shortDescription

A short description of the portlet mode

windowState.windowState.title

The name to display when referring to the windowState

windowState.windowState.shortDescription

A short description of the window state

Field Summary

protected static java.util.logging.Logger	log
static java.lang.String	PREFERENCE_STYLESHEET

Fields inherited from class com.caucho.portal.generic.AbstractRenderer

PAGE_HEADER_RENDERED

Constructor Summary

HtmlRenderer()

Method Summary

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.PrintWriter out, RenderRequest request, java.lang.String namespace) Derived classes override to insert header content before a portlet has been rendered.
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.PrintWriter out, RenderRequest request, java.lang.String namespace) Derived classes override to append footer content after a portlet has been rendered.
java.lang.String	getDoctype()
java.lang.String	getPageTitle()
Menu	getPortletModeMenu()
java.lang.String	getStylesheet()
Location	getTitleLocation()
Menu	getWindowStateMenu()
protected void	htmlPortletModeMenu(java.io.PrintWriter out, RenderRequest request, java.lang.String namespace, java.util.ResourceBundle resourceBundle)
protected void	htmlTitle(java.io.PrintWriter out, RenderRequest request, java.lang.String namespace, java.util.ResourceBundle resourceBundle)
protected void	htmlWindowStateMenu(java.io.PrintWriter out, RenderRequest request, java.lang.String namespace, java.util.ResourceBundle resourceBundle)
void	init()
boolean	isCompact()
protected void	printNewline(java.io.PrintWriter out)
void	setCompact(boolean compact) Set to true for compact output without newlines, default false.
void	setDoctype(java.lang.String doctype) The doctype.
void	setPageTitle(java.lang.String pageTitle) The title for the page, included in the html output as:
void	setPortletModeMenu(Menu portletModeMenu) Default is an instance of HtmlMenu
void	setStylesheet(java.lang.String stylesheet) The stylesheet to use, unless overridden with the portlet preference css.stylesheet.
void	setTitleLocation(java.lang.String titleLocation) Location to place the title of the portlet: "hidden", "frame", "header" (default), or "footer".
void	setWindowStateMenu(Menu windowStateMenu) Default is an instance of HtmlMenu

Methods inherited from class com.caucho.portal.generic.AbstractRenderer

beginPage, beginWindow, createControlURL, endPage, endWindow, finish, finish, getBufferSize, getContentType, getDefaultContentType, getLocale, getOutputStream, getPortletConfig, getPortletModes, getRenderResponse, getResourceBundle, getShortTitle, getTitle, getWindowStates, getWriter, isAlwaysStream, isAlwaysWrite, isPortletModeAllowed, isWindowStateAllowed, printEscaped, setAlwaysStream, setAlwaysWrite, setBufferSize, setDecorateWindow, setDefaultContentType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final java.util.logging.Logger log

PREFERENCE_STYLESHEET

public static final java.lang.String PREFERENCE_STYLESHEET

See Also:

Constant Field Values

Constructor Detail

HtmlRenderer

public HtmlRenderer()

Method Detail

setPageTitle

public void setPageTitle(java.lang.String pageTitle)

The title for the page, included in the html output as:

 <head>
   <title>pageTitle</title>
 </head>
 

getPageTitle

public java.lang.String getPageTitle()

setCompact

public void setCompact(boolean compact)

Set to true for compact output without newlines, default false.

isCompact

public boolean isCompact()

setDoctype

public void setDoctype(java.lang.String doctype)

The doctype. Default is html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transistional.dtd

getDoctype

public java.lang.String getDoctype()

setStylesheet

public void setStylesheet(java.lang.String stylesheet)

The stylesheet to use, unless overridden with the portlet preference css.stylesheet. Default is "/portal.css". .

getStylesheet

public java.lang.String getStylesheet()

setTitleLocation

public void setTitleLocation(java.lang.String titleLocation)

Location to place the title of the portlet: "hidden", "frame", "header" (default), or "footer".

getTitleLocation

public Location getTitleLocation()

setWindowStateMenu

public void setWindowStateMenu(Menu windowStateMenu)

Default is an instance of HtmlMenu

getWindowStateMenu

public Menu getWindowStateMenu()

setPortletModeMenu

public void setPortletModeMenu(Menu portletModeMenu)

Default is an instance of HtmlMenu

getPortletModeMenu

public Menu getPortletModeMenu()

init

public void init()

beginPage

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

Description copied from class: AbstractRenderer

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.

Overrides:

beginPage in class AbstractRenderer

Throws:

java.io.IOException

beginWindow

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

Description copied from class: AbstractRenderer

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

Overrides:

beginWindow in class AbstractRenderer

Throws:

java.io.IOException

endWindow

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

Description copied from class: AbstractRenderer

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

Overrides:

endWindow in class AbstractRenderer

Throws:

java.io.IOException

endPage

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

Description copied from class: AbstractRenderer

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

Overrides:

endPage in class AbstractRenderer

Throws:

java.io.IOException

printNewline

protected void printNewline(java.io.PrintWriter out)

htmlTitle

protected void htmlTitle(java.io.PrintWriter out,
                         RenderRequest request,
                         java.lang.String namespace,
                         java.util.ResourceBundle resourceBundle)
                  throws java.io.IOException

Throws:

java.io.IOException

htmlPortletModeMenu

protected void htmlPortletModeMenu(java.io.PrintWriter out,
                                   RenderRequest request,
                                   java.lang.String namespace,
                                   java.util.ResourceBundle resourceBundle)
                            throws java.io.IOException

Throws:

java.io.IOException

htmlWindowStateMenu

protected void htmlWindowStateMenu(java.io.PrintWriter out,
                                   RenderRequest request,
                                   java.lang.String namespace,
                                   java.util.ResourceBundle resourceBundle)
                            throws java.io.IOException

Throws:

java.io.IOException