Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class WebPageLayout

java.lang.Object

com.aoapps.web.framework.WebPageLayout

Direct Known Subclasses:

SearchLayout, TextOnlyLayout

public abstract class WebPageLayout
extends Object

A WebPageLayout controls how a WebPage looks while providing a little isolation from the code that provides the functionality.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DOWN	Directional references.
static final int	NONE	Directional references.
static final int	UP	Directional references.
static final int	UP_AND_DOWN	Directional references.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebPageLayout(String[] layoutChoices)

Method Summary

Modifier and Type	Method	Description
void	configureResources(ServletContext servletContext, WebSiteRequest req, HttpServletResponse resp, WebPage page, Registry requestRegistry)	Configures the request-scope web resources that this layout uses.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int[] startContentColumnSpans, String width, int[] endContentColumnSpans, ServletConsumerE<? super __,Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int[] startContentColumnSpans, String width, int[] endContentColumnSpans, ServletRunnableE<Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int startContentColumns, String width, int endContentColumns, ServletConsumerE<? super __,Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int startContentColumns, String width, int endContentColumns, ServletRunnableE<Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, ServletConsumerE<? super __,Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, ServletRunnableE<Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final void	contentHorizontalDivider(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content)	Prints a horizontal divider.
abstract void	contentHorizontalDivider(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, int[] colspansAndDirections, boolean endsInternal)	Prints a horizontal divider of the provided colspans.
final void	contentHorizontalDivider(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, int colspan, boolean endsInternal)	Prints a horizontal divider of the provided colspan.
final <__ extends FlowContent<__>, Ex extends Throwable> void	contentLine(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, int colspan, String align, String width, int endRowspan, boolean endsInternal, ServletConsumerE<? super __,Ex> contentLine)	Starts a content line, invokes the given line body, then ends the content line.
final <__ extends FlowContent<__>, Ex extends Throwable> void	contentLine(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, int colspan, String align, String width, int endRowspan, boolean endsInternal, ServletRunnableE<Ex> contentLine)	Starts a content line, invokes the given line body, then ends the content line.
final <__ extends FlowContent<__>, Ex extends Throwable> void	contentLine(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, ServletConsumerE<? super __,Ex> contentLine)	Starts a content line, invokes the given line body, then ends the content line.
final <__ extends FlowContent<__>, Ex extends Throwable> void	contentLine(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, ServletRunnableE<Ex> contentLine)	Starts a content line, invokes the given line body, then ends the content line.
final void	contentTitle(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, String title)	Prints an entire content line including the provided title.
abstract void	contentTitle(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, String title, int contentColumns)	Prints an entire content line including the provided title.
final void	contentTitle(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content)	Prints an entire content line including the provided title.
final void	contentTitle(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int contentColumns)	Prints an entire content line including the provided title.
final <__ extends FlowContent<__>> __	contentVerticalDivider(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> contentLine)	Ends one part of a line and starts the next.
abstract <__ extends FlowContent<__>> __	contentVerticalDivider(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> contentLine, int direction, int colspan, int rowspan, String align, String width)	Ends one part of a line and starts the next.
final <__ extends FlowContent<__>, Ex extends Throwable> void	doPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload, ServletConsumerE<? super __,Ex> body)	Starts the page, invokes the given page body, then ends the page.
final <Ex extends Throwable> void	doPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload, ServletRunnableE<Ex> body)	Starts the page, invokes the given page body, then ends the page.
final void	endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content)	Ends the content area of a page.
final void	endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int contentColumns)	Ends the content area of a page.
abstract void	endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int[] contentColumnSpans)	Ends the content area of a page.
final void	endContentLine(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> contentLine)	Ends one line of content.
abstract void	endContentLine(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> contentLine, int rowspan, boolean endsInternal)	Ends one line of content.
abstract void	endLightArea(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> lightArea)	Ends a lighter area of the site.
abstract void	endPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, FlowContent<?> flow)	Writes all of the HTML following the content of the page.
abstract void	endWhiteArea(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> whiteArea)	Ends a white area of the site.
int	getActiveLinkColor(WebSiteRequest req)	The active link color for the page or -1 for browser default.
int	getBackgroundColor(WebSiteRequest req)	The background color for the page or -1 for browser default.
final String[]	getLayoutChoices()	Gets the names of every supported layout.
int	getLinkColor(WebSiteRequest req)	The link color for the page or -1 for browser default.
abstract String	getName()	Each layout has a name.
int	getTextColor(WebSiteRequest req)	The text color for the page or -1 for browser default.
int	getVisitedLinkColor(WebSiteRequest req)	The visited link color for the page or -1 for browser default.
final <PC extends FlowContent<PC>, __ extends FlowContent<__>, Ex extends Throwable> void	lightArea(WebSiteRequest req, HttpServletResponse resp, PC pc, ServletConsumerE<? super __,Ex> lightArea)	Begins a light area, invokes the given area body, then ends the light area.
final <PC extends FlowContent<PC>, Ex extends Throwable> void	lightArea(WebSiteRequest req, HttpServletResponse resp, PC pc, ServletRunnableE<Ex> lightArea)	Begins a light area, invokes the given area body, then ends the light area.
final <PC extends FlowContent<PC>, __ extends FlowContent<__>, Ex extends Throwable> void	lightArea(WebSiteRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap, ServletConsumerE<? super __,Ex> lightArea)	Begins a light area, invokes the given area body, then ends the light area.
final <PC extends FlowContent<PC>, Ex extends Throwable> void	lightArea(WebSiteRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap, ServletRunnableE<Ex> lightArea)	Begins a light area, invokes the given area body, then ends the light area.
protected <__ extends ScriptSupportingContent<__>> void	printJavascriptIncludes(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ content)
<__ extends FlowContent<__>> void	printSearchOutput(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ flow, String query, boolean isEntireSite, List<SearchResult> results, String[] words)	Prints the content HTML that shows the output of a search.
<__ extends FlowContent<__>> boolean	printWebPageLayoutSelector(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ flow)	Prints the layout selector.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	startContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc)	Starts the content area of a page.
abstract <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	startContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int[] contentColumnSpans, String width)	Starts the content area of a page.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	startContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int contentColumns, String width)	Starts the content area of a page.
final <__ extends FlowContent<__>> __	startContentLine(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content)	Starts one line of content with the initial colspan set to the provided colspan.
abstract <__ extends FlowContent<__>> __	startContentLine(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, int colspan, String align, String width)	Starts one line of content with the initial colspan set to the provided colspan.
final <PC extends FlowContent<PC>, __ extends FlowContent<__>> __	startLightArea(WebSiteRequest req, HttpServletResponse resp, PC pc)	Begins a lighter colored area of the site.
abstract <PC extends FlowContent<PC>, __ extends FlowContent<__>> __	startLightArea(WebSiteRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap)	Begins a lighter colored area of the site.
abstract <__ extends FlowContent<__>> __	startPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload)	Writes all of the HTML preceding the content of the page.
final <PC extends FlowContent<PC>, __ extends FlowContent<__>> __	startWhiteArea(WebSiteRequest req, HttpServletResponse resp, PC pc)	Begins a white area of the site.
abstract <PC extends FlowContent<PC>, __ extends FlowContent<__>> __	startWhiteArea(WebSiteRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap)	Begins a white area of the site.
final <PC extends FlowContent<PC>, __ extends FlowContent<__>, Ex extends Throwable> void	whiteArea(WebSiteRequest req, HttpServletResponse resp, PC pc, ServletConsumerE<? super __,Ex> whiteArea)	Begins a white area, invokes the given area body, then ends the white area.
final <PC extends FlowContent<PC>, Ex extends Throwable> void	whiteArea(WebSiteRequest req, HttpServletResponse resp, PC pc, ServletRunnableE<Ex> whiteArea)	Begins a white area, invokes the given area body, then ends the white area.
final <PC extends FlowContent<PC>, __ extends FlowContent<__>, Ex extends Throwable> void	whiteArea(WebSiteRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap, ServletConsumerE<? super __,Ex> whiteArea)	Begins a white area, invokes the given area body, then ends the white area.
final <PC extends FlowContent<PC>, Ex extends Throwable> void	whiteArea(WebSiteRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap, ServletRunnableE<Ex> whiteArea)	Begins a white area, invokes the given area body, then ends the white area.

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final int NONE

Directional references.

See Also:

• Constant Field Values

UP

public static final int UP

Directional references.

See Also:

• Constant Field Values

DOWN

public static final int DOWN

Directional references.

See Also:

• Constant Field Values

UP_AND_DOWN

public static final int UP_AND_DOWN

Directional references.

See Also:

• Constant Field Values

Constructor Details

WebPageLayout

protected WebPageLayout(String[] layoutChoices)

Method Details

getLayoutChoices

public final String[] getLayoutChoices()

Gets the names of every supported layout. The layout at index 0 is the default. Is an empty array during a search.

Returns:

No defensive copy is made

configureResources

public void configureResources(ServletContext servletContext,
 WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 Registry requestRegistry)

Configures the request-scope web resources that this layout uses.

Implementers should call super.configureResources(…) as a matter of convention, despite this default implementation doing nothing.

printWebPageLayoutSelector

public <__ extends FlowContent<__>> boolean printWebPageLayoutSelector(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 __ flow)
                                                                throws ServletException,
IOException

Prints the layout selector.

Throws:

ServletException

IOException

startPage

public abstract <__ extends FlowContent<__>> __ startPage(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 DocumentEE document,
 String onload)
                                                   throws ServletException,
IOException

Writes all of the HTML preceding the content of the page.

Both the Serialization and Doctype may have been set on the request, and these must be considered in the HTML generation.

Parameters:

onload - The onload script. When null, the page's default onload is used.

Returns:

The FlowContent that should be used to write the page contents. This is also given to endPage(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) to finish the template.

Throws:

ServletException

IOException

See Also:

• SerializationEE.get(javax.servlet.ServletContext, javax.servlet.http.HttpServletRequest)
• DoctypeEE.get(javax.servlet.ServletContext, javax.servlet.ServletRequest)

endPage

public abstract void endPage(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 FlowContent<?> flow)
                      throws ServletException,
IOException

Writes all of the HTML following the content of the page.

Both the Serialization and Doctype may have been set on the request, and these must be considered in the HTML generation.

Parameters:

flow - The FlowContent that was returned by startPage(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.DocumentEE, java.lang.String).

Throws:

ServletException

IOException

See Also:

• SerializationEE.get(javax.servlet.ServletContext, javax.servlet.http.HttpServletRequest)
• DoctypeEE.get(javax.servlet.ServletContext, javax.servlet.ServletRequest)

doPage

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void doPage(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 DocumentEE document,
 String onload,
 ServletConsumerE<? super __,Ex> body)
     throws ServletException,
IOException,
Ex

Starts the page, invokes the given page body, then ends the page.

Both the Serialization and Doctype may have been set on the request, and these must be considered in the HTML generation.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startPage(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.DocumentEE, java.lang.String)
• endPage(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent)
• SerializationEE.get(javax.servlet.ServletContext, javax.servlet.http.HttpServletRequest)
• DoctypeEE.get(javax.servlet.ServletContext, javax.servlet.ServletRequest)

doPage

public final <Ex extends Throwable> void doPage(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 DocumentEE document,
 String onload,
 ServletRunnableE<Ex> body)
                                         throws ServletException,
IOException,
Ex

Starts the page, invokes the given page body, then ends the page.

Both the Serialization and Doctype may have been set on the request, and these must be considered in the HTML generation.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startPage(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.DocumentEE, java.lang.String)
• endPage(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent)
• SerializationEE.get(javax.servlet.ServletContext, javax.servlet.http.HttpServletRequest)
• DoctypeEE.get(javax.servlet.ServletContext, javax.servlet.ServletRequest)

printSearchOutput

public <__ extends FlowContent<__>> void printSearchOutput(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 __ flow,
 String query,
 boolean isEntireSite,
 List<SearchResult> results,
 String[] words)
                                                    throws ServletException,
IOException

Prints the content HTML that shows the output of a search. This output must include an additional search form named WebPage.SEARCH_TWO, with two fields named WebSiteRequest.SEARCH_QUERY and WebSiteRequest.SEARCH_TARGET.

Throws:

ServletException

IOException

See Also:

• WebPage.doPostWithSearch(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse)

startContent

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>>
__ startContent(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc)
         throws ServletException,
IOException

Starts the content area of a page. The content area provides additional features such as a nice border, and vertical and horizontal dividers.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Returns:

The ContentEE that should be used to write the area contents. This is also given to contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String, int), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, boolean), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int[], boolean), endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE), endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int), and endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int[]).

Throws:

ServletException

IOException

startContent

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>>
__ startContent(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc,
 int contentColumns,
 String width)
         throws ServletException,
IOException

Starts the content area of a page. The content area provides additional features such as a nice border, and vertical and horizontal dividers.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Parameters:

width - When null, will use page's preferred width, if any. When "", will force no width specified.

Returns:

The ContentEE that should be used to write the area contents. This is also given to contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String, int), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, boolean), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int[], boolean), endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE), endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int), and endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int[]).

Throws:

ServletException

IOException

startContent

public abstract <PC extends FlowContent<PC>,
__ extends ContentEE<__>>
__ startContent(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc,
 int[] contentColumnSpans,
 String width)
         throws ServletException,
IOException

Starts the content area of a page. The content area provides additional features such as a nice border, and vertical and horizontal dividers.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Parameters:

width - When null, will use page's preferred width, if any. When "", will force no width specified.

Returns:

The ContentEE that should be used to write the area contents. This is also given to contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String, int), contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, boolean), contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int[], boolean), endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE), endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int), and endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int[]).

Throws:

ServletException

IOException

contentTitle

public final void contentTitle(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 ContentEE<?> content)
                        throws ServletException,
IOException

Prints an entire content line including the provided title. The colspan should match the total colspan in startContent for proper appearance

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

contentTitle

public final void contentTitle(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 ContentEE<?> content,
 int contentColumns)
                        throws ServletException,
IOException

Prints an entire content line including the provided title. The colspan should match the total colspan in startContent for proper appearance

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

contentTitle

public final void contentTitle(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 String title)
                        throws ServletException,
IOException

Prints an entire content line including the provided title. The colspan should match the total colspan in startContent for proper appearance

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

contentTitle

public abstract void contentTitle(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 String title,
 int contentColumns)
                           throws ServletException,
IOException

Prints an entire content line including the provided title. The colspan should match the total colspan in startContent for proper appearance

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

startContentLine

public final <__ extends FlowContent<__>> __ startContentLine(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content)
                                                       throws ServletException,
IOException

Starts one line of content with the initial colspan set to the provided colspan.

Type Parameters:

__ - This content model, which will be the parent content model of child elements

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Returns:

The FlowContent that should be used to write the line contents. This is also given to contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String), endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

ServletException

IOException

startContentLine

public abstract <__ extends FlowContent<__>> __ startContentLine(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 String align,
 String width)
                                                          throws ServletException,
IOException

Starts one line of content with the initial colspan set to the provided colspan.

Type Parameters:

__ - This content model, which will be the parent content model of child elements

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Returns:

The FlowContent that should be used to write the line contents. This is also given to contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String), endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

ServletException

IOException

contentVerticalDivider

public final <__ extends FlowContent<__>> __ contentVerticalDivider(WebSiteRequest req,
 HttpServletResponse resp,
 FlowContent<?> contentLine)
                                                             throws ServletException,
IOException

Ends one part of a line and starts the next.

Parameters:

contentLine - The FlowContent that was returned by startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), or contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String).

Returns:

The FlowContent that should be used to write the line contents. This is also given to contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String), endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

ServletException

IOException

contentVerticalDivider

public abstract <__ extends FlowContent<__>> __ contentVerticalDivider(WebSiteRequest req,
 HttpServletResponse resp,
 FlowContent<?> contentLine,
 int direction,
 int colspan,
 int rowspan,
 String align,
 String width)
                                                                throws ServletException,
IOException

Ends one part of a line and starts the next.

Parameters:

contentLine - The FlowContent that was returned by startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), or contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String).

Returns:

The FlowContent that should be used to write the line contents. This is also given to contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String), endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

ServletException

IOException

endContentLine

public final void endContentLine(WebSiteRequest req,
 HttpServletResponse resp,
 FlowContent<?> contentLine)
                          throws ServletException,
IOException

Ends one line of content.

Parameters:

contentLine - The FlowContent that was returned by startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), or contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String).

Throws:

ServletException

IOException

endContentLine

public abstract void endContentLine(WebSiteRequest req,
 HttpServletResponse resp,
 FlowContent<?> contentLine,
 int rowspan,
 boolean endsInternal)
                             throws ServletException,
IOException

Ends one line of content.

Parameters:

contentLine - The FlowContent that was returned by startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), or contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String).

Throws:

ServletException

IOException

contentLine

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void contentLine(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 ServletConsumerE<? super __,Ex> contentLine)
          throws ServletException,
IOException,
Ex

Starts a content line, invokes the given line body, then ends the content line.

Type Parameters:

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE)
• endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

contentLine

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void contentLine(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 ServletRunnableE<Ex> contentLine)
          throws ServletException,
IOException,
Ex

Starts a content line, invokes the given line body, then ends the content line.

Type Parameters:

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE)
• endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

contentLine

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void contentLine(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 String align,
 String width,
 int endRowspan,
 boolean endsInternal,
 ServletConsumerE<? super __,Ex> contentLine)
          throws ServletException,
IOException,
Ex

Starts a content line, invokes the given line body, then ends the content line.

Type Parameters:

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String)
• endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean)

contentLine

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void contentLine(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 String align,
 String width,
 int endRowspan,
 boolean endsInternal,
 ServletRunnableE<Ex> contentLine)
          throws ServletException,
IOException,
Ex

Starts a content line, invokes the given line body, then ends the content line.

Type Parameters:

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String)
• endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean)

contentHorizontalDivider

public final void contentHorizontalDivider(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content)
                                    throws ServletException,
IOException

Prints a horizontal divider.

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

contentHorizontalDivider

public final void contentHorizontalDivider(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 boolean endsInternal)
                                    throws ServletException,
IOException

Prints a horizontal divider of the provided colspan.

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

contentHorizontalDivider

public abstract void contentHorizontalDivider(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int[] colspansAndDirections,
 boolean endsInternal)
                                       throws ServletException,
IOException

Prints a horizontal divider of the provided colspans.

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

endContent

public final void endContent(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 ContentEE<?> content)
                      throws ServletException,
IOException

Ends the content area of a page.

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

endContent

public final void endContent(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 ContentEE<?> content,
 int contentColumns)
                      throws ServletException,
IOException

Ends the content area of a page.

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

endContent

public abstract void endContent(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 ContentEE<?> content,
 int[] contentColumnSpans)
                         throws ServletException,
IOException

Ends the content area of a page.

Parameters:

content - The ContentEE that was returned by startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

ServletException

IOException

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc,
 ServletConsumerE<? super __,Ex> content)
      throws ServletException,
IOException,
Ex

Starts a content area, invokes the given area body, then ends the content area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent)
• endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE)

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc,
 ServletRunnableE<Ex> content)
      throws ServletException,
IOException,
Ex

Starts a content area, invokes the given area body, then ends the content area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent)
• endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE)

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc,
 int startContentColumns,
 String width,
 int endContentColumns,
 ServletConsumerE<? super __,Ex> content)
      throws ServletException,
IOException,
Ex

Starts a content area, invokes the given area body, then ends the content area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String)
• endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int)

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc,
 int startContentColumns,
 String width,
 int endContentColumns,
 ServletRunnableE<Ex> content)
      throws ServletException,
IOException,
Ex

Starts a content area, invokes the given area body, then ends the content area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int, java.lang.String)
• endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int)

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc,
 int[] startContentColumnSpans,
 String width,
 int[] endContentColumnSpans,
 ServletConsumerE<? super __,Ex> content)
      throws ServletException,
IOException,
Ex

Starts a content area, invokes the given area body, then ends the content area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String)
• endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int[])

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 PC pc,
 int[] startContentColumnSpans,
 String width,
 int[] endContentColumnSpans,
 ServletRunnableE<Ex> content)
      throws ServletException,
IOException,
Ex

Starts a content area, invokes the given area body, then ends the content area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent, int[], java.lang.String)
• endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int[])

getBackgroundColor

public int getBackgroundColor(WebSiteRequest req)

The background color for the page or -1 for browser default.

getTextColor

public int getTextColor(WebSiteRequest req)

The text color for the page or -1 for browser default.

getLinkColor

public int getLinkColor(WebSiteRequest req)

The link color for the page or -1 for browser default.

getVisitedLinkColor

public int getVisitedLinkColor(WebSiteRequest req)

The visited link color for the page or -1 for browser default.

getActiveLinkColor

public int getActiveLinkColor(WebSiteRequest req)

The active link color for the page or -1 for browser default.

startLightArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>>
__ startLightArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc)
           throws ServletException,
IOException

Begins a lighter colored area of the site.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Returns:

The FlowContent that should be used to write the area contents. This is also given to endLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

ServletException

IOException

startLightArea

public abstract <PC extends FlowContent<PC>,
__ extends FlowContent<__>>
__ startLightArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap)
           throws ServletException,
IOException

Begins a lighter colored area of the site.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Returns:

The FlowContent that should be used to write the area contents. This is also given to endLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

ServletException

IOException

endLightArea

public abstract void endLightArea(WebSiteRequest req,
 HttpServletResponse resp,
 FlowContent<?> lightArea)
                           throws ServletException,
IOException

Ends a lighter area of the site.

Parameters:

lightArea - The FlowContent that was returned by startLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) or startLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, java.lang.String, java.lang.String, boolean).

Throws:

ServletException

IOException

lightArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>,
Ex extends Throwable>
void lightArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 ServletConsumerE<? super __,Ex> lightArea)
        throws ServletException,
IOException,
Ex

Begins a light area, invokes the given area body, then ends the light area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

lightArea

public final <PC extends FlowContent<PC>,
Ex extends Throwable>
void lightArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 ServletRunnableE<Ex> lightArea)
        throws ServletException,
IOException,
Ex

Begins a light area, invokes the given area body, then ends the light area.

Type Parameters:

PC - The parent content model this area is within

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

lightArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>,
Ex extends Throwable>
void lightArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap,
 ServletConsumerE<? super __,Ex> lightArea)
        throws ServletException,
IOException,
Ex

Begins a light area, invokes the given area body, then ends the light area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

lightArea

public final <PC extends FlowContent<PC>,
Ex extends Throwable>
void lightArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap,
 ServletRunnableE<Ex> lightArea)
        throws ServletException,
IOException,
Ex

Begins a light area, invokes the given area body, then ends the light area.

Type Parameters:

PC - The parent content model this area is within

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

startWhiteArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>>
__ startWhiteArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc)
           throws ServletException,
IOException

Begins a white area of the site.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Returns:

The FlowContent that should be used to write the area contents. This is also given to endWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

ServletException

IOException

startWhiteArea

public abstract <PC extends FlowContent<PC>,
__ extends FlowContent<__>>
__ startWhiteArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap)
           throws ServletException,
IOException

Begins a white area of the site.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Returns:

The FlowContent that should be used to write the area contents. This is also given to endWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

ServletException

IOException

endWhiteArea

public abstract void endWhiteArea(WebSiteRequest req,
 HttpServletResponse resp,
 FlowContent<?> whiteArea)
                           throws ServletException,
IOException

Ends a white area of the site.

Parameters:

whiteArea - The FlowContent that was returned by startWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) or startWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, java.lang.String, java.lang.String, boolean).

Throws:

ServletException

IOException

whiteArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>,
Ex extends Throwable>
void whiteArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 ServletConsumerE<? super __,Ex> whiteArea)
        throws ServletException,
IOException,
Ex

Begins a white area, invokes the given area body, then ends the white area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

whiteArea

public final <PC extends FlowContent<PC>,
Ex extends Throwable>
void whiteArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 ServletRunnableE<Ex> whiteArea)
        throws ServletException,
IOException,
Ex

Begins a white area, invokes the given area body, then ends the white area.

Type Parameters:

PC - The parent content model this area is within

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

whiteArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>,
Ex extends Throwable>
void whiteArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap,
 ServletConsumerE<? super __,Ex> whiteArea)
        throws ServletException,
IOException,
Ex

Begins a white area, invokes the given area body, then ends the white area.

Type Parameters:

PC - The parent content model this area is within

__ - This content model, which will be the parent content model of child elements

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

whiteArea

public final <PC extends FlowContent<PC>,
Ex extends Throwable>
void whiteArea(WebSiteRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap,
 ServletRunnableE<Ex> whiteArea)
        throws ServletException,
IOException,
Ex

Begins a white area, invokes the given area body, then ends the white area.

Type Parameters:

PC - The parent content model this area is within

Ex - An arbitrary exception type that may be thrown

Throws:

ServletException

IOException

Ex

See Also:

• startWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

getName

public abstract String getName()

Each layout has a name.

printJavascriptIncludes

protected <__ extends ScriptSupportingContent<__>>
void printJavascriptIncludes(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 __ content)
                      throws ServletException,
IOException

Throws:

ServletException

IOException