com.aoindustries.website.framework
Class AutoListPage

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.aoindustries.website.framework.ErrorReportingServlet
              com.aoindustries.website.framework.WebPage
                  com.aoindustries.website.framework.AutoListPage

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

DescriptionAutoListPage

public abstract class AutoListPage
extends WebPage

Automatically generates a list of all pages.

Author:

AO Industries, Inc.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.aoindustries.website.framework.WebPage

emptyWebPageArray, reHTMLPattern

Fields inherited from class com.aoindustries.website.framework.ErrorReportingServlet

BUFFER_SIZE

Constructor Summary

AutoListPage(LoggerAccessor loggerAccessor)

AutoListPage(LoggerAccessor loggerAccessor, java.lang.Object param)

AutoListPage(WebSiteRequest req)

Method Summary

void	doGet(com.aoindustries.io.ChainWriter out, WebSiteRequest req, javax.servlet.http.HttpServletResponse resp) By default, GET provides no content.
void	printContentStart(com.aoindustries.io.ChainWriter out, WebSiteRequest req, javax.servlet.http.HttpServletResponse resp) Prints the content that will be put before the auto-generated list.
static void	printPageList(com.aoindustries.io.ChainWriter out, WebSiteRequest req, javax.servlet.http.HttpServletResponse resp, WebPage[] pages, WebPageLayout layout) Prints a list of pages.
static void	printPageList(com.aoindustries.io.ChainWriter out, WebSiteRequest req, javax.servlet.http.HttpServletResponse resp, WebPage parent, WebPageLayout layout) Prints an unordered list of the available pages.

Methods inherited from class com.aoindustries.website.framework.WebPage

canAccess, doGet, doPost, doPost, doPostWithSearch, enforceEncryption, equals, equals, generateURLPath, getAdditionalHeaders, getAuthor, getCachedPages, getClassLastModified, getClassLoaderUptime, getContentVAlign, getCopyright, getDescription, getHTMLChainWriter, getHTMLOutputStream, getJavaScriptSrc, getKeywords, getLastModified, getLastModifiedRecursive, getLastModifiedRecursive, getNavImageAlt, getNavImageSuffix, getNavImageURL, getNextPage, getOnloadScript, getPageIndexInParent, getParent, getPreferredContentWidth, getPreviousPage, getRedirectURL, getRootPage, getSearchLastModified, getServletContext, getShortTitle, getTitle, getURLParams, getURLPath, getURLPattern, getWebPage, getWebPage, getWebPage, getWebPage, getWebPageAndChildrenLastModified, getWebPageLayout, getWebPages, getWebSiteRequest, hashCode, includeNavImageAsParent, isHandler, isHandler, loadClass, printLoginForm, printUnauthorizedPage, reportingDoGet, reportingDoPost, reportingGetLastModified, search, showInLocationPath, standardSearch, useEncryption, useNavImage, useSiteMap

Methods inherited from class com.aoindustries.website.framework.ErrorReportingServlet

doGet, doPost, getGetCount, getLastModified, getLastModifiedCount, getLogger, getLogger, getLogger, getLoggerAccessor, getPostCount, getUptime, log, log

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoListPage

public AutoListPage(LoggerAccessor loggerAccessor)

AutoListPage

public AutoListPage(WebSiteRequest req)

AutoListPage

public AutoListPage(LoggerAccessor loggerAccessor,
                    java.lang.Object param)

Method Detail

doGet

public void doGet(com.aoindustries.io.ChainWriter out,
                  WebSiteRequest req,
                  javax.servlet.http.HttpServletResponse resp)
           throws java.io.IOException,
                  java.sql.SQLException

Description copied from class: WebPage

By default, GET provides no content.

Overrides:

doGet in class WebPage

Parameters:

out - the ChainWriter to send output to

req - the current WebSiteRequest

resp - the HttpServletResponse for this request, is null when searching

Throws:

java.io.IOException

java.sql.SQLException

printContentStart

public void printContentStart(com.aoindustries.io.ChainWriter out,
                              WebSiteRequest req,
                              javax.servlet.http.HttpServletResponse resp)
                       throws java.io.IOException,
                              java.sql.SQLException

Prints the content that will be put before the auto-generated list.

Throws:

java.io.IOException

java.sql.SQLException

printPageList

public static void printPageList(com.aoindustries.io.ChainWriter out,
                                 WebSiteRequest req,
                                 javax.servlet.http.HttpServletResponse resp,
                                 WebPage[] pages,
                                 WebPageLayout layout)
                          throws java.io.IOException,
                                 java.sql.SQLException

Prints a list of pages.

Throws:

java.io.IOException

java.sql.SQLException

printPageList

public static void printPageList(com.aoindustries.io.ChainWriter out,
                                 WebSiteRequest req,
                                 javax.servlet.http.HttpServletResponse resp,
                                 WebPage parent,
                                 WebPageLayout layout)
                          throws java.io.IOException,
                                 java.sql.SQLException

Prints an unordered list of the available pages.

Throws:

java.io.IOException

java.sql.SQLException