freenet.clients.http

Class PageMaker

java.lang.Object

freenet.clients.http.PageMaker

public final class PageMaker
extends java.lang.Object

Simple class to output standard heads and tail for web interface pages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PageMaker.RenderParameters Bundles parameters that are used to create the page node.
static class	PageMaker.THEME

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_ADVANCED
static int	MODE_SIMPLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PageMaker(PageMaker.THEME t, Node n)

Method Summary

Modifier and Type	Method and Description
void	addNavigationCategory(java.lang.String link, java.lang.String name, java.lang.String title, FredPluginL10n plugin)
void	addNavigationCategory(java.lang.String link, java.lang.String name, java.lang.String title, FredPluginL10n plugin, int menuOffset) Add a navigation category to the menu at a given offset.
void	addNavigationLink(java.lang.String menutext, java.lang.String path, java.lang.String name, java.lang.String title, boolean fullOnly, LinkEnabledCallback cb, FredPluginL10n l10n)
boolean	advancedMode(HTTPRequest req, ToadletContainer container)
HTMLNode	createBackLink(ToadletContext toadletContext, java.lang.String name)
static java.lang.String	filterCSSIdentifier(java.lang.String input) Filters a given string so that it will be a valid CSS identifier.
InfoboxNode	getInfobox(HTMLNode header)
InfoboxNode	getInfobox(HTMLNode header, java.lang.String title, boolean isUnique)
InfoboxNode	getInfobox(java.lang.String header)
InfoboxNode	getInfobox(java.lang.String category, HTMLNode header)
InfoboxNode	getInfobox(java.lang.String category, HTMLNode header, java.lang.String title, boolean isUnique) Returns an infobox with the given style and header.
InfoboxNode	getInfobox(java.lang.String category, java.lang.String header)
InfoboxNode	getInfobox(java.lang.String header, java.lang.String title, boolean isUnique)
HTMLNode	getInfobox(java.lang.String category, java.lang.String header, HTMLNode parent)
HTMLNode	getInfobox(java.lang.String category, java.lang.String header, HTMLNode parent, java.lang.String title, boolean isUnique) Create an infobox, attach it to the given parent, and return the content node.
InfoboxNode	getInfobox(java.lang.String category, java.lang.String header, java.lang.String title, boolean isUnique)
PageNode	getPageNode(java.lang.String title, boolean renderNavigationLinks, boolean renderStatus, ToadletContext ctx) Deprecated. Use getPageNode(String, ToadletContext, RenderParameters) instead
PageNode	getPageNode(java.lang.String title, boolean renderNavigationLinks, ToadletContext ctx) Deprecated. Use getPageNode(String, ToadletContext, RenderParameters) instead
PageNode	getPageNode(java.lang.String title, ToadletContext ctx) Generates an FProxy template page suitable for adding content to.
PageNode	getPageNode(java.lang.String title, ToadletContext ctx, PageMaker.RenderParameters renderParameters) Generates an FProxy template page suitable for adding content to.
static java.lang.String	getPluginL10nCSSIdentifier(FredPluginL10n plugin, java.lang.String key) Create a CSS identifier incorporating both a class name and a localization key.
PageMaker.THEME	getTheme()
int	parseMode(HTTPRequest req, ToadletContainer container) Call this before getPageNode(), so the menus reflect the advanced mode setting.
void	removeNavigationCategory(java.lang.String name)
void	removeNavigationLink(java.lang.String menutext, java.lang.String name) Remove a navigation link from a sub-menu.
void	setTheme(PageMaker.THEME theme2)

Methods inherited from class java.lang.Object

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

Field Detail

MODE_SIMPLE

public static final int MODE_SIMPLE

See Also:

Constant Field Values

MODE_ADVANCED

public static final int MODE_ADVANCED

See Also:

Constant Field Values

Constructor Detail

PageMaker

protected PageMaker(PageMaker.THEME t,
                    Node n)

Method Detail

setTheme

public void setTheme(PageMaker.THEME theme2)

addNavigationCategory

public void addNavigationCategory(java.lang.String link,
                                  java.lang.String name,
                                  java.lang.String title,
                                  FredPluginL10n plugin)

addNavigationCategory

public void addNavigationCategory(java.lang.String link,
                                  java.lang.String name,
                                  java.lang.String title,
                                  FredPluginL10n plugin,
                                  int menuOffset)

Add a navigation category to the menu at a given offset.

Parameters:

menuOffset - The position of the link in FProxy's menu. 0 = left.

removeNavigationCategory

public void removeNavigationCategory(java.lang.String name)

addNavigationLink

public void addNavigationLink(java.lang.String menutext,
                              java.lang.String path,
                              java.lang.String name,
                              java.lang.String title,
                              boolean fullOnly,
                              LinkEnabledCallback cb,
                              FredPluginL10n l10n)

removeNavigationLink

public void removeNavigationLink(java.lang.String menutext,
                                 java.lang.String name)

Remove a navigation link from a sub-menu. Applies globally, do not use this to customise menus when sending one page!

createBackLink

public HTMLNode createBackLink(ToadletContext toadletContext,
                               java.lang.String name)

getPageNode

public PageNode getPageNode(java.lang.String title,
                            ToadletContext ctx)

Generates an FProxy template page suitable for adding content to.

Parameters:

title - Title of the page.

ctx - ToadletContext to use to render the page.

Returns:

A template PageNode.

getPageNode

@Deprecated
public PageNode getPageNode(java.lang.String title,
                                        boolean renderNavigationLinks,
                                        ToadletContext ctx)

Deprecated. Use getPageNode(String, ToadletContext, RenderParameters) instead

Generates an FProxy template page with optional navigation bar suitable for adding content to.

Parameters:

title - Title of the page.

renderNavigationLinks - Whether to render navigation links.

ctx - ToadletContext to use to render the page.

Returns:

A template PageNode.

getPageNode

@Deprecated
public PageNode getPageNode(java.lang.String title,
                                        boolean renderNavigationLinks,
                                        boolean renderStatus,
                                        ToadletContext ctx)

Deprecated. Use getPageNode(String, ToadletContext, RenderParameters) instead

Generates an FProxy template page with optional navigation bar and status information suitable for adding content to.

Parameters:

title - Title of the page.

renderNavigationLinks - Whether to render navigation links.

renderStatus - Whether to render the status display.

ctx - ToadletContext to use to render the page.

Returns:

A template PageNode.

getPageNode

public PageNode getPageNode(java.lang.String title,
                            ToadletContext ctx,
                            PageMaker.RenderParameters renderParameters)

Generates an FProxy template page suitable for adding content to.

Parameters:

title - Title of the page.

ctx - ToadletContext to use to render the page. Can be null, e.g. if the HTML is not being generated as part of a toadlet request, for example if it's using the old FredPluginHTTP interface.

renderParameters - Parameters for inclusion or omission of certain page elements

Returns:

A template PageNode.

getPluginL10nCSSIdentifier

public static java.lang.String getPluginL10nCSSIdentifier(FredPluginL10n plugin,
                                                          java.lang.String key)

Create a CSS identifier incorporating both a class name and a localization key.

Parameters:

plugin - plugin localization instance (used for class name)

key - localization key

Returns:

valid CSS identifier.

filterCSSIdentifier

public static java.lang.String filterCSSIdentifier(java.lang.String input)

Filters a given string so that it will be a valid CSS identifier. It replaces all characters that are not a dash, underscore, or alphanumeric with an underscore. If the first character is a dash and the second character is not a letter or underscore, replaces the second character with an underscore. This filter is overly strict as it does not allow non-ASCII characters or escapes. If the given string is below two characters in length, it appends underscores until it is not.

Parameters:

input - string to filter

Returns:

a filtered string guaranteed to be a syntactically valid CSS identifier.

getTheme

public PageMaker.THEME getTheme()

getInfobox

public InfoboxNode getInfobox(java.lang.String header)

getInfobox

public InfoboxNode getInfobox(HTMLNode header)

getInfobox

public InfoboxNode getInfobox(java.lang.String category,
                              java.lang.String header)

getInfobox

public HTMLNode getInfobox(java.lang.String category,
                           java.lang.String header,
                           HTMLNode parent)

getInfobox

public InfoboxNode getInfobox(java.lang.String category,
                              HTMLNode header)

getInfobox

public InfoboxNode getInfobox(java.lang.String header,
                              java.lang.String title,
                              boolean isUnique)

getInfobox

public InfoboxNode getInfobox(HTMLNode header,
                              java.lang.String title,
                              boolean isUnique)

getInfobox

public InfoboxNode getInfobox(java.lang.String category,
                              java.lang.String header,
                              java.lang.String title,
                              boolean isUnique)

getInfobox

public HTMLNode getInfobox(java.lang.String category,
                           java.lang.String header,
                           HTMLNode parent,
                           java.lang.String title,
                           boolean isUnique)

Create an infobox, attach it to the given parent, and return the content node.

getInfobox

public InfoboxNode getInfobox(java.lang.String category,
                              HTMLNode header,
                              java.lang.String title,
                              boolean isUnique)

Returns an infobox with the given style and header.

Parameters:

category - The CSS styles, separated by a space (' ')

header - The header HTML node

Returns:

The infobox

advancedMode

public boolean advancedMode(HTTPRequest req,
                            ToadletContainer container)

parseMode

public int parseMode(HTTPRequest req,
                     ToadletContainer container)

Call this before getPageNode(), so the menus reflect the advanced mode setting.