A B C D E F G H I L M N O P R S T U W

A

appendParams(StringBuilder, Object, List<String>, boolean) - Static method in class com.aoindustries.website.framework.WebSiteRequest

Appends the parameters to a URL.

appendSettings(List<String>, boolean, StringBuilder) - Method in class com.aoindustries.website.framework.WebSiteRequest

AutoListPage - Class in com.aoindustries.website.framework

Automatically generates a list of all pages.

AutoListPage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.AutoListPage

AutoListPage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.AutoListPage

AutoListPage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.AutoListPage

AutoSiteMap - Class in com.aoindustries.website.framework

Automatically builds a site map of the entire site.

AutoSiteMap(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.AutoSiteMap

AutoSiteMap(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.AutoSiteMap

AutoSiteMap(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.AutoSiteMap

B

beginLightArea(WebSiteRequest, HttpServletResponse, ChainWriter, String, boolean) - Method in class com.aoindustries.website.framework.TextOnlyLayout

beginLightArea(WebSiteRequest, HttpServletResponse, ChainWriter) - Method in class com.aoindustries.website.framework.WebPageLayout

Begins a lighter colored area of the site.

beginLightArea(WebSiteRequest, HttpServletResponse, ChainWriter, String, boolean) - Method in class com.aoindustries.website.framework.WebPageLayout

Begins a lighter colored area of the site.

beginWhiteArea(WebSiteRequest, HttpServletResponse, ChainWriter, String, boolean) - Method in class com.aoindustries.website.framework.TextOnlyLayout

beginWhiteArea(WebSiteRequest, HttpServletResponse, ChainWriter) - Method in class com.aoindustries.website.framework.WebPageLayout

Begins an area with a white background.

beginWhiteArea(WebSiteRequest, HttpServletResponse, ChainWriter, String, boolean) - Method in class com.aoindustries.website.framework.WebPageLayout

Begins a lighter colored area of the site.

BUFFER_SIZE - Static variable in class com.aoindustries.website.framework.ErrorReportingServlet

The response buffer is set to this size.

bytes - Variable in class com.aoindustries.website.framework.OutputCacheEntry

C

canAccess(WebSiteUser) - Method in class com.aoindustries.website.framework.WebPage

Determines if the provided user can access the page.

com.aoindustries.website.framework - package com.aoindustries.website.framework

compareTo(SearchResult) - Method in class com.aoindustries.website.framework.SearchResult

D

DescriptionAutoListPage - Class in com.aoindustries.website.framework

Automatically generates the description along with a list of all pages.

DescriptionAutoListPage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.DescriptionAutoListPage

DescriptionAutoListPage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.DescriptionAutoListPage

DescriptionAutoListPage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.DescriptionAutoListPage

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.AutoListPage

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.AutoSiteMap

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

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.DumpURLs

doGet(HttpServletRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Any error that occurs during a doGet is caught and reported here.

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.FilePage

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.InputStreamPage

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.PreFilePage

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.PreProcessPage

doGet(WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.TreePage

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.TreePage

doGet(WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

The layout is automatically applied to the page, then doGet is called.

doGet(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

By default, GET provides no content.

doPost(HttpServletRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Any error that occurs during a doPost is caught and reported here.

doPost(WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.TreePage

doPost(WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

By default, a post request is just sets up the content beginning and calls doPost

doPost(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

By default, a post request just calls doGet

doPostWithSearch(WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

Handles any search posts, sends everything else on to doPost(WebSiteRequest,HttpServletResponse).

DOWN - Static variable in class com.aoindustries.website.framework.WebPageLayout

Directional references.

DumpURLs - Class in com.aoindustries.website.framework

Generates a list of all URLs in the site.

DumpURLs(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.DumpURLs

DumpURLs(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.DumpURLs

DumpURLs(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.DumpURLs

E

emptyWebPageArray - Static variable in class com.aoindustries.website.framework.WebPage

An empty array of WebPage objects to be used in returning no web pages.

endContent(WebPage, ChainWriter, WebSiteRequest, HttpServletResponse, int[]) - Method in class com.aoindustries.website.framework.TextOnlyLayout

Ends the content area of a page.

endContent(WebPage, ChainWriter, WebSiteRequest, HttpServletResponse, int) - Method in class com.aoindustries.website.framework.WebPageLayout

Ends the content area of a page.

endContent(WebPage, ChainWriter, WebSiteRequest, HttpServletResponse, int[]) - Method in class com.aoindustries.website.framework.WebPageLayout

Ends the content area of a page.

endContentLine(ChainWriter, WebSiteRequest, HttpServletResponse, int, boolean) - Method in class com.aoindustries.website.framework.TextOnlyLayout

Ends one line of content.

endContentLine(ChainWriter, WebSiteRequest, HttpServletResponse, int, boolean) - Method in class com.aoindustries.website.framework.WebPageLayout

Ends one line of content.

endHTML(WebPage, WebSiteRequest, ChainWriter) - Method in class com.aoindustries.website.framework.TextOnlyLayout

endHTML(WebPage, WebSiteRequest, ChainWriter) - Method in class com.aoindustries.website.framework.WebPageLayout

Writes all of the HTML following the content of the page, whether the page is in a frameset or not.

endLightArea(WebSiteRequest, HttpServletResponse, ChainWriter) - Method in class com.aoindustries.website.framework.TextOnlyLayout

endLightArea(WebSiteRequest, HttpServletResponse, ChainWriter) - Method in class com.aoindustries.website.framework.WebPageLayout

Ends a lighter area of the site.

endWhiteArea(WebSiteRequest, HttpServletResponse, ChainWriter) - Method in class com.aoindustries.website.framework.TextOnlyLayout

endWhiteArea(WebSiteRequest, HttpServletResponse, ChainWriter) - Method in class com.aoindustries.website.framework.WebPageLayout

Ends a lighter area of the site.

enforceEncryption() - Method in class com.aoindustries.website.framework.WebPage

Gets whether this page should enforce the current encrpyption requirement or not.

equals(Object) - Method in class com.aoindustries.website.framework.WebPage

Determines if this page equals another page.

equals(WebPage) - Method in class com.aoindustries.website.framework.WebPage

Determines if this page equals another page.

ErrorReportingServlet - Class in com.aoindustries.website.framework

Any error occuring during servlet execution is reported to System.err.

ErrorReportingServlet(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.ErrorReportingServlet

F

FilePage - Class in com.aoindustries.website.framework

Pulls information from a file to be used as the content.

FilePage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.FilePage

FilePage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.FilePage

FilePage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.FilePage

findResource(String) - Method in class com.aoindustries.website.framework.WebPageClassLoader

findResources(String) - Method in class com.aoindustries.website.framework.WebPageClassLoader

G

generateURLPath(WebPage) - Method in class com.aoindustries.website.framework.WebPage

Generates a URL path for this or another page, please call getURLPath() instead.

getActiveLinkColor(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPageLayout

The active link color for the page or -1 for browser default.

getAdditionalHeaders(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets additional headers for this page.

getAuthor() - Method in class com.aoindustries.website.framework.SearchResult

getAuthor() - Method in class com.aoindustries.website.framework.WebPage

Gets the author of this page.

getBackgroundColor(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPageLayout

The background color for the page or -1 for browser default.

getCachedPages(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets all of the pages that are children of this one in the page hierarchy.

getClassLastModified() - Method in class com.aoindustries.website.framework.WebPage

Gets the last modified time of the java class file.

getClassLoaderUptime() - Static method in class com.aoindustries.website.framework.WebPage

Gets the time that the classloader was instantiated.

getCommonPages(WebPage, WebSiteRequest) - Method in class com.aoindustries.website.framework.TextOnlyLayout

getContentType() - Method in class com.aoindustries.website.framework.UploadedFile

getContentType(File) - Method in class com.aoindustries.website.framework.UploadedFileTypeMap

getContentType(String) - Method in class com.aoindustries.website.framework.UploadedFileTypeMap

getContentVAlign(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the vertical alignment of the content area.

getCopyright(WebSiteRequest, WebPage) - Method in class com.aoindustries.website.framework.WebPage

Gets the copyright information for this page.

getCreateTime() - Method in class com.aoindustries.website.framework.UploadedFile

getDescription() - Method in class com.aoindustries.website.framework.DumpURLs

getDescription() - Method in class com.aoindustries.website.framework.RedirectWebPage

getDescription() - Method in class com.aoindustries.website.framework.SearchResult

getDescription() - Method in class com.aoindustries.website.framework.TreePageData

getDescription() - Method in class com.aoindustries.website.framework.WebPage

Gets the description of this page.

getDynamicClassPrefixes() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

getEnforceSecureMode() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

getFile() - Method in class com.aoindustries.website.framework.FilePage

Gets the file that the text should be read from.

getFilename() - Method in class com.aoindustries.website.framework.UploadedFile

getFileUploadDirectory() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

getGetCount() - Static method in class com.aoindustries.website.framework.ErrorReportingServlet

Gets the number of GET requests that have been placed.

getGoogleAnalyticsNewTrackingCode() - Method in class com.aoindustries.website.framework.TextOnlyLayout

Gets the Google Analytics New Tracking Code (ga.js) or null if unavailable.

getHTMLChainWriter(WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

Sets the content type, encoding to UTF-8, sets the additional headers, then returns the ChainWriter.

getHTMLInputStream(Class) - Static method in class com.aoindustries.website.framework.HTMLInputStreamPage

Gets the HTML file with the same name as the provided Class.

getHTMLOutputStream(WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

Sets the content type, encoding to UTF-8, sets the additional headers, then returns the OutputStream.

getHttpBase() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

getHttpsBase() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

getID() - Method in class com.aoindustries.website.framework.UploadedFile

getInputStream() - Method in class com.aoindustries.website.framework.HTMLInputStreamPage

Gets the file that the text should be read from.

getInputStream() - Method in class com.aoindustries.website.framework.InputStreamPage

Gets the stream that the text should be read from.

getInputStream() - Method in class com.aoindustries.website.framework.ProcessPage

getJavaScriptSrc(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the JavaScript's that should have script src= tags generated, urls relative to top of context path/to/javascript.js.

getKeywords() - Method in class com.aoindustries.website.framework.DumpURLs

getKeywords() - Method in class com.aoindustries.website.framework.RedirectWebPage

getKeywords() - Method in class com.aoindustries.website.framework.WebPage

Gets the keywords for this page.

getLastAccessed() - Method in class com.aoindustries.website.framework.UploadedFile

getLastModified(WebSiteRequest) - Method in class com.aoindustries.website.framework.DumpURLs

The last modified time is -1 to always reload the list.

getLastModified(HttpServletRequest) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Any error that occurs during a getLastModified call is caught here.

getLastModified(WebSiteRequest) - Method in class com.aoindustries.website.framework.FilePage

getLastModified(WebSiteRequest) - Method in class com.aoindustries.website.framework.ProcessPage

getLastModified(WebSiteRequest) - Method in class com.aoindustries.website.framework.TreePage

getLastModified(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

The getLastModified defaults to -1.

getLastModifiedCount() - Static method in class com.aoindustries.website.framework.ErrorReportingServlet

Gets the number of calls to getLastModified.

getLastModifiedRecursive(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Recursively gets the most recent modification time.

getLastModifiedRecursive(File) - Static method in class com.aoindustries.website.framework.WebPage

Recursively gets the most recent modification time of a file or directory.

getLayoutChoices() - Method in class com.aoindustries.website.framework.WebPageLayout

Gets the names of every supported layout.

getLinkColor(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPageLayout

The link color for the page or -1 for browser default.

getLogger() - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Gets the logger for this servlet.

getLogger(Class) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Gets the logger for the provided class.

getLogger(String) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Gets the provided named logger.

getLogger(ServletContext, String) - Method in interface com.aoindustries.website.framework.LoggerAccessor

getLoggerAccessor() - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Gets the loggerAccess for this page.

getMaxFileUploadSize() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

getName() - Method in class com.aoindustries.website.framework.TextOnlyLayout

getName() - Method in class com.aoindustries.website.framework.WebPageLayout

Each layout has a name.

getNavImageAlt(WebSiteRequest) - Method in class com.aoindustries.website.framework.RedirectWebPage

getNavImageAlt(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the text for the navigation image to use to represent this page.

getNavImageSuffix(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the text that will be placed in to the right of the navigation image.

getNavImageURL(WebSiteRequest, HttpServletResponse, Object) - Method in class com.aoindustries.website.framework.WebPage

Gets the URL associated with a nav image.

getNextPage(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the WebPage that follows this one in the parents list of pages.

getOnloadScript(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the JavaScript that should be executed with the onload event of the body tag

getOwner() - Method in class com.aoindustries.website.framework.UploadedFile

getPageIndexInParent(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the index of this page in the parents list of children pages.

getParameter(String) - Method in class com.aoindustries.website.framework.WebSiteRequest

getParameterNames() - Method in class com.aoindustries.website.framework.WebSiteRequest

getParameterValues(String) - Method in class com.aoindustries.website.framework.WebSiteRequest

getParent() - Method in class com.aoindustries.website.framework.RedirectWebPage

getParent() - Method in class com.aoindustries.website.framework.WebPage

Gets the parent of this page or null for none.

getPath() - Method in class com.aoindustries.website.framework.TreePageData

getPostCount() - Static method in class com.aoindustries.website.framework.ErrorReportingServlet

Gets the number of POST requests that have been made.

getPreferredContentWidth(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the preferred width of this content in pixels or -1 for no preference.

getPreviousPage(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the WebPage that proceeds this one in the parents list of pages.

getProbability() - Method in class com.aoindustries.website.framework.SearchResult

getProcess() - Method in class com.aoindustries.website.framework.ProcessPage

Gets the process that the contents should be read from

getRandom() - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets the random number generator used for this request.

getRedirectURL(WebSiteRequest) - Method in class com.aoindustries.website.framework.RedirectWebPage

getRedirectURL(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the URL to direct to.

getRootPage() - Method in class com.aoindustries.website.framework.WebPage

Gets the root page in the web page hierarchy.

getSearchLastModified() - Method in class com.aoindustries.website.framework.DumpURLs

getSearchLastModified() - Method in class com.aoindustries.website.framework.ProcessPage

The search format of this page is indexed.

getSearchLastModified() - Method in class com.aoindustries.website.framework.TreePage

getSearchLastModified() - Method in class com.aoindustries.website.framework.WebPage

Gets the last modified time for search indexing.

getServletContext() - Method in class com.aoindustries.website.framework.WebPage

getServletDirectory() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

getShortTitle() - Method in class com.aoindustries.website.framework.WebPage

A short title is used showing a path to the current location in the site.

getStaticClassPrefixes() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

getStorageFile() - Method in class com.aoindustries.website.framework.UploadedFile

getTextColor(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPageLayout

The text color for the page or -1 for browser default.

getTitle() - Method in class com.aoindustries.website.framework.DumpURLs

getTitle() - Method in class com.aoindustries.website.framework.RedirectWebPage

getTitle() - Method in class com.aoindustries.website.framework.SearchResult

getTitle() - Method in class com.aoindustries.website.framework.WebPage

Gets the title of the web page in order to generate the HTML.

getTree(WebSiteRequest) - Method in class com.aoindustries.website.framework.AutoSiteMap

getTree(WebSiteRequest) - Method in class com.aoindustries.website.framework.TreePage

Gets the tree to be displayed.

getUploadedFile(WebSiteUser, long, ServletContext, LoggerAccessor) - Static method in class com.aoindustries.website.framework.WebSiteRequest

Gets a file that was uploaded given its ID.

getUploadedFiles() - Method in class com.aoindustries.website.framework.WebSiteRequest

getUptime() - Static method in class com.aoindustries.website.framework.ErrorReportingServlet

Gets the time the servlet environment was loaded.

getUptime() - Static method in class com.aoindustries.website.framework.WebPageClassLoader

Gets the time the classloader was loaded.

getUrl() - Method in class com.aoindustries.website.framework.SearchResult

getUrl() - Method in class com.aoindustries.website.framework.TreePageData

getURL(String) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets a relative URL from a String containing a classname and optional parameters.

getURL(String, String) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets a relative URL given its classname and optional parameters.

getURL(String, boolean, Object, boolean) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets the absolute URL String, optionally with the settings embedded.

getURL(WebPage) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets the absolute URL to a web page.

getURL(WebPage, Object) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets the absolute URL to a web page.

getURL(WebPage, boolean, Object) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets the absolute URL to a web page.

getURL(Class<? extends WebPage>, Object) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets the absolute URL to a web page.

getURL(Class<? extends WebPage>) - Method in class com.aoindustries.website.framework.WebSiteRequest

getURL(String, boolean, Object) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets the URL String with the given parameters embedded, keeping the current settings.

getURLParams(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets parameters that are added to the query string of URLs generated for this page.

getURLPath() - Method in class com.aoindustries.website.framework.RedirectWebPage

getURLPath() - Method in class com.aoindustries.website.framework.WebPage

Gets the path of for the URL relative to the top of the site.

getURLPattern() - Method in class com.aoindustries.website.framework.WebPage

Gets the URL pattern for this page as used in web.xml.

getVisitedLinkColor(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPageLayout

The visited link color for the page or -1 for browser default.

getWebPage(Class<? extends WebPage>, WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

getWebPage(ServletContext, Class<? extends WebPage>, WebSiteRequest) - Static method in class com.aoindustries.website.framework.WebPage

Gets an instance of WebPage given the Class.

getWebPage(Class<? extends WebPage>, Object) - Method in class com.aoindustries.website.framework.WebPage

getWebPage(ServletContext, Class<? extends WebPage>, Object) - Static method in class com.aoindustries.website.framework.WebPage

Gets an instance of WebPage given the Class.

getWebPageAndChildrenLastModified(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the most recent last modified time of this page and its immediate children.

getWebPageLayout(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the current layout for this page.

getWebPages(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets all of the children pages of this one in the page hierarchy.

getWebSiteRequest(HttpServletRequest) - Method in class com.aoindustries.website.framework.RedirectWebPage

getWebSiteRequest(HttpServletRequest) - Method in class com.aoindustries.website.framework.WebPage

Gets the WebSiteRequest that handles authentication and other details of this site.

getWebSiteUser(HttpServletResponse) - Method in class com.aoindustries.website.framework.WebSiteRequest

Gets the person who is logged in or null if no login is performed for this request.

H

hashCode() - Method in class com.aoindustries.website.framework.WebPage

The default hashcode for a page is the hashcode of its classname.

HTMLInputStreamPage - Class in com.aoindustries.website.framework

Pulls the content from a file with the same name and location as the .class and .java but with a .html extension.

HTMLInputStreamPage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.HTMLInputStreamPage

HTMLInputStreamPage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.HTMLInputStreamPage

HTMLInputStreamPage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.HTMLInputStreamPage

HTTP_SERVLET_RESPONSE_STATUS - Static variable in class com.aoindustries.website.framework.TextOnlyLayout

Until version 3.0 there will not be a getStatus method on the HttpServletResponse class.

I

includeNavImageAsParent() - Method in class com.aoindustries.website.framework.WebPage

Determine if the nav image for this page should remain visible, even when its children are displayed.

InputStreamPage - Class in com.aoindustries.website.framework

Reads everything from an input stream and puts it into a page.

InputStreamPage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.InputStreamPage

InputStreamPage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.InputStreamPage

InputStreamPage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.InputStreamPage

isBlackBerry() - Method in class com.aoindustries.website.framework.WebSiteRequest

Determines if the request is for a BlackBerry browser

isHandler(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Determines if this page is the instance that should handle a particular request.

isHandler(Object) - Method in class com.aoindustries.website.framework.WebPage

Determines if this page is the instance that represents a certain set of parameters.

isLinux() - Method in class com.aoindustries.website.framework.WebSiteRequest

Determines if the request is for a Linux browser

isLoggedIn() - Method in class com.aoindustries.website.framework.WebSiteRequest

Determines if the user is currently logged in.

isLynx() - Method in class com.aoindustries.website.framework.WebSiteRequest

Determines if the request is for a Lynx browser

isSecure() - Method in class com.aoindustries.website.framework.WebSiteRequest

isVisible(WebPage) - Method in class com.aoindustries.website.framework.AutoSiteMap

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

L

lastModified - Variable in class com.aoindustries.website.framework.OutputCacheEntry

loadClass(String) - Static method in class com.aoindustries.website.framework.WebPage

Dynamically loads new classes based on the source .class file's modified time.

loadClass(String, boolean) - Method in class com.aoindustries.website.framework.WebPageClassLoader

log(String) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Deprecated. Please call logger directly for accurate class and method

log(String, Throwable) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

Deprecated. Please call logger directly for accurate class and method

LoggerAccessor - Interface in com.aoindustries.website.framework

Given a ServletContext and a name should return an appropriate Logger.

logout(HttpServletResponse) - Method in class com.aoindustries.website.framework.WebSiteRequest

Logs out the current user or does nothing if not logged in.

M

MODE_AUTO - Static variable in class com.aoindustries.website.framework.TreePage

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

MODE_GUI - Static variable in class com.aoindustries.website.framework.TreePage

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

MODE_TEXT - Static variable in class com.aoindustries.website.framework.TreePage

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

N

NONE - Static variable in class com.aoindustries.website.framework.WebPageLayout

Directional references.

O

OutputCacheEntry - Class in com.aoindustries.website.framework

OutputCacheEntry(Object, long, byte[]) - Constructor for class com.aoindustries.website.framework.OutputCacheEntry

outputCacheKey - Variable in class com.aoindustries.website.framework.OutputCacheEntry

P

PreFilePage - Class in com.aoindustries.website.framework

Pulls the page contents from a file while wrapping it with a PRE block.

PreFilePage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.PreFilePage

PreFilePage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.PreFilePage

PreFilePage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.PreFilePage

PreProcessPage - Class in com.aoindustries.website.framework

Takes the output of a native process and puts it in a PRE block

PreProcessPage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.PreProcessPage

PreProcessPage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.PreProcessPage

PreProcessPage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.PreProcessPage

printBelowRelatedPages(ChainWriter, WebSiteRequest) - Method in class com.aoindustries.website.framework.TextOnlyLayout

Prints content below the related pages area on the left.

printContentHorizontalDivider(ChainWriter, WebSiteRequest, HttpServletResponse, int[], boolean) - Method in class com.aoindustries.website.framework.TextOnlyLayout

Prints a horizontal divider of the provided colspan.

printContentHorizontalDivider(ChainWriter, WebSiteRequest, HttpServletResponse, int, boolean) - Method in class com.aoindustries.website.framework.WebPageLayout

Prints a horizontal divider of the provided colspan.

printContentHorizontalDivider(ChainWriter, WebSiteRequest, HttpServletResponse, int[], boolean) - Method in class com.aoindustries.website.framework.WebPageLayout

Prints a horizontal divider of the provided colspan.

printContentStart(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.AutoListPage

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

printContentStart(ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.DescriptionAutoListPage

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

printContentTitle(ChainWriter, WebSiteRequest, HttpServletResponse, String, int) - Method in class com.aoindustries.website.framework.TextOnlyLayout

Prints the title of the page in one row in the content area.

printContentTitle(ChainWriter, WebSiteRequest, HttpServletResponse, WebPage, int) - Method in class com.aoindustries.website.framework.WebPageLayout

Prints the title of the page in one row in the content area.

printContentTitle(ChainWriter, WebSiteRequest, HttpServletResponse, String, int) - Method in class com.aoindustries.website.framework.WebPageLayout

Prints the title of the page in one row in the content area.

printContentVerticalDivider(ChainWriter, WebSiteRequest, HttpServletResponse, int, int, int, String, String) - Method in class com.aoindustries.website.framework.TextOnlyLayout

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

printContentVerticalDivider(ChainWriter, WebSiteRequest, HttpServletResponse, int, int, int, String, String) - Method in class com.aoindustries.website.framework.WebPageLayout

Ends one part of a line and starts the next.

printFile(ChainWriter, File) - Static method in class com.aoindustries.website.framework.FilePage

printFormFields(ChainWriter, int) - Method in class com.aoindustries.website.framework.WebSiteRequest

Prints the hidden variables that contain all of the current settings.

printHiddenField(ChainWriter, int, String, String) - Static method in class com.aoindustries.website.framework.WebSiteRequest

Prints the hidden variables that contain all of the current settings.

printHTML(ChainWriter, WebSiteRequest, HttpServletResponse, WebPageLayout, String, String) - Static method in class com.aoindustries.website.framework.HTMLInputStreamPage

Prints HTML content, parsing for special @ tags.

printHTMLStream(ChainWriter, WebSiteRequest, HttpServletResponse, WebPageLayout, InputStream, String) - Static method in class com.aoindustries.website.framework.HTMLInputStreamPage

printJavaScriptIncludes(WebSiteRequest, HttpServletResponse, ChainWriter, WebPage) - Method in class com.aoindustries.website.framework.WebPageLayout

printLoginForm(WebPage, LoginException, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

Prints the form that is used to login.

printLogo(WebPage, ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.TextOnlyLayout

printPageList(ChainWriter, WebSiteRequest, HttpServletResponse, WebPage[], WebPageLayout) - Static method in class com.aoindustries.website.framework.AutoListPage

Prints a list of pages.

printPageList(ChainWriter, WebSiteRequest, HttpServletResponse, WebPage, WebPageLayout) - Static method in class com.aoindustries.website.framework.AutoListPage

Prints an unordered list of the available pages.

printSearchOutput(WebPage, ChainWriter, WebSiteRequest, HttpServletResponse, String, boolean, List<SearchResult>, String[]) - Method in class com.aoindustries.website.framework.WebPageLayout

Prints the content HTML that shows the output of a search.

printStream(ChainWriter, WebSiteRequest, HttpServletResponse, InputStream) - Method in class com.aoindustries.website.framework.HTMLInputStreamPage

printStream(ChainWriter, WebSiteRequest, HttpServletResponse, InputStream) - Method in class com.aoindustries.website.framework.InputStreamPage

printStreamStatic(ChainWriter, InputStream) - Static method in class com.aoindustries.website.framework.InputStreamPage

printUnauthorizedPage(WebPage, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

Prints the unauthorized page message.

printWebPageLayoutSelector(WebPage, ChainWriter, WebSiteRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPageLayout

ProcessPage - Class in com.aoindustries.website.framework

Pulls information from a native process to be used as the content.

ProcessPage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.ProcessPage

ProcessPage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.ProcessPage

ProcessPage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.ProcessPage

R

RedirectWebPage - Class in com.aoindustries.website.framework

Redirects to the configured URL.

RedirectWebPage(LoggerAccessor, ServletContext, WebPage, String, boolean, String, String, String, String) - Constructor for class com.aoindustries.website.framework.RedirectWebPage

Performs a redirect.

reHTMLPattern - Static variable in class com.aoindustries.website.framework.WebPage

rename(File) - Method in class com.aoindustries.website.framework.WebSiteRequest

replaceHTML(String) - Static method in class com.aoindustries.website.framework.TreePage

reportingDoGet(HttpServletRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

reportingDoGet(HttpServletRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

First, resolves correct instance of WebPage.

reportingDoPost(HttpServletRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

reportingDoPost(HttpServletRequest, HttpServletResponse) - Method in class com.aoindustries.website.framework.WebPage

First, resolves correct instance of WebPage.

reportingGetLastModified(HttpServletRequest) - Method in class com.aoindustries.website.framework.ErrorReportingServlet

reportingGetLastModified(HttpServletRequest) - Method in class com.aoindustries.website.framework.WebPage

First, resolves correct instance of WebPage.

S

search(String[], WebSiteRequest, ArrayList, BetterByteArrayOutputStream, SortedArrayList) - Method in class com.aoindustries.website.framework.DumpURLs

Do not include this in the search results.

search(String[], WebSiteRequest, HttpServletResponse, List<SearchResult>, BetterByteArrayOutputStream, List<WebPage>) - Method in class com.aoindustries.website.framework.WebPage

Searches this WebPage and all of its subordinate pages, returning the matches in a ArrayList with five elements per match.

SearchResult - Class in com.aoindustries.website.framework

Automatically generates a list of all pages.

SearchResult(String, float, String, String, String) - Constructor for class com.aoindustries.website.framework.SearchResult

showInLocationPath(WebSiteRequest) - Method in class com.aoindustries.website.framework.WebPage

Determines if this page will be displayed in the location bar.

sourcePage - Variable in class com.aoindustries.website.framework.WebSiteRequest

standardSearch(String[], WebSiteRequest, HttpServletResponse, List<SearchResult>, BetterByteArrayOutputStream, List<WebPage>) - Method in class com.aoindustries.website.framework.WebPage

The standard implementation of the search functionality.

startContent(ChainWriter, WebSiteRequest, HttpServletResponse, int[], int) - Method in class com.aoindustries.website.framework.TextOnlyLayout

Starts the content area of a page.

startContent(ChainWriter, WebSiteRequest, HttpServletResponse, int, int) - Method in class com.aoindustries.website.framework.WebPageLayout

Starts the content area of a page.

startContent(ChainWriter, WebSiteRequest, HttpServletResponse, int[], int) - Method in class com.aoindustries.website.framework.WebPageLayout

Starts the content area of a page.

startContentLine(ChainWriter, WebSiteRequest, HttpServletResponse, int, String, String) - Method in class com.aoindustries.website.framework.TextOnlyLayout

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

startContentLine(ChainWriter, WebSiteRequest, HttpServletResponse, int, String, String) - Method in class com.aoindustries.website.framework.WebPageLayout

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

startHTML(WebPage, WebSiteRequest, HttpServletResponse, ChainWriter, String) - Method in class com.aoindustries.website.framework.TextOnlyLayout

startHTML(WebPage, WebSiteRequest, HttpServletResponse, ChainWriter, String) - Method in class com.aoindustries.website.framework.WebPageLayout

Writes all of the HTML preceeding the content of the page, whether the page is in a frameset or not.

T

TextOnlyLayout - Class in com.aoindustries.website.framework

The default text-only layout.

TextOnlyLayout(String[]) - Constructor for class com.aoindustries.website.framework.TextOnlyLayout

TREE_LINE_COLOR - Static variable in class com.aoindustries.website.framework.TreePage

The color of the lines.

TreePage - Class in com.aoindustries.website.framework

TreePage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.TreePage

TreePage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.TreePage

TreePage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.TreePage

TREEPAGE_MODE - Static variable in class com.aoindustries.website.framework.TreePage

The parameter name to control the TreePage display mode.

TreePageData - Class in com.aoindustries.website.framework

TreePageData(String, String, String) - Constructor for class com.aoindustries.website.framework.TreePageData

U

UP - Static variable in class com.aoindustries.website.framework.WebPageLayout

Directional references.

UP_AND_DOWN - Static variable in class com.aoindustries.website.framework.WebPageLayout

Directional references.

UploadedFile - Class in com.aoindustries.website.framework

An UploadedFile is a file that has been uploaded by a client request.

UploadedFileTypeMap - Class in com.aoindustries.website.framework

UploadedFileTypeMap(WebSiteUser, ServletContext, LoggerAccessor) - Constructor for class com.aoindustries.website.framework.UploadedFileTypeMap

useCodeFont(WebSiteRequest) - Method in class com.aoindustries.website.framework.TreePage

useEncryption() - Method in class com.aoindustries.website.framework.RedirectWebPage

useEncryption() - Method in class com.aoindustries.website.framework.WebPage

Determines if this page should be sent encrypted.

useNavImage() - Method in class com.aoindustries.website.framework.WebPage

Determines whether or not to display the page in the left navigation.

useSiteMap() - Method in class com.aoindustries.website.framework.WebPage

Determines if this page will be displayed in the standard site map.

useSmoothOutline(WebSiteRequest) - Method in class com.aoindustries.website.framework.TreePage

useWebSiteCaching() - Static method in class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

W

WebPage - Class in com.aoindustries.website.framework

The main web page provides the overall layout of the site.

WebPage(LoggerAccessor) - Constructor for class com.aoindustries.website.framework.WebPage

WebPage(WebSiteRequest) - Constructor for class com.aoindustries.website.framework.WebPage

WebPage(LoggerAccessor, Object) - Constructor for class com.aoindustries.website.framework.WebPage

WebPageClassLoader - Class in com.aoindustries.website.framework

WebPageClassLoader() - Constructor for class com.aoindustries.website.framework.WebPageClassLoader

WebPageLayout - Class in com.aoindustries.website.framework

A WebPageLayout controls how a WebPage looks while providing a little isolation from the code that provides the functionality.

WebPageLayout(String[]) - Constructor for class com.aoindustries.website.framework.WebPageLayout

WebSiteFrameworkConfiguration - Class in com.aoindustries.website.framework

The configuration parameters for the web site are stored in a properties file.

WebSiteFrameworkConfiguration() - Constructor for class com.aoindustries.website.framework.WebSiteFrameworkConfiguration

WebSiteRequest - Class in com.aoindustries.website.framework

A WebSiteSettings contains all the values that a user may customize while they view the web site.

WebSiteRequest(WebPage, HttpServletRequest) - Constructor for class com.aoindustries.website.framework.WebSiteRequest

WebSiteUser - Interface in com.aoindustries.website.framework

Represents an authenticated user.

A B C D E F G H I L M N O P R S T U W