Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class TextOnlyLayout

java.lang.Object

com.aoapps.web.framework.WebPageLayout

com.aoapps.web.framework.TextOnlyLayout

public class TextOnlyLayout
extends WebPageLayout

The default text-only layout.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextOnlyLayout.Initializer	Registers the text layout styles in RegistryEE.

Field Summary

Fields

Modifier and Type	Field	Description
static final Style	LAYOUT_TEXT_CSS
static final String	NAME
static final Group.Name	RESOURCE_GROUP	The name of the application-scope group that will be used for text layout web resources.

Fields inherited from class com.aoapps.web.framework.WebPageLayout

DOWN, NONE, UP, UP_AND_DOWN

Constructor Summary

Constructors

Constructor	Description
TextOnlyLayout(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.
void	contentHorizontalDivider(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, int[] colspansAndDirections, boolean endsInternal)	Prints a horizontal divider of the provided colspans.
void	contentTitle(WebSiteRequest req, HttpServletResponse resp, ContentEE<?> content, String title, int contentColumns)	Prints an entire content line including the provided title.
<__ 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.
void	endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int[] contentColumnSpans)	Ends the content area of a page.
protected void	endContentCopyright(WebSiteRequest req, HttpServletResponse resp, WebPage page, TABLE_c<DocumentEE> table, int totalColumns)
void	endContentLine(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> contentLine, int rowspan, boolean endsInternal)	Ends one line of content.
void	endLightArea(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> lightArea)	Ends a lighter area of the site.
void	endPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, FlowContent<?> flow)	Writes all of the HTML following the content of the page.
void	endWhiteArea(WebSiteRequest req, HttpServletResponse resp, FlowContent<?> whiteArea)	Ends a white area of the site.
WebPage[]	getCommonPages(WebPage page, WebSiteRequest req)
String	getGoogleAnalyticsNewTrackingCode(ServletContext servletContext)	Gets the Google Analytics 4 (GA4) Measurement ID or null if unavailable.
String	getName()	Each layout has a name.
<__ extends FlowContent<__>> void	printBelowRelatedPages(__ td, WebSiteRequest req)	Prints content below the related pages area on the left.
<__ extends FlowContent<__>> void	printLogo(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ td)
<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.
<__ 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.
<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.
<__ extends FlowContent<__>> __	startPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload)	Writes all of the HTML preceding the content of the page.
<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.
static void	writeBodyColorStyle(WebPageLayout layout, WebSiteRequest req, HEAD__<?> head)	Writes the body color CSS stylesheet, if needed.

Methods inherited from class com.aoapps.web.framework.WebPageLayout

content, content, content, content, content, content, contentHorizontalDivider, contentHorizontalDivider, contentLine, contentLine, contentLine, contentLine, contentTitle, contentTitle, contentTitle, contentVerticalDivider, doPage, doPage, endContent, endContent, endContentLine, getActiveLinkColor, getBackgroundColor, getLayoutChoices, getLinkColor, getTextColor, getVisitedLinkColor, lightArea, lightArea, lightArea, lightArea, printJavascriptIncludes, printSearchOutput, printWebPageLayoutSelector, startContent, startContent, startContentLine, startLightArea, startWhiteArea, whiteArea, whiteArea, whiteArea, whiteArea

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

RESOURCE_GROUP

public static final Group.Name RESOURCE_GROUP

The name of the application-scope group that will be used for text layout web resources.

LAYOUT_TEXT_CSS

public static final Style LAYOUT_TEXT_CSS

Constructor Details

TextOnlyLayout

public TextOnlyLayout(String[] layoutChoices)

Method Details

configureResources

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

Description copied from class: WebPageLayout

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.

Overrides:

configureResources in class WebPageLayout

writeBodyColorStyle

public static void writeBodyColorStyle(WebPageLayout layout,
 WebSiteRequest req,
 HEAD__<?> head)
                                throws IOException

Writes the body color CSS stylesheet, if needed.

Throws:

IOException

startPage

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

Description copied from class: WebPageLayout

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.

Specified by:

startPage in class WebPageLayout

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 WebPageLayout.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)

getGoogleAnalyticsNewTrackingCode

public String getGoogleAnalyticsNewTrackingCode(ServletContext servletContext)

Gets the Google Analytics 4 (GA4) Measurement ID or null if unavailable.

endPage

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

Description copied from class: WebPageLayout

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.

Specified by:

endPage in class WebPageLayout

Parameters:

flow - The FlowContent that was returned by WebPageLayout.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)

startContent

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

Description copied from class: WebPageLayout

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

Specified by:

startContent in class WebPageLayout

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 WebPageLayout.contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String), WebPageLayout.contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE), WebPageLayout.contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String, int), WebPageLayout.contentTitle(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int), WebPageLayout.startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), WebPageLayout.startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), WebPageLayout.contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), WebPageLayout.contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, boolean), WebPageLayout.contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int[], boolean), WebPageLayout.endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE), WebPageLayout.endContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.ContentEE, int), and WebPageLayout.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 void contentTitle(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 String title,
 int contentColumns)
                  throws ServletException,
IOException

Description copied from class: WebPageLayout

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

Specified by:

contentTitle in class WebPageLayout

Parameters:

content - The ContentEE that was returned by WebPageLayout.startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) WebPageLayout.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 WebPageLayout.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 <__ extends FlowContent<__>> __ startContentLine(WebSiteRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 String align,
 String width)
                                                 throws ServletException,
IOException

Description copied from class: WebPageLayout

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

Specified by:

startContentLine in class WebPageLayout

Type Parameters:

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

Parameters:

content - The ContentEE that was returned by WebPageLayout.startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) WebPageLayout.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 WebPageLayout.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 WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String), WebPageLayout.endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and WebPageLayout.endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

ServletException

IOException

contentVerticalDivider

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

Description copied from class: WebPageLayout

Ends one part of a line and starts the next.

Specified by:

contentVerticalDivider in class WebPageLayout

Parameters:

contentLine - The FlowContent that was returned by WebPageLayout.startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), WebPageLayout.startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), or WebPageLayout.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 WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String), WebPageLayout.endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and WebPageLayout.endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

ServletException

IOException

endContentLine

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

Description copied from class: WebPageLayout

Ends one line of content.

Specified by:

endContentLine in class WebPageLayout

Parameters:

contentLine - The FlowContent that was returned by WebPageLayout.startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), WebPageLayout.startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), or WebPageLayout.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

contentHorizontalDivider

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

Description copied from class: WebPageLayout

Prints a horizontal divider of the provided colspans.

Specified by:

contentHorizontalDivider in class WebPageLayout

Parameters:

content - The ContentEE that was returned by WebPageLayout.startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) WebPageLayout.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 WebPageLayout.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 void endContent(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 ContentEE<?> content,
 int[] contentColumnSpans)
                throws ServletException,
IOException

Description copied from class: WebPageLayout

Ends the content area of a page.

Specified by:

endContent in class WebPageLayout

Parameters:

content - The ContentEE that was returned by WebPageLayout.startContent(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.FlowContent) WebPageLayout.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 WebPageLayout.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

endContentCopyright

protected void endContentCopyright(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 TABLE_c<DocumentEE> table,
 int totalColumns)
                            throws ServletException,
IOException

Throws:

ServletException

IOException

startLightArea

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

Description copied from class: WebPageLayout

Begins a lighter colored area of the site.

Specified by:

startLightArea in class WebPageLayout

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 WebPageLayout.endLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

ServletException

IOException

endLightArea

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

Description copied from class: WebPageLayout

Ends a lighter area of the site.

Specified by:

endLightArea in class WebPageLayout

Parameters:

lightArea - The FlowContent that was returned by WebPageLayout.startLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) or WebPageLayout.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

startWhiteArea

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

Description copied from class: WebPageLayout

Begins a white area of the site.

Specified by:

startWhiteArea in class WebPageLayout

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 WebPageLayout.endWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

ServletException

IOException

endWhiteArea

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

Description copied from class: WebPageLayout

Ends a white area of the site.

Specified by:

endWhiteArea in class WebPageLayout

Parameters:

whiteArea - The FlowContent that was returned by WebPageLayout.startWhiteArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) or WebPageLayout.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

getName

public String getName()

Description copied from class: WebPageLayout

Each layout has a name.

Specified by:

getName in class WebPageLayout

getCommonPages

public WebPage[] getCommonPages(WebPage page,
 WebSiteRequest req)
                         throws ServletException

Throws:

ServletException

printLogo

public <__ extends FlowContent<__>> void printLogo(WebSiteRequest req,
 HttpServletResponse resp,
 WebPage page,
 __ td)
                                            throws ServletException,
IOException

Throws:

ServletException

IOException

printBelowRelatedPages

public <__ extends FlowContent<__>> void printBelowRelatedPages(__ td,
 WebSiteRequest req)
                                                         throws ServletException,
IOException

Prints content below the related pages area on the left.

Throws:

ServletException

IOException