Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class SearchLayout

java.lang.Object

com.aoapps.web.framework.WebPageLayout

com.aoapps.web.framework.SearchLayout

public class SearchLayout
extends WebPageLayout

The layout to be used during search sub-requests. Performs minimal writes of content only.

Author:

AO Industries, Inc.

Field Summary

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

DOWN, NONE, UP, UP_AND_DOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SearchLayout()

Method Summary

Modifier and Type	Method	Description
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.
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.
static SearchLayout	getInstance()
String	getName()	Each layout has a name.
protected <__ extends ScriptSupportingContent<__>> void	printJavascriptIncludes(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ content)
final <__ 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.
final <__ extends FlowContent<__>> boolean	printWebPageLayoutSelector(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ flow)	Prints the layout selector.
<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.

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

configureResources, 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, 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

Constructor Details

SearchLayout

protected SearchLayout()

Method Details

getInstance

public static SearchLayout getInstance()

startPage

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

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.

See Also:

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

endPage

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

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

See Also:

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

printSearchOutput

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

Description copied from class: WebPageLayout

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.

Overrides:

printSearchOutput in class WebPageLayout

See Also:

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

startContent

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

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[]).

contentTitle

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

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

startContentLine

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

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

contentVerticalDivider

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

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

endContentLine

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

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

contentHorizontalDivider

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

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

endContent

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

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

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

printWebPageLayoutSelector

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

Description copied from class: WebPageLayout

Prints the layout selector.

Overrides:

printWebPageLayoutSelector in class WebPageLayout

printJavascriptIncludes

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

Overrides:

printJavascriptIncludes in class WebPageLayout