freenet.clients.http

Class PageMaker.RenderParameters

java.lang.Object

freenet.clients.http.PageMaker.RenderParameters

Enclosing class:

PageMaker

public static class PageMaker.RenderParameters
extends java.lang.Object

Bundles parameters that are used to create the page node. The default for the render parameters is to include all optional render tasks. Individual tasks may be enabled or disabled by calling the appropriate methods which returns a new PageMaker.RenderParameters object as PageMaker.RenderParameters are immutable.

See Also:

PageMaker.getPageNode(String, ToadletContext, RenderParameters)

Constructor Summary

Constructors

Constructor and Description
RenderParameters() Creates default render parameters that include all elements.

Method Summary

Modifier and Type	Method and Description
boolean	isRenderModeSwitch() Returns whether the mode switch should be included in the page.
boolean	isRenderNavigationLinks() Returns whether the navigation links should be included in the page.
boolean	isRenderStatus() Returns whether the status bar should be included in the page.
PageMaker.RenderParameters	renderModeSwitch(boolean renderModeSwitch) Returns a new PageMaker.RenderParameters object that renders the mode switch according to the given parameter.
PageMaker.RenderParameters	renderNavigationLinks(boolean renderNavigationLinks) Returns a new PageMaker.RenderParameters object that renders the navigation links according to the given parameter.
PageMaker.RenderParameters	renderStatus(boolean renderStatus) Returns a new PageMaker.RenderParameters object that renders the status bar according to the given parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderParameters

public RenderParameters()

Creates default render parameters that include all elements.

Method Detail

isRenderNavigationLinks

public boolean isRenderNavigationLinks()

Returns whether the navigation links should be included in the page.

Returns:

true if the navigation links should be included in the page, false otherwise

renderNavigationLinks

public PageMaker.RenderParameters renderNavigationLinks(boolean renderNavigationLinks)

Returns a new PageMaker.RenderParameters object that renders the navigation links according to the given parameter.

Parameters:

renderNavigationLinks - true to render the navigation links, false otherwise

Returns:

A new PageMaker.RenderParameters object

isRenderStatus

public boolean isRenderStatus()

Returns whether the status bar should be included in the page.

Returns:

true if the status bar should be included in the page, false otherwise

renderStatus

public PageMaker.RenderParameters renderStatus(boolean renderStatus)

Returns a new PageMaker.RenderParameters object that renders the status bar according to the given parameter.

Parameters:

renderStatus - true to render the status bar, false otherwise

Returns:

A new PageMaker.RenderParameters object

isRenderModeSwitch

public boolean isRenderModeSwitch()

Returns whether the mode switch should be included in the page.

Returns:

true if the mode switch should be included in the page, false otherwise

renderModeSwitch

public PageMaker.RenderParameters renderModeSwitch(boolean renderModeSwitch)

Returns a new PageMaker.RenderParameters object that renders the mode switch according to the given parameter.

Parameters:

renderModeSwitch - true to render the mode switch, false otherwise

Returns:

A new PageMaker.RenderParameters object