Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class AutoSiteMap

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

com.aoapps.web.resources.servlet.PageServlet

com.aoapps.web.framework.WebPage

com.aoapps.web.framework.TreePage

com.aoapps.web.framework.AutoSiteMap

All Implemented Interfaces:

Servlet, ServletConfig, Serializable

public abstract class AutoSiteMap
extends TreePage

Automatically builds a site map of the entire site.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

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

MODE_AUTO, MODE_GUI, MODE_TEXT, TREE_LINE_COLOR, TREEPAGE_MODE

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

emptyWebPageArray, reHTMLPattern, SEARCH_TWO

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
AutoSiteMap()

Method Summary

Modifier and Type	Method	Description
void	doGet(WebSiteRequest req, HttpServletResponse resp, DocumentEE document)	The content of this page will not be included in the internal search engine.
protected final List<? extends TreePageData>	getTree(WebSiteRequest req, HttpServletResponse resp)	Gets the tree to be displayed.
protected abstract boolean	isVisible(WebPage page)	Determines if a page should be visible in the generated maps.

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

doGet, doGet, doPost, getLastModified, getSearchLastModified, useCodeFont, useSmoothOutline

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

canAccess, configureResources, doGet, doPost, doPost, doPost, doPostWithSearch, equals, equals, generateUrlPath, getAuthor, getAuthorHref, getAutonli, getCachedChildren, getChildren, getClassLastModified, getContentValign, getCopyright, getDescription, getDoctype, getDocument, getHtmlOutputStream, getIndent, getJavascriptSrc, getKeywords, getLastModified, getLastModifiedRecursive, getLastModifiedRecursive, getNavImageAlt, getNavImageSuffix, getNavImageUrl, getNextPage, getOnloadScript, getPageIndexInParent, getParent, getPreferredContentWidth, getPreviousPage, getRedirectType, getRedirectUrl, getRootPage, getSerialization, 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 jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, init

Methods inherited from class jakarta.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Details

AutoSiteMap

public AutoSiteMap()

Method Details

doGet

public void doGet(WebSiteRequest req,
 HttpServletResponse resp,
 DocumentEE document)
           throws ServletException,
IOException

The content of this page will not be included in the internal search engine.

Overrides:

doGet in class WebPage

Parameters:

req - the WebSiteRequest for this request, or null when searching

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

document - the DocumentEE to send output to

Throws:

ServletException

IOException

See Also:

• WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse)
• WebPage.getWebPageLayout(com.aoapps.web.framework.WebSiteRequest)
• WebPageLayout.doPage(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPage, com.aoapps.html.servlet.DocumentEE, java.lang.String, com.aoapps.servlet.function.ServletConsumerE)
• WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, jakarta.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent)

getTree

protected final List<? extends TreePageData> getTree(WebSiteRequest req,
 HttpServletResponse resp)
                                              throws ServletException

Description copied from class: TreePage

Gets the tree to be displayed. Each row consists of three elements: path, href, description

Specified by:

getTree in class TreePage

Throws:

ServletException

isVisible

protected abstract boolean isVisible(WebPage page)

Determines if a page should be visible in the generated maps.