Module com.aoapps.web.framework

Package com.aoapps.web.framework

Class TreePage

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

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Direct Known Subclasses:

AutoSiteMap

public abstract class TreePage
extends WebPage

A tree page creates a user interactive hierarchical representation of the site tree structure.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODE_AUTO	Indicates the TreePage should automatically select the correct mode, this is the default if the parameter is not provided.
static final String	MODE_GUI	Indicates the TreePage should display its contents in an interactive format.
static final String	MODE_TEXT	Indicates the TreePage should display its contents in a text-only format.
static final int	TREE_LINE_COLOR	The color of the lines.
static final String	TREEPAGE_MODE	The parameter name to control the TreePage display mode.

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

emptyWebPageArray, reHTMLPattern, SEARCH_TWO

Constructor Summary

Constructors

Constructor	Description
TreePage()

Method Summary

Modifier and Type	Method	Description
void	doGet(WebSiteRequest req, HttpServletResponse resp)	Prepares the request then invokes WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE).
<__ extends FlowContent<__>> void	doGet(WebSiteRequest req, HttpServletResponse resp, WebPageLayout layout, __ flow)	By default, GET provides no content.
void	doPost(WebSiteRequest req, HttpServletResponse resp)	Prepares the request then invokes WebPage.doPost(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE).
long	getLastModified(WebSiteRequest req, HttpServletResponse resp)	The getLastModified defaults to -1.
long	getSearchLastModified()	Gets the last modified time for search indexing.
protected abstract List<? extends TreePageData>	getTree(WebSiteRequest req, HttpServletResponse resp)	Gets the tree to be displayed.
protected boolean	useCodeFont(WebSiteRequest req)
abstract boolean	useSmoothOutline(WebSiteRequest req)

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

canAccess, configureResources, doGet, 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, 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

Field Details

TREE_LINE_COLOR

public static final int TREE_LINE_COLOR

The color of the lines.

See Also:

• Constant Field Values

TREEPAGE_MODE

public static final String TREEPAGE_MODE

The parameter name to control the TreePage display mode.

See Also:

• Constant Field Values

MODE_AUTO

public static final String MODE_AUTO

Indicates the TreePage should automatically select the correct mode, this is the default if the parameter is not provided.

See Also:

• Constant Field Values

MODE_TEXT

public static final String MODE_TEXT

Indicates the TreePage should display its contents in a text-only format.

See Also:

• Constant Field Values

MODE_GUI

public static final String MODE_GUI

Indicates the TreePage should display its contents in an interactive format.

See Also:

• Constant Field Values

Constructor Details

TreePage

public TreePage()

Method Details

doGet

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

Description copied from class: WebPage

Prepares the request then invokes WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE). To not have these steps automatically applied, override this method. By the time this method is called, security checks, authentication, and redirects have been done.

1. Sets the serialization.
2. Sets the DOCTYPE.
3. Gets the response writer.
4. Invokes WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE).

Overrides:

doGet in class WebPage

Throws:

ServletException

IOException

See Also:

• WebPage.doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
• WebPage.getSerialization(com.aoapps.web.framework.WebSiteRequest)
• WebPage.getDoctype(com.aoapps.web.framework.WebSiteRequest)
• WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)

getSearchLastModified

public long getSearchLastModified()
                           throws ServletException

Description copied from class: WebPage

Gets the last modified time for search indexing. The index will be recreated if the search last modified time is changed. If this method returns -1, no search index is built. This defaults to be a call to getLastModified with null WebSiteRequest and HttpServletResponse.

Overrides:

getSearchLastModified in class WebPage

Throws:

ServletException

getLastModified

public long getLastModified(WebSiteRequest req,
 HttpServletResponse resp)

Description copied from class: WebPage

The getLastModified defaults to -1.

Overrides:

getLastModified in class WebPage

doGet

public <__ extends FlowContent<__>> void doGet(WebSiteRequest req,
 HttpServletResponse resp,
 WebPageLayout layout,
 __ flow)
                                        throws ServletException,
IOException

Description copied from class: WebPage

By default, GET provides no content.

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

layout - the WebPageLayout that has been applied

flow - the FlowContent to send output to

Throws:

ServletException

IOException

See Also:

• WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)

doPost

public void doPost(WebSiteRequest req,
 HttpServletResponse resp)
            throws ServletException,
IOException

Description copied from class: WebPage

Prepares the request then invokes WebPage.doPost(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE). To not have these steps automatically applied, override this method. By the time this method is called, security checks, authentication, and redirects have been done.

1. Sets the serialization.
2. Sets the DOCTYPE.
3. Gets the response writer.
4. Invokes WebPage.doPost(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE).

Overrides:

doPost in class WebPage

Throws:

ServletException

IOException

See Also:

• WebPage.doPostWithSearch(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse)
• WebPage.getSerialization(com.aoapps.web.framework.WebSiteRequest)
• WebPage.getDoctype(com.aoapps.web.framework.WebSiteRequest)
• WebPage.doPost(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)

getTree

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

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

Throws:

ServletException

useCodeFont

protected boolean useCodeFont(WebSiteRequest req)

useSmoothOutline

public abstract boolean useSmoothOutline(WebSiteRequest req)