Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class HtmlInputStreamPage

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.aoapps.web.resources.servlet.PageServlet

com.aoapps.web.framework.WebPage

com.aoapps.web.framework.InputStreamPage

com.aoapps.web.framework.HtmlInputStreamPage

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public abstract class HtmlInputStreamPage
extends InputStreamPage

Pulls the content from a file with the same name and location as the .class and .java but with a .html extension. As the file is being sent to the client, any href="@classname" URL is rewritten and maintains the current WebSiteRequest parameters.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

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

emptyWebPageArray, reHTMLPattern, SEARCH_TWO

Constructor Summary

Constructors

Constructor	Description
HtmlInputStreamPage()

Method Summary

Modifier and Type	Method	Description
static InputStream	getHtmlInputStream(Class<?> clazz)	Gets the HTML file with the same name as the provided Class or null when not found.
InputStream	getInputStream()	Gets the file that the text should be read from.
static <__ extends FlowContent<__>> __	printHtml(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, ContentEE<?> content, __ contentLine, String htmlContent, String linkClass, AtomicReference<FlowContent<?>> lightAreaRef)	Prints HTML content, parsing for special @ tags.
static <__ extends FlowContent<__>> __	printHtmlStream(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, ContentEE<?> content, __ contentLine, InputStream in, String linkClass, AtomicReference<FlowContent<?>> lightAreaRef)	Prints HTML with template substitutions.
<__ extends FlowContent<__>> __	printStream(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, ContentEE<?> content, __ contentLine, InputStream in)	Stream input to servlet output.

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

doGet, printStreamStatic

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

canAccess, configureResources, doGet, doGet, doGet, doPost, doPost, doPost, doPost, doPostWithSearch, equals, equals, generateUrlPath, getAuthor, getAuthorHref, getAutonli, getCachedChildren, getChildren, getClassLastModified, getContentValign, getCopyright, getDescription, getDoctype, getDocument, getHtmlOutputStream, getIndent, getJavascriptSrc, getKeywords, getLastModified, getLastModified, getLastModifiedRecursive, getLastModifiedRecursive, getNavImageAlt, getNavImageSuffix, getNavImageUrl, getNextPage, getOnloadScript, getPageIndexInParent, getParent, getPreferredContentWidth, getPreviousPage, getRedirectType, getRedirectUrl, getRootPage, getSearchLastModified, getSerialization, getServletContext, getShortTitle, getTitle, getUptime, getUrlParams, getUrlPath, getUrlPattern, getWebPage, getWebPage, getWebPage, getWebPage, getWebPage, getWebPage, getWebPageAndChildrenLastModified, getWebPageLayout, getWebSiteRequest, hashCode, includeNavImageAsParent, isHandler, isHandler, loadClass, printLoginForm, printUnauthorizedPage, search, service, setHeaders, showInLocationPath, standardSearch, useNavImage, useSiteMap

Methods inherited from class com.aoapps.web.resources.servlet.PageServlet

service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlInputStreamPage

public HtmlInputStreamPage()

Method Details

printStream

public <__ extends FlowContent<__>> __ printStream(WebSiteRequest req,
 HttpServletResponse resp,
 WebPageLayout layout,
 ContentEE<?> content,
 __ contentLine,
 InputStream in)
                                            throws ServletException,
IOException

Description copied from class: InputStreamPage

Stream input to servlet output.

Overrides:

printStream in class InputStreamPage

Returns:

The current contentLine, which may have been replaced by a call to WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) or WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String).

Throws:

ServletException

IOException

getInputStream

public InputStream getInputStream()
                           throws IOException

Gets the file that the text should be read from.

Specified by:

getInputStream in class InputStreamPage

Throws:

IOException

getHtmlInputStream

public static InputStream getHtmlInputStream(Class<?> clazz)

Gets the HTML file with the same name as the provided Class or null when not found.

printHtml

public static <__ extends FlowContent<__>> __ printHtml(WebSiteRequest req,
 HttpServletResponse resp,
 WebPageLayout layout,
 ContentEE<?> content,
 __ contentLine,
 String htmlContent,
 String linkClass,
 AtomicReference<FlowContent<?>> lightAreaRef)
                                                 throws ServletException,
IOException

Prints HTML content, parsing for special @ tags. Types of tags include:

• @URL(classname) Loads a WebPage of the given class and builds a URL to it
• @BEGIN_LIGHT_AREA Calls WebPageLayout.startLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• @END_LIGHT_AREA Calls WebPageLayout.endLightArea(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• @END_CONTENT_LINE Calls WebPageLayout.endContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent)
• @PRINT_CONTENT_HORIZONTAL_DIVIDER Calls WebPageLayout.contentHorizontalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE)
• @START_CONTENT_LINE Calls WebPageLayout.startContentLine(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.ContentEE)
• @LINK_CLASS The preferred link class for this element

Returns:

The current contentLine, which may have been replaced by a call to WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) or WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String).

Throws:

ServletException

IOException

See Also:

• printHtmlStream(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.ContentEE, com.aoapps.html.servlet.FlowContent, java.io.InputStream, java.lang.String, java.util.concurrent.atomic.AtomicReference)

printHtmlStream

public static <__ extends FlowContent<__>> __ printHtmlStream(WebSiteRequest req,
 HttpServletResponse resp,
 WebPageLayout layout,
 ContentEE<?> content,
 __ contentLine,
 InputStream in,
 String linkClass,
 AtomicReference<FlowContent<?>> lightAreaRef)
                                                       throws ServletException,
IOException

Prints HTML with template substitutions.

Returns:

The current contentLine, which may have been replaced by a call to WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent) or WebPageLayout.contentVerticalDivider(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.FlowContent, int, int, int, java.lang.String, java.lang.String).

Throws:

ServletException

IOException

See Also:

• printHtml(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.ContentEE, com.aoapps.html.servlet.FlowContent, java.lang.String, java.lang.String, java.util.concurrent.atomic.AtomicReference)