Module com.aoindustries.web.struts

Package com.aoindustries.web.struts

Class Skin

java.lang.Object

com.aoindustries.web.struts.Skin

Direct Known Subclasses:

TextSkin

public abstract class Skin
extends Object

One look-and-feel for the website.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Skin.Language
static class	Skin.RequestListener	Resolves the current Skin and sets the request param Constants.SKIN.

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

Constructor	Description
Skin()

Method Summary

Modifier and Type	Method	Description
abstract void	beginPopup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId, long popupId, String width)	Begins a popup that is in a popup group.
abstract void	beginPopupGroup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId)	Begins a popup group.
void	configureResources(ServletContext servletContext, HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, Registry requestRegistry)	Configures the request-scope web resources that this skin uses.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	content(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc, int[] startContentColumnSpans, String width, int[] endContentColumnSpans, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc, int[] startContentColumnSpans, String width, int[] endContentColumnSpans, JspRunnableE<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(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc, int startContentColumns, String width, int endContentColumns, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc, int startContentColumns, String width, int endContentColumns, JspRunnableE<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(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc, JspRunnableE<Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final void	contentHorizontalDivider(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content)	Prints a horizontal divider.
abstract void	contentHorizontalDivider(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, int[] colspansAndDirections, boolean endsInternal)	Prints a horizontal divider of the provided colspans.
final void	contentHorizontalDivider(HttpServletRequest 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(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, int colspan, String align, String width, int endRowspan, boolean endsInternal, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, int colspan, String align, String width, int endRowspan, boolean endsInternal, JspRunnableE<Ex> contentLine)	Starts a content line, invokes the given line body, then ends the content line.
final <__ extends FlowContent<__>, Ex extends Throwable> void	contentLine(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, JspRunnableE<Ex> contentLine)	Starts a content line, invokes the given line body, then ends the content line.
final void	contentTitle(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, String title)	Prints an entire content line including the provided title.
abstract void	contentTitle(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, String title, int contentColumns)	Prints an entire content line including the provided title.
final void	contentTitle(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, ContentEE<?> content)	Prints an entire content line including the provided title.
final void	contentTitle(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, ContentEE<?> content, int contentColumns)	Prints an entire content line including the provided title.
final <__ extends FlowContent<__>> __	contentVerticalDivider(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> contentLine)	Ends one part of a line and starts the next.
abstract <__ extends FlowContent<__>> __	contentVerticalDivider(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> contentLine, boolean visible, 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(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, DocumentEE document, JspConsumerE<? super __,Ex> body)	Starts the page, invokes the given page body, then ends the page.
final <Ex extends Throwable> void	doPage(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, DocumentEE document, JspRunnableE<Ex> body)	Starts the page, invokes the given page body, then ends the page.
final void	endContent(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, ContentEE<?> content)	Ends the content area of a page.
final void	endContent(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, ContentEE<?> content, int contentColumns)	Ends the content area of a page.
abstract void	endContent(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, ContentEE<?> content, int[] contentColumnSpans)	Ends the content area of a page.
final void	endContentLine(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> contentLine)	Ends one line of content.
abstract void	endContentLine(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> contentLine, int rowspan, boolean endsInternal)	Ends one line of content.
abstract void	endLightArea(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> lightArea)	Ends a lighter area of the site.
abstract void	endPage(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, FlowContent<?> flow)	Writes all of the HTML following the content of the page.
abstract void	endPopup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId, long popupId, String width)	Ends a popup that is in a popup group.
abstract void	endPopupGroup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId)	Ends a popup group.
abstract void	endWhiteArea(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> whiteArea)	Ends a white area of the site.
static Skin	getDefaultSkin(List<Skin> skins, ServletRequest req)	Gets the default skin from the provided list for the provided request.
static String	getDefaultUrlBase(HttpServletRequest req)	Deprecated, for removal: This API element is subject to removal in a future version. Please use HttpServletUtil.getAbsoluteURL(javax.servlet.http.HttpServletRequest, java.lang.String) as HttpServletUtil.getAbsoluteURL(req, "/").
abstract String	getDisplay(HttpServletRequest req, HttpServletResponse resp)	Gets the display value for this skin in the response locale.
abstract String	getName()	Gets the name of this skin.
static Skin	getSkin(SiteSettings settings, ServletRequest req)	Gets the skin for the current request.
static Skin	getSkin(ServletRequest req)	Gets the skin for the current request while resolving site settings.
String	getUrlBase(HttpServletRequest req)	Gets the prefix for URLs for the server.
final <PC extends FlowContent<PC>, __ extends FlowContent<__>, Ex extends Throwable> void	lightArea(HttpServletRequest req, HttpServletResponse resp, PC pc, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, PC pc, JspRunnableE<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(HttpServletRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap, JspRunnableE<Ex> lightArea)	Begins a light area, invokes the given area body, then ends the light area.
static <__ extends Union_Metadata_Phrasing<__>> void	printAlternativeLinks(HttpServletRequest req, HttpServletResponse resp, __ head, String fullPath, List<Skin.Language> languages)	Prints the links to the alternate translations of this page.
abstract void	printAutoIndex(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, DocumentEE document)	Prints the auto index of all the page siblings.
abstract void	printPopupClose(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId, long popupId)	Prints a popup close link/image/button for a popup that is part of a popup group.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	startContent(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc)	Starts the content area of a page.
abstract <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	startContent(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc, int[] contentColumnSpans, String width)	Starts the content area of a page.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	startContent(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, PC pc, int contentColumns, String width)	Starts the content area of a page.
final <__ extends FlowContent<__>> __	startContentLine(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content)	Starts one line of content with the initial colspan set to the provided colspan.
abstract <__ extends FlowContent<__>> __	startContentLine(HttpServletRequest 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(HttpServletRequest req, HttpServletResponse resp, PC pc)	Begins a lighter colored area of the site.
abstract <PC extends FlowContent<PC>, __ extends FlowContent<__>> __	startLightArea(HttpServletRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap)	Begins a lighter colored area of the site.
abstract <__ extends FlowContent<__>> __	startPage(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, DocumentEE document)	Writes all of the HTML preceding the content of the page.
final <PC extends FlowContent<PC>, __ extends FlowContent<__>> __	startWhiteArea(HttpServletRequest req, HttpServletResponse resp, PC pc)	Begins a white area of the site.
abstract <PC extends FlowContent<PC>, __ extends FlowContent<__>> __	startWhiteArea(HttpServletRequest 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(HttpServletRequest req, HttpServletResponse resp, PC pc, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, PC pc, JspRunnableE<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(HttpServletRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap, JspConsumerE<? 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(HttpServletRequest req, HttpServletResponse resp, PC pc, String align, String width, boolean nowrap, JspRunnableE<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

Skin

public Skin()

Method Details

getDefaultSkin

public static Skin getDefaultSkin(List<Skin> skins,
 ServletRequest req)

Gets the default skin from the provided list for the provided request. Blackberry and Lynx will default to TextSkin.NAME if in the list, otherwise the first skin is selected.

getSkin

public static Skin getSkin(SiteSettings settings,
 ServletRequest req)

Gets the skin for the current request.

1. If the skin is already set in the request attribute Constants.SKIN, uses the current setting.
2. If the parameter Constants.LAYOUT exists, it will get the class name for the skin from the servlet parameters and set the skin.
3. If the parameter Constants.LAYOUT doesn't exist and a skin has been selected, then it returns the current skin.
4. Sets the skin from the servlet parameters.
5. Sets the Constants.LAYOUT in the session.
6. Stores the skin in request attribute Constants.SKIN.

getSkin

public static Skin getSkin(ServletRequest req)

Gets the skin for the current request while resolving site settings.

See Also:

• SiteSettings.getInstance(javax.servlet.ServletContext)
• getSkin(com.aoindustries.web.struts.SiteSettings, javax.servlet.ServletRequest)

printAlternativeLinks

public static <__ extends Union_Metadata_Phrasing<__>>
void printAlternativeLinks(HttpServletRequest req,
 HttpServletResponse resp,
 __ head,
 String fullPath,
 List<Skin.Language> languages)
                    throws IOException

Prints the links to the alternate translations of this page. https://support.google.com/webmasters/answer/189077?hl=en

Throws:

IOException

getName

public abstract String getName()

Gets the name of this skin.

getDisplay

public abstract String getDisplay(HttpServletRequest req,
 HttpServletResponse resp)
                           throws JspException

Gets the display value for this skin in the response locale.

Throws:

JspException

getDefaultUrlBase

@Deprecated(forRemoval=true)
public static String getDefaultUrlBase(HttpServletRequest req)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use HttpServletUtil.getAbsoluteURL(javax.servlet.http.HttpServletRequest, java.lang.String) as HttpServletUtil.getAbsoluteURL(req, "/").

Gets the prefix for URLs for the non-SSL server. This should always end with a /.

getUrlBase

public String getUrlBase(HttpServletRequest req)
                  throws JspException

Gets the prefix for URLs for the server. This should always end with a /.

Throws:

JspException

configureResources

public void configureResources(ServletContext servletContext,
 HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 Registry requestRegistry)

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

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

startPage

public abstract <__ extends FlowContent<__>> __ startPage(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 DocumentEE document)
                                                   throws JspException,
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.

Returns:

The FlowContent that should be used to write the page contents. This is also given to endPage(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) to finish the template.

Throws:

JspException

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(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 FlowContent<?> flow)
                      throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.DocumentEE).

Throws:

JspException

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(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 DocumentEE document,
 JspConsumerE<? super __,Ex> body)
     throws JspException,
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:

JspException

IOException

Ex

See Also:

• startPage(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.DocumentEE)
• endPage(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, 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(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 DocumentEE document,
 JspRunnableE<Ex> body)
                                         throws JspException,
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:

JspException

IOException

Ex

See Also:

• startPage(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.DocumentEE)
• endPage(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent)
• SerializationEE.get(javax.servlet.ServletContext, javax.servlet.http.HttpServletRequest)
• DoctypeEE.get(javax.servlet.ServletContext, javax.servlet.ServletRequest)

startContent

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>>
__ startContent(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc)
         throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String, int), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int), startContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, boolean), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int[], boolean), endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE), endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int), and endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int[]).

Throws:

JspException

IOException

startContent

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>>
__ startContent(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 int contentColumns,
 String width)
         throws JspException,
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 - TODO: When null, will use (TODO 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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String, int), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int), startContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, boolean), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int[], boolean), endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE), endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int), and endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int[]).

Throws:

JspException

IOException

startContent

public abstract <PC extends FlowContent<PC>,
__ extends ContentEE<__>>
__ startContent(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 int[] contentColumnSpans,
 String width)
         throws JspException,
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 - TODO: When null, will use (TODO 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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String, int), contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int), startContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), startContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, boolean), contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int[], boolean), endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE), endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int), and endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int[]).

Throws:

JspException

IOException

contentTitle

public final void contentTitle(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 ContentEE<?> content)
                        throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

contentTitle

public final void contentTitle(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 ContentEE<?> content,
 int contentColumns)
                        throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

contentTitle

public final void contentTitle(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 String title)
                        throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

contentTitle

public abstract void contentTitle(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 String title,
 int contentColumns)
                           throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

startContentLine

public final <__ extends FlowContent<__>> __ startContentLine(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content)
                                                       throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, 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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), contentVerticalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, boolean, int, int, java.lang.String, java.lang.String), endContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and endContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

JspException

IOException

startContentLine

public abstract <__ extends FlowContent<__>> __ startContentLine(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 String align,
 String width)
                                                          throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, 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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), contentVerticalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, boolean, int, int, java.lang.String, java.lang.String), endContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and endContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

JspException

IOException

contentVerticalDivider

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

Ends one part of a line and starts the next.

Parameters:

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

Throws:

JspException

IOException

contentVerticalDivider

public abstract <__ extends FlowContent<__>> __ contentVerticalDivider(HttpServletRequest req,
 HttpServletResponse resp,
 FlowContent<?> contentLine,
 boolean visible,
 int colspan,
 int rowspan,
 String align,
 String width)
                                                                throws JspException,
IOException

Ends one part of a line and starts the next.

Parameters:

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

Throws:

JspException

IOException

endContentLine

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

Ends one line of content.

Parameters:

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

Throws:

JspException

IOException

endContentLine

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

Ends one line of content.

Parameters:

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

Throws:

JspException

IOException

contentLine

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void contentLine(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 JspConsumerE<? super __,Ex> contentLine)
          throws JspException,
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:

JspException

IOException

Ex

See Also:

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

contentLine

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void contentLine(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 JspRunnableE<Ex> contentLine)
          throws JspException,
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:

JspException

IOException

Ex

See Also:

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

contentLine

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void contentLine(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 String align,
 String width,
 int endRowspan,
 boolean endsInternal,
 JspConsumerE<? super __,Ex> contentLine)
          throws JspException,
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:

JspException

IOException

Ex

See Also:

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

contentLine

public final <__ extends FlowContent<__>,
Ex extends Throwable>
void contentLine(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 String align,
 String width,
 int endRowspan,
 boolean endsInternal,
 JspRunnableE<Ex> contentLine)
          throws JspException,
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:

JspException

IOException

Ex

See Also:

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

contentHorizontalDivider

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

Prints a horizontal divider.

Parameters:

content - The ContentEE that was returned by startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

contentHorizontalDivider

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

Prints a horizontal divider of the provided colspan.

Parameters:

content - The ContentEE that was returned by startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

contentHorizontalDivider

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

Prints a horizontal divider of the provided colspans.

Parameters:

content - The ContentEE that was returned by startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

endContent

public final void endContent(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 ContentEE<?> content)
                      throws JspException,
IOException

Ends the content area of a page.

Parameters:

content - The ContentEE that was returned by startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

endContent

public final void endContent(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 ContentEE<?> content,
 int contentColumns)
                      throws JspException,
IOException

Ends the content area of a page.

Parameters:

content - The ContentEE that was returned by startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

endContent

public abstract void endContent(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 ContentEE<?> content,
 int[] contentColumnSpans)
                         throws JspException,
IOException

Ends the content area of a page.

Parameters:

content - The ContentEE that was returned by startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String) or startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String).

Throws:

JspException

IOException

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 JspConsumerE<? super __,Ex> content)
      throws JspException,
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:

JspException

IOException

Ex

See Also:

• startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent)
• endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE)

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 JspRunnableE<Ex> content)
      throws JspException,
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:

JspException

IOException

Ex

See Also:

• startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent)
• endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE)

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 int startContentColumns,
 String width,
 int endContentColumns,
 JspConsumerE<? super __,Ex> content)
      throws JspException,
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:

JspException

IOException

Ex

See Also:

• startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String)
• endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int)

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 int startContentColumns,
 String width,
 int endContentColumns,
 JspRunnableE<Ex> content)
      throws JspException,
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:

JspException

IOException

Ex

See Also:

• startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int, java.lang.String)
• endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int)

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 int[] startContentColumnSpans,
 String width,
 int[] endContentColumnSpans,
 JspConsumerE<? super __,Ex> content)
      throws JspException,
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:

JspException

IOException

Ex

See Also:

• startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String)
• endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int[])

content

public final <PC extends FlowContent<PC>,
__ extends ContentEE<__>,
Ex extends Throwable>
void content(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 int[] startContentColumnSpans,
 String width,
 int[] endContentColumnSpans,
 JspRunnableE<Ex> content)
      throws JspException,
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:

JspException

IOException

Ex

See Also:

• startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent, int[], java.lang.String)
• endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int[])

startLightArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>>
__ startLightArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc)
           throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

JspException

IOException

startLightArea

public abstract <PC extends FlowContent<PC>,
__ extends FlowContent<__>>
__ startLightArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap)
           throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

JspException

IOException

endLightArea

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

Ends a lighter area of the site.

Parameters:

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

Throws:

JspException

IOException

lightArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>,
Ex extends Throwable>
void lightArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 JspConsumerE<? super __,Ex> lightArea)
        throws JspException,
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:

JspException

IOException

Ex

See Also:

• startLightArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endLightArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

lightArea

public final <PC extends FlowContent<PC>,
Ex extends Throwable>
void lightArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 JspRunnableE<Ex> lightArea)
        throws JspException,
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:

JspException

IOException

Ex

See Also:

• startLightArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endLightArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

lightArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>,
Ex extends Throwable>
void lightArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap,
 JspConsumerE<? super __,Ex> lightArea)
        throws JspException,
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:

JspException

IOException

Ex

See Also:

• startLightArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, java.lang.String, java.lang.String, boolean)
• endLightArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

lightArea

public final <PC extends FlowContent<PC>,
Ex extends Throwable>
void lightArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap,
 JspRunnableE<Ex> lightArea)
        throws JspException,
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:

JspException

IOException

Ex

See Also:

• startLightArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, java.lang.String, java.lang.String, boolean)
• endLightArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

startWhiteArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>>
__ startWhiteArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc)
           throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

JspException

IOException

startWhiteArea

public abstract <PC extends FlowContent<PC>,
__ extends FlowContent<__>>
__ startWhiteArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap)
           throws JspException,
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(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) to finish the area.

Throws:

JspException

IOException

endWhiteArea

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

Ends a white area of the site.

Parameters:

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

Throws:

JspException

IOException

whiteArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>,
Ex extends Throwable>
void whiteArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 JspConsumerE<? super __,Ex> whiteArea)
        throws JspException,
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:

JspException

IOException

Ex

See Also:

• startWhiteArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endWhiteArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

whiteArea

public final <PC extends FlowContent<PC>,
Ex extends Throwable>
void whiteArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 JspRunnableE<Ex> whiteArea)
        throws JspException,
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:

JspException

IOException

Ex

See Also:

• startWhiteArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• endWhiteArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

whiteArea

public final <PC extends FlowContent<PC>,
__ extends FlowContent<__>,
Ex extends Throwable>
void whiteArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap,
 JspConsumerE<? super __,Ex> whiteArea)
        throws JspException,
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:

JspException

IOException

Ex

See Also:

• startWhiteArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, java.lang.String, java.lang.String, boolean)
• endWhiteArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

whiteArea

public final <PC extends FlowContent<PC>,
Ex extends Throwable>
void whiteArea(HttpServletRequest req,
 HttpServletResponse resp,
 PC pc,
 String align,
 String width,
 boolean nowrap,
 JspRunnableE<Ex> whiteArea)
        throws JspException,
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:

JspException

IOException

Ex

See Also:

• startWhiteArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, java.lang.String, java.lang.String, boolean)
• endWhiteArea(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)

printAutoIndex

public abstract void printAutoIndex(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 DocumentEE document)
                             throws JspException,
IOException

Prints the auto index of all the page siblings.

Throws:

JspException

IOException

beginPopupGroup

public abstract void beginPopupGroup(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId)
                              throws JspException,
IOException

Begins a popup group.

Throws:

JspException

IOException

endPopupGroup

public abstract void endPopupGroup(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId)
                            throws JspException,
IOException

Ends a popup group.

Throws:

JspException

IOException

beginPopup

public abstract void beginPopup(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId,
 long popupId,
 String width)
                         throws JspException,
IOException

Begins a popup that is in a popup group.

Throws:

JspException

IOException

printPopupClose

public abstract void printPopupClose(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId,
 long popupId)
                              throws JspException,
IOException

Prints a popup close link/image/button for a popup that is part of a popup group.

Throws:

JspException

IOException

endPopup

public abstract void endPopup(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId,
 long popupId,
 String width)
                       throws JspException,
IOException

Ends a popup that is in a popup group.

Throws:

JspException

IOException