Module com.aoindustries.web.struts

Package com.aoindustries.web.struts

Class TextSkin

java.lang.Object

com.aoindustries.web.struts.Skin

com.aoindustries.web.struts.TextSkin

public class TextSkin
extends Skin

The skin for the home page of the site.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextSkin.Initializer	Registers the text skin styles in RegistryEE.

Nested classes/interfaces inherited from class com.aoindustries.web.struts.Skin

Skin.Language, Skin.RequestListener

Field Summary

Fields

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

Fields inherited from class com.aoindustries.web.struts.Skin

DOWN, NONE, UP, UP_AND_DOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextSkin()

Method Summary

Modifier and Type	Method	Description
void	beginPopup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId, long popupId, String width)	Begins a popup that is in a popup group.
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.
void	contentHorizontalDivider(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, int[] colspansAndDirections, boolean endsInternal)	Prints a horizontal divider of the provided colspans.
void	contentTitle(HttpServletRequest req, HttpServletResponse resp, ContentEE<?> content, String title, int contentColumns)	Prints an entire content line including the provided title.
<__ 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.
static void	defaultBeginPopup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId, long popupId, String width, String urlBase)	Default implementation of beginPopup.
static void	defaultBeginPopupGroup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId)	Default implementation of beginPopupGroup.
static void	defaultEndPopup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId, long popupId, String width, String urlBase)	Default implementation of endPopup.
static void	defaultEndPopupGroup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId)	Default implementation of endPopupGroup.
static <__ extends Union_Metadata_Phrasing<__>> void	defaultPrintLinks(ServletContext servletContext, HttpServletRequest req, HttpServletResponse resp, __ head, PageAttributes pageAttributes)
static void	defaultPrintPopupClose(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId, long popupId, String urlBase)	Default implementation of printPopupClose.
void	endContent(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, ContentEE<?> content, int[] contentColumnSpans)	Ends the content area of a page.
void	endContentLine(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> contentLine, int rowspan, boolean endsInternal)	Ends one line of content.
void	endLightArea(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> lightArea)	Ends a lighter area of the site.
void	endPage(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, FlowContent<?> flow)	Writes all of the HTML following the content of the page.
void	endPopup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId, long popupId, String width)	Ends a popup that is in a popup group.
void	endPopupGroup(HttpServletRequest req, HttpServletResponse resp, DocumentEE document, long groupId)	Ends a popup group.
void	endWhiteArea(HttpServletRequest req, HttpServletResponse resp, FlowContent<?> whiteArea)	Ends a white area of the site.
String	getDisplay(HttpServletRequest req, HttpServletResponse resp)	Gets the display value for this skin in the response locale.
static TextSkin	getInstance()
String	getName()	Gets the name of this skin.
void	printAutoIndex(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, DocumentEE document)	Prints the auto index of all the page siblings.
<__ extends FlowContent<__>> void	printBelowRelatedPages(HttpServletRequest req, __ td)	Prints content below the related pages area on the left.
<__ extends FlowContent<__>> void	printCommonPages(HttpServletRequest req, HttpServletResponse resp, __ td)	Prints the common pages area, which is at the top of the site.
<__ extends Union_Metadata_Phrasing<__>> void	printFavIcon(HttpServletRequest req, HttpServletResponse resp, __ head, String urlBase)	Prints the line for the favicon.
<__ extends ScriptSupportingContent<__>> void	printJavascriptSources(HttpServletRequest req, HttpServletResponse resp, __ head, String urlBase)	Prints the lines for any JavaScript sources.
<__ extends FlowContent<__>> void	printLogo(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, __ td, String urlBase)	Print the logo for the top left part of the page.
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.
<__ extends FlowContent<__>> void	printSearch(HttpServletRequest req, HttpServletResponse resp, __ div)	Prints the search form, if any exists.
<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.
<__ 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.
<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.
<__ extends FlowContent<__>> __	startPage(HttpServletRequest req, HttpServletResponse resp, PageAttributes pageAttributes, DocumentEE document)	Writes all of the HTML preceding the content of the page.
<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.

Methods inherited from class com.aoindustries.web.struts.Skin

content, content, content, content, content, content, contentHorizontalDivider, contentHorizontalDivider, contentLine, contentLine, contentLine, contentLine, contentTitle, contentTitle, contentTitle, contentVerticalDivider, doPage, doPage, endContent, endContent, endContentLine, getDefaultSkin, getDefaultUrlBase, getSkin, getSkin, getUrlBase, lightArea, lightArea, lightArea, lightArea, printAlternativeLinks, startContent, startContent, startContentLine, startLightArea, startWhiteArea, whiteArea, whiteArea, whiteArea, whiteArea

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

RESOURCE_GROUP

public static final Group.Name RESOURCE_GROUP

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

TEXTSKIN_CSS

public static final Style TEXTSKIN_CSS

Constructor Details

TextSkin

protected TextSkin()

Method Details

getInstance

public static TextSkin getInstance()

getName

public String getName()

Description copied from class: Skin

Gets the name of this skin.

Specified by:

getName in class Skin

getDisplay

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

Description copied from class: Skin

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

Specified by:

getDisplay in class Skin

Throws:

JspException

printLogo

public <__ extends FlowContent<__>> void printLogo(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 __ td,
 String urlBase)
                                            throws JspException,
IOException

Print the logo for the top left part of the page.

Throws:

JspException

IOException

printSearch

public <__ extends FlowContent<__>> void printSearch(HttpServletRequest req,
 HttpServletResponse resp,
 __ div)
                                              throws JspException,
IOException

Prints the search form, if any exists.

Throws:

JspException

IOException

printCommonPages

public <__ extends FlowContent<__>> void printCommonPages(HttpServletRequest req,
 HttpServletResponse resp,
 __ td)
                                                   throws JspException,
IOException

Prints the common pages area, which is at the top of the site.

Throws:

JspException

IOException

printJavascriptSources

public <__ extends ScriptSupportingContent<__>>
void printJavascriptSources(HttpServletRequest req,
 HttpServletResponse resp,
 __ head,
 String urlBase)
                     throws JspException,
IOException

Prints the lines for any JavaScript sources.

Throws:

JspException

IOException

printFavIcon

public <__ extends Union_Metadata_Phrasing<__>>
void printFavIcon(HttpServletRequest req,
 HttpServletResponse resp,
 __ head,
 String urlBase)
           throws JspException,
IOException

Prints the line for the favicon.

Throws:

JspException

IOException

configureResources

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

Description copied from class: Skin

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.

Overrides:

configureResources in class Skin

startPage

public <__ extends FlowContent<__>> __ startPage(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 DocumentEE document)
                                          throws JspException,
IOException

Description copied from class: Skin

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 Skin

Returns:

The FlowContent that should be used to write the page contents. This is also given to Skin.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)

defaultPrintLinks

public static <__ extends Union_Metadata_Phrasing<__>>
void defaultPrintLinks(ServletContext servletContext,
 HttpServletRequest req,
 HttpServletResponse resp,
 __ head,
 PageAttributes pageAttributes)
                throws IOException

Throws:

IOException

endPage

public void endPage(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 FlowContent<?> flow)
             throws JspException,
IOException

Description copied from class: Skin

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 Skin

Parameters:

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

startContent

public <PC extends FlowContent<PC>,
__ extends ContentEE<__>>
__ startContent(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 PC pc,
 int[] contentColumnSpans,
 String width)
         throws JspException,
IOException

Description copied from class: Skin

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 Skin

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 Skin.contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String), Skin.contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE), Skin.contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, java.lang.String, int), Skin.contentTitle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int), Skin.startContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), Skin.startContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, java.lang.String, java.lang.String), Skin.contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE), Skin.contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int, boolean), Skin.contentHorizontalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE, int[], boolean), Skin.endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE), Skin.endContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.ContentEE, int), and Skin.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 void contentTitle(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 String title,
 int contentColumns)
                  throws JspException,
IOException

Description copied from class: Skin

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 Skin

Parameters:

content - The ContentEE that was returned by Skin.startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) Skin.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 Skin.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 <__ extends FlowContent<__>> __ startContentLine(HttpServletRequest req,
 HttpServletResponse resp,
 ContentEE<?> content,
 int colspan,
 String align,
 String width)
                                                 throws JspException,
IOException

Description copied from class: Skin

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

Specified by:

startContentLine in class Skin

Type Parameters:

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

Parameters:

content - The ContentEE that was returned by Skin.startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) Skin.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 Skin.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 Skin.contentVerticalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), Skin.contentVerticalDivider(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, boolean, int, int, java.lang.String, java.lang.String), Skin.endContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent), and Skin.endContentLine(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, boolean).

Throws:

JspException

IOException

contentVerticalDivider

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

Description copied from class: Skin

Ends one part of a line and starts the next.

Specified by:

contentVerticalDivider in class Skin

Parameters:

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

Throws:

JspException

IOException

endContentLine

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

Description copied from class: Skin

Ends one line of content.

Specified by:

endContentLine in class Skin

Parameters:

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

contentHorizontalDivider

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

Description copied from class: Skin

Prints a horizontal divider of the provided colspans.

Specified by:

contentHorizontalDivider in class Skin

Parameters:

content - The ContentEE that was returned by Skin.startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) Skin.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 Skin.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 void endContent(HttpServletRequest req,
 HttpServletResponse resp,
 PageAttributes pageAttributes,
 ContentEE<?> content,
 int[] contentColumnSpans)
                throws JspException,
IOException

Description copied from class: Skin

Ends the content area of a page.

Specified by:

endContent in class Skin

Parameters:

content - The ContentEE that was returned by Skin.startContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoindustries.web.struts.skintags.PageAttributes, com.aoapps.html.servlet.FlowContent) Skin.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 Skin.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

startLightArea

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

Description copied from class: Skin

Begins a lighter colored area of the site.

Specified by:

startLightArea in class Skin

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

Throws:

JspException

IOException

endLightArea

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

Description copied from class: Skin

Ends a lighter area of the site.

Specified by:

endLightArea in class Skin

Parameters:

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

Throws:

JspException

IOException

startWhiteArea

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

Description copied from class: Skin

Begins a white area of the site.

Specified by:

startWhiteArea in class Skin

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

Throws:

JspException

IOException

endWhiteArea

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

Description copied from class: Skin

Ends a white area of the site.

Specified by:

endWhiteArea in class Skin

Parameters:

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

Throws:

JspException

IOException

printAutoIndex

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

Description copied from class: Skin

Prints the auto index of all the page siblings.

Specified by:

printAutoIndex in class Skin

Throws:

JspException

IOException

printBelowRelatedPages

public <__ extends FlowContent<__>> void printBelowRelatedPages(HttpServletRequest req,
 __ td)
                                                         throws JspException,
IOException

Prints content below the related pages area on the left.

Throws:

JspException

IOException

beginPopupGroup

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

Begins a popup group.

Specified by:

beginPopupGroup in class Skin

Throws:

JspException

IOException

See Also:

• defaultBeginPopupGroup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE, long)

defaultBeginPopupGroup

public static void defaultBeginPopupGroup(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId)
                                   throws IOException

Default implementation of beginPopupGroup.

Throws:

IOException

endPopupGroup

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

Ends a popup group.

Specified by:

endPopupGroup in class Skin

Throws:

JspException

IOException

See Also:

• defaultEndPopupGroup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE, long)

defaultEndPopupGroup

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

Default implementation of endPopupGroup.

Throws:

JspException

IOException

beginPopup

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

Specified by:

beginPopup in class Skin

Throws:

JspException

IOException

See Also:

• defaultBeginPopup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE, long, long, java.lang.String, java.lang.String)

defaultBeginPopup

public static void defaultBeginPopup(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId,
 long popupId,
 String width,
 String urlBase)
                              throws IOException

Default implementation of beginPopup.

Throws:

IOException

printPopupClose

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

Specified by:

printPopupClose in class Skin

Throws:

JspException

IOException

See Also:

• defaultPrintPopupClose(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE, long, long, java.lang.String)

defaultPrintPopupClose

public static void defaultPrintPopupClose(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId,
 long popupId,
 String urlBase)
                                   throws IOException

Default implementation of printPopupClose.

Throws:

IOException

endPopup

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

Specified by:

endPopup in class Skin

Throws:

JspException

IOException

See Also:

• defaultEndPopup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE, long, long, java.lang.String, java.lang.String)

defaultEndPopup

public static void defaultEndPopup(HttpServletRequest req,
 HttpServletResponse resp,
 DocumentEE document,
 long groupId,
 long popupId,
 String width,
 String urlBase)
                            throws IOException

Default implementation of endPopup.

Throws:

IOException