Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- appendEncodedParam(StringBuilder, String, String, boolean) - Static method in class com.aoapps.web.framework.WebSiteRequest
-
Appends an already-encoded parameter to a URL.
- appendParam(StringBuilder, String, String, boolean) - Static method in class com.aoapps.web.framework.WebSiteRequest
-
Appends a parameter to a URL.
- appendParam(StringBuilder, String, String, Set<String>, boolean) - Static method in class com.aoapps.web.framework.WebSiteRequest
-
Appends a parameter to a URL.
- appendParams(StringBuilder, URIParameters, Set<String>, boolean) - Static method in class com.aoapps.web.framework.WebSiteRequest
-
Appends the parameters to a URL.
- appendSettings(Set<String>, boolean, StringBuilder) - Method in class com.aoapps.web.framework.WebSiteRequest
- AutoListPage - Class in com.aoapps.web.framework
-
Automatically generates a list of all pages.
- AutoListPage() - Constructor for class com.aoapps.web.framework.AutoListPage
- AutoSiteMap - Class in com.aoapps.web.framework
-
Automatically builds a site map of the entire site.
- AutoSiteMap() - Constructor for class com.aoapps.web.framework.AutoSiteMap
C
- canAccess(WebSiteUser) - Method in class com.aoapps.web.framework.WebPage
-
Determines if the provided user can access the page.
- com.aoapps.web.framework - module com.aoapps.web.framework
- com.aoapps.web.framework - package com.aoapps.web.framework
- compareTo(SearchResult) - Method in class com.aoapps.web.framework.SearchResult
- configureResources(ServletContext, WebSiteRequest, HttpServletResponse, WebPageLayout, Registry) - Method in class com.aoapps.web.framework.WebPage
-
Configures the page-scope web resources that this page uses.
- configureResources(ServletContext, WebSiteRequest, HttpServletResponse, WebPage, Registry) - Method in class com.aoapps.web.framework.TextOnlyLayout
- configureResources(ServletContext, WebSiteRequest, HttpServletResponse, WebPage, Registry) - Method in class com.aoapps.web.framework.WebPageLayout
-
Configures the request-scope web resources that this layout uses.
- content(WebSiteRequest, HttpServletResponse, WebPage, PC, int[], String, int[], ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content area, invokes the given area body, then ends the content area.
- content(WebSiteRequest, HttpServletResponse, WebPage, PC, int[], String, int[], ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content area, invokes the given area body, then ends the content area.
- content(WebSiteRequest, HttpServletResponse, WebPage, PC, int, String, int, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content area, invokes the given area body, then ends the content area.
- content(WebSiteRequest, HttpServletResponse, WebPage, PC, int, String, int, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content area, invokes the given area body, then ends the content area.
- content(WebSiteRequest, HttpServletResponse, WebPage, PC, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content area, invokes the given area body, then ends the content area.
- content(WebSiteRequest, HttpServletResponse, WebPage, PC, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content area, invokes the given area body, then ends the content area.
- contentHorizontalDivider(WebSiteRequest, HttpServletResponse, ContentEE<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints a horizontal divider.
- contentHorizontalDivider(WebSiteRequest, HttpServletResponse, ContentEE<?>, int[], boolean) - Method in class com.aoapps.web.framework.SearchLayout
- contentHorizontalDivider(WebSiteRequest, HttpServletResponse, ContentEE<?>, int[], boolean) - Method in class com.aoapps.web.framework.TextOnlyLayout
- contentHorizontalDivider(WebSiteRequest, HttpServletResponse, ContentEE<?>, int[], boolean) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints a horizontal divider of the provided colspans.
- contentHorizontalDivider(WebSiteRequest, HttpServletResponse, ContentEE<?>, int, boolean) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints a horizontal divider of the provided colspan.
- contentLine(WebSiteRequest, HttpServletResponse, ContentEE<?>, int, String, String, int, boolean, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content line, invokes the given line body, then ends the content line.
- contentLine(WebSiteRequest, HttpServletResponse, ContentEE<?>, int, String, String, int, boolean, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content line, invokes the given line body, then ends the content line.
- contentLine(WebSiteRequest, HttpServletResponse, ContentEE<?>, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content line, invokes the given line body, then ends the content line.
- contentLine(WebSiteRequest, HttpServletResponse, ContentEE<?>, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts a content line, invokes the given line body, then ends the content line.
- contentTitle(WebSiteRequest, HttpServletResponse, ContentEE<?>, String) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints an entire content line including the provided title.
- contentTitle(WebSiteRequest, HttpServletResponse, ContentEE<?>, String, int) - Method in class com.aoapps.web.framework.SearchLayout
- contentTitle(WebSiteRequest, HttpServletResponse, ContentEE<?>, String, int) - Method in class com.aoapps.web.framework.TextOnlyLayout
- contentTitle(WebSiteRequest, HttpServletResponse, ContentEE<?>, String, int) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints an entire content line including the provided title.
- contentTitle(WebSiteRequest, HttpServletResponse, WebPage, ContentEE<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints an entire content line including the provided title.
- contentTitle(WebSiteRequest, HttpServletResponse, WebPage, ContentEE<?>, int) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints an entire content line including the provided title.
- contentVerticalDivider(WebSiteRequest, HttpServletResponse, FlowContent<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends one part of a line and starts the next.
- contentVerticalDivider(WebSiteRequest, HttpServletResponse, FlowContent<?>, int, int, int, String, String) - Method in class com.aoapps.web.framework.SearchLayout
- contentVerticalDivider(WebSiteRequest, HttpServletResponse, FlowContent<?>, int, int, int, String, String) - Method in class com.aoapps.web.framework.TextOnlyLayout
- contentVerticalDivider(WebSiteRequest, HttpServletResponse, FlowContent<?>, int, int, int, String, String) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends one part of a line and starts the next.
- contextDestroyed(ServletContextEvent) - Method in class com.aoapps.web.framework.TextOnlyLayout.Initializer
- contextDestroyed(ServletContextEvent) - Method in class com.aoapps.web.framework.WebSiteRequest.Initializer
- contextInitialized(ServletContextEvent) - Method in class com.aoapps.web.framework.TextOnlyLayout.Initializer
- contextInitialized(ServletContextEvent) - Method in class com.aoapps.web.framework.WebSiteRequest.Initializer
D
- DescriptionAutoListPage - Class in com.aoapps.web.framework
-
Automatically generates the description along with a list of all pages.
- DescriptionAutoListPage() - Constructor for class com.aoapps.web.framework.DescriptionAutoListPage
- doGet(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.TreePage
- doGet(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Prepares the request then invokes
WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)
. - doGet(WebSiteRequest, HttpServletResponse, DocumentEE) - Method in class com.aoapps.web.framework.AutoSiteMap
-
The content of this page will not be included in the internal search engine.
- doGet(WebSiteRequest, HttpServletResponse, DocumentEE) - Method in class com.aoapps.web.framework.RedirectWebPage
-
Never do GET, redirect-only.
- doGet(WebSiteRequest, HttpServletResponse, DocumentEE) - Method in class com.aoapps.web.framework.WebPage
-
The layout is automatically applied to the page, then
WebPage.doGet(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent)
is called. - doGet(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.AutoListPage
- doGet(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.DumpURLs
- doGet(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.FilePage
- doGet(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.InputStreamPage
- doGet(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.PreFilePage
- doGet(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.RedirectWebPage
-
Never do GET, redirect-only.
- doGet(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.TreePage
- doGet(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.WebPage
-
By default, GET provides no content.
- doGet(HttpServletRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
The main entry point for
GET
requests. - doPage(WebSiteRequest, HttpServletResponse, WebPage, DocumentEE, String, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts the page, invokes the given page body, then ends the page.
- doPage(WebSiteRequest, HttpServletResponse, WebPage, DocumentEE, String, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts the page, invokes the given page body, then ends the page.
- doPost(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.TreePage
- doPost(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Prepares the request then invokes
WebPage.doPost(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.html.servlet.DocumentEE)
. - doPost(WebSiteRequest, HttpServletResponse, DocumentEE) - Method in class com.aoapps.web.framework.RedirectWebPage
-
Never do POST, redirect-only.
- doPost(WebSiteRequest, HttpServletResponse, DocumentEE) - Method in class com.aoapps.web.framework.WebPage
-
The layout is automatically applied to the page, then
WebPage.doPost(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse, com.aoapps.web.framework.WebPageLayout, com.aoapps.html.servlet.FlowContent)
is called. - doPost(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.RedirectWebPage
-
Never do POST, redirect-only.
- doPost(WebSiteRequest, HttpServletResponse, WebPageLayout, __) - Method in class com.aoapps.web.framework.WebPage
- doPost(HttpServletRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
The main entry point for
GET
requests. - doPostWithSearch(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Handles any search posts, sends everything else on to
WebPage.doPost(com.aoapps.web.framework.WebSiteRequest, javax.servlet.http.HttpServletResponse)
. - DOWN - Static variable in class com.aoapps.web.framework.WebPageLayout
-
Directional references.
- DumpURLs - Class in com.aoapps.web.framework
-
Generates a list of all URLs in the site.
- DumpURLs() - Constructor for class com.aoapps.web.framework.DumpURLs
E
- emptyWebPageArray - Static variable in class com.aoapps.web.framework.WebPage
-
An empty array of
WebPage
objects to be used in returning no web pages. - endContent(WebSiteRequest, HttpServletResponse, WebPage, ContentEE<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends the content area of a page.
- endContent(WebSiteRequest, HttpServletResponse, WebPage, ContentEE<?>, int) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends the content area of a page.
- endContent(WebSiteRequest, HttpServletResponse, WebPage, ContentEE<?>, int[]) - Method in class com.aoapps.web.framework.SearchLayout
- endContent(WebSiteRequest, HttpServletResponse, WebPage, ContentEE<?>, int[]) - Method in class com.aoapps.web.framework.TextOnlyLayout
- endContent(WebSiteRequest, HttpServletResponse, WebPage, ContentEE<?>, int[]) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends the content area of a page.
- endContentCopyright(WebSiteRequest, HttpServletResponse, WebPage, TABLE_c<DocumentEE>, int) - Method in class com.aoapps.web.framework.TextOnlyLayout
- endContentLine(WebSiteRequest, HttpServletResponse, FlowContent<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends one line of content.
- endContentLine(WebSiteRequest, HttpServletResponse, FlowContent<?>, int, boolean) - Method in class com.aoapps.web.framework.SearchLayout
- endContentLine(WebSiteRequest, HttpServletResponse, FlowContent<?>, int, boolean) - Method in class com.aoapps.web.framework.TextOnlyLayout
- endContentLine(WebSiteRequest, HttpServletResponse, FlowContent<?>, int, boolean) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends one line of content.
- endLightArea(WebSiteRequest, HttpServletResponse, FlowContent<?>) - Method in class com.aoapps.web.framework.SearchLayout
- endLightArea(WebSiteRequest, HttpServletResponse, FlowContent<?>) - Method in class com.aoapps.web.framework.TextOnlyLayout
- endLightArea(WebSiteRequest, HttpServletResponse, FlowContent<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends a lighter area of the site.
- endPage(WebSiteRequest, HttpServletResponse, WebPage, FlowContent<?>) - Method in class com.aoapps.web.framework.SearchLayout
- endPage(WebSiteRequest, HttpServletResponse, WebPage, FlowContent<?>) - Method in class com.aoapps.web.framework.TextOnlyLayout
- endPage(WebSiteRequest, HttpServletResponse, WebPage, FlowContent<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Writes all of the HTML following the content of the page.
- endWhiteArea(WebSiteRequest, HttpServletResponse, FlowContent<?>) - Method in class com.aoapps.web.framework.SearchLayout
- endWhiteArea(WebSiteRequest, HttpServletResponse, FlowContent<?>) - Method in class com.aoapps.web.framework.TextOnlyLayout
- endWhiteArea(WebSiteRequest, HttpServletResponse, FlowContent<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Ends a white area of the site.
- equals(WebPage) - Method in class com.aoapps.web.framework.WebPage
-
Determines if this page equals another page.
- equals(Object) - Method in class com.aoapps.web.framework.WebPage
-
Determines if this page equals another page.
F
- FilePage - Class in com.aoapps.web.framework
-
Pulls information from a file to be used as the content.
- FilePage() - Constructor for class com.aoapps.web.framework.FilePage
G
- generateUrlPath(WebPage) - Method in class com.aoapps.web.framework.WebPage
-
Generates a URL path for this or another page, please call getUrlPath() instead.
- getActiveLinkColor(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPageLayout
-
The active link color for the page or
-1
for browser default. - getAuthor() - Method in class com.aoapps.web.framework.SearchResult
- getAuthor(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the author of this page.
- getAuthorHref() - Method in class com.aoapps.web.framework.SearchResult
- getAuthorHref(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Gets the URL for the author of this page.
- getAutonli(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the automatic newline and indentation setting to use for this page.
- getBackgroundColor(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPageLayout
-
The background color for the page or
-1
for browser default. - getCachedChildren(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Gets all of the pages that are children of this one in the page hierarchy.
- getChildren(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Gets all of the children pages of this one in the page hierarchy.
- getClassLastModified() - Method in class com.aoapps.web.framework.WebPage
-
Gets the last modified time of the java class file.
- getCommonPages(WebPage, WebSiteRequest) - Method in class com.aoapps.web.framework.TextOnlyLayout
- getContentType() - Method in class com.aoapps.web.framework.UploadedFile
-
Gets the content type for the upload file.
- getContentType(File) - Method in class com.aoapps.web.framework.UploadedFileTypeMap
- getContentType(String) - Method in class com.aoapps.web.framework.UploadedFileTypeMap
- getContentValign(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the vertical alignment of the content area.
- getCopyright(WebSiteRequest, HttpServletResponse, WebPage) - Method in class com.aoapps.web.framework.WebPage
-
Gets the copyright information for this page.
- getCreateTime() - Method in class com.aoapps.web.framework.UploadedFile
-
Gets the create time for the upload file.
- getDescription() - Method in class com.aoapps.web.framework.SearchResult
- getDescription() - Method in class com.aoapps.web.framework.TreePageData
- getDescription(WebSiteRequest) - Method in class com.aoapps.web.framework.DumpURLs
- getDescription(WebSiteRequest) - Method in class com.aoapps.web.framework.RedirectWebPage
- getDescription(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the description of this page.
- getDoctype(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the
Doctype
to use for this page. - getDocument(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Prepares for output and returns the
DocumentEE
. - getEncodedUrl(WebPage, URIParameters, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrl(WebPage, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrl(Class<? extends WebPage>, URIParameters, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrl(Class<? extends WebPage>, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrlForClass(String, URIParameters, String, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrlForClass(String, URIParameters, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrlForClass(String, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrlForPath(String, URIParameters, boolean, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrlForPath(String, URIParameters, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getEncodedUrlForPath(String, HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
- getFastRandom() - Method in class com.aoapps.web.framework.WebSiteRequest
-
A fast pseudo-random number generator for non-cryptographic purposes.
- getFile() - Method in class com.aoapps.web.framework.FilePage
-
Gets the file that the text should be read from.
- getFilename() - Method in class com.aoapps.web.framework.UploadedFile
-
Gets the filename for the upload file.
- getGoogleAnalyticsNewTrackingCode(ServletContext) - Method in class com.aoapps.web.framework.TextOnlyLayout
-
Gets the Google Analytics 4 (GA4) Measurement ID or
null
if unavailable. - getHtmlInputStream(Class<?>) - Static method in class com.aoapps.web.framework.HtmlInputStreamPage
-
Gets the HTML file with the same name as the provided Class or
null
when not found. - getHtmlOutputStream(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Prepares for output and returns the
OutputStream
. - getId() - Method in class com.aoapps.web.framework.UploadedFile
-
Gets the ID for the upload file.
- getIndent(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the indentation setting to use for this page.
- getInputStream() - Method in class com.aoapps.web.framework.HtmlInputStreamPage
-
Gets the file that the text should be read from.
- getInputStream() - Method in class com.aoapps.web.framework.InputStreamPage
-
Gets the stream that the text should be read from.
- getInputStream() - Method in class com.aoapps.web.framework.ProcessPage
- getInstance() - Static method in class com.aoapps.web.framework.SearchLayout
- getJavascriptSrc(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the JavaScript's that should have script src= tags generated, urls relative to top of context
path/to/javascript.js
. - getKeywords(WebSiteRequest) - Method in class com.aoapps.web.framework.DumpURLs
- getKeywords(WebSiteRequest) - Method in class com.aoapps.web.framework.RedirectWebPage
- getKeywords(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the keywords for this page.
- getLastAccessed() - Method in class com.aoapps.web.framework.UploadedFile
-
Gets the last access time for the upload file.
- getLastModified(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.DumpURLs
-
The last modified time is -1 to always reload the list.
- getLastModified(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.FilePage
- getLastModified(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.ProcessPage
- getLastModified(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.TreePage
- getLastModified(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
The
getLastModified
defaults to-1
. - getLastModified(HttpServletRequest) - Method in class com.aoapps.web.framework.WebPage
-
The main entry point for
getLastModified()
requests. - getLastModifiedRecursive(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Recursively gets the most recent modification time.
- getLastModifiedRecursive(File) - Static method in class com.aoapps.web.framework.WebPage
-
Recursively gets the most recent modification time of a file or directory.
- getLayoutChoices() - Method in class com.aoapps.web.framework.WebPageLayout
-
Gets the names of every supported layout.
- getLinkColor(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPageLayout
-
The link color for the page or
-1
for browser default. - getName() - Method in class com.aoapps.web.framework.SearchLayout
- getName() - Method in class com.aoapps.web.framework.TextOnlyLayout
- getName() - Method in class com.aoapps.web.framework.WebPageLayout
-
Each layout has a name.
- getNavImageAlt(WebSiteRequest) - Method in class com.aoapps.web.framework.RedirectWebPage
- getNavImageAlt(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the text for the navigation image to use to represent this page.
- getNavImageSuffix(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the text that will be placed in to the right of the navigation image.
- getNavImageUrl(WebSiteRequest, HttpServletResponse, URIParameters) - Method in class com.aoapps.web.framework.WebPage
-
Gets the URL associated with a nav image, fully encoded.
- getNextPage(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Gets the
WebPage
that follows this one in the parents list of pages. - getOnloadScript(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the JavaScript that should be executed with the onload event of the body tag.
- getOwner() - Method in class com.aoapps.web.framework.UploadedFile
-
Gets the owner for the upload file.
- getPageIndexInParent(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Gets the index of this page in the parents list of children pages.
- getParameter(String) - Method in class com.aoapps.web.framework.WebSiteRequest
- getParameterNames() - Method in class com.aoapps.web.framework.WebSiteRequest
- getParameterValues(String) - Method in class com.aoapps.web.framework.WebSiteRequest
- getParent() - Method in class com.aoapps.web.framework.RedirectWebPage
- getParent() - Method in class com.aoapps.web.framework.WebPage
-
Gets the parent of this page or
null
for none. - getPath() - Method in class com.aoapps.web.framework.TreePageData
- getPreferredContentWidth(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the preferred width of this content or
null
for no preference. - getPreviousPage(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Gets the
WebPage
that proceeds this one in the parents list of pages. - getProbability() - Method in class com.aoapps.web.framework.SearchResult
- getProcess() - Method in class com.aoapps.web.framework.ProcessPage
-
Gets the process that the contents should be read from.
- getRedirectType() - Method in class com.aoapps.web.framework.RedirectWebPage
- getRedirectType() - Method in class com.aoapps.web.framework.WebPage
-
Gets the redirect type, defaults to 302 (temporary).
- getRedirectUrl(WebSiteRequest) - Method in class com.aoapps.web.framework.RedirectWebPage
- getRedirectUrl(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the absolute or context-relative URL to direct to.
- getRootPage() - Method in class com.aoapps.web.framework.WebPage
-
Gets the root page in the web page hierarchy.
- getSearchLastModified() - Method in class com.aoapps.web.framework.DumpURLs
- getSearchLastModified() - Method in class com.aoapps.web.framework.ProcessPage
-
The search format of this page is indexed.
- getSearchLastModified() - Method in class com.aoapps.web.framework.TreePage
- getSearchLastModified() - Method in class com.aoapps.web.framework.WebPage
-
Gets the last modified time for search indexing.
- getSecureRandom() - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the random number generator used for this request.
- getSerialization(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the
Serialization
to use for this page. - getServletContext() - Method in class com.aoapps.web.framework.WebPage
- getShortTitle(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
A short title is used showing a path to the current location in the site.
- getStorageFile() - Method in class com.aoapps.web.framework.UploadedFile
-
Gets the storage file for the upload file.
- getTextColor(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPageLayout
-
The text color for the page or
-1
for browser default. - getTitle() - Method in class com.aoapps.web.framework.SearchResult
- getTitle(WebSiteRequest) - Method in class com.aoapps.web.framework.DumpURLs
- getTitle(WebSiteRequest) - Method in class com.aoapps.web.framework.RedirectWebPage
- getTitle(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the title of the web page in order to generate the HTML.
- getTree(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.AutoSiteMap
- getTree(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.TreePage
-
Gets the tree to be displayed.
- getUploadedFile(WebSiteUser, Identifier, ServletContext) - Static method in class com.aoapps.web.framework.WebSiteRequest
-
Gets a file that was uploaded given its ID.
- getUploadedFiles() - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the set of files uploaded during this request.
- getUptime() - Static method in class com.aoapps.web.framework.WebPage
-
Gets the time the servlet environment was loaded.
- getUrl() - Method in class com.aoapps.web.framework.SearchResult
- getUrl() - Method in class com.aoapps.web.framework.TreePageData
- getUrl(WebPage) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the context-relative URL to a web page.
- getUrl(WebPage, URIParameters) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the context-relative URL to a web page.
- getUrl(Class<? extends WebPage>) - Method in class com.aoapps.web.framework.WebSiteRequest
- getUrl(Class<? extends WebPage>, URIParameters) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the context-relative URL to a web page.
- getUrlForClass(String) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets a context-relative URL from a String containing a classname and optional parameters/fragment.
- getUrlForClass(String, URIParameters) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets a context-relative URL given its classname and optional parameters.
- getUrlForClass(String, URIParameters, String) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets a context-relative URL given its classname and optional parameters/fragment.
- getUrlForPath(String) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the URL String, keeping the current settings.
- getUrlForPath(String, URIParameters) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the URL String with the given parameters embedded, keeping the current settings.
- getUrlForPath(String, URIParameters, boolean) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the context-relative URL, optionally with the settings embedded.
- getUrlParams(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets parameters that are added to the query string of URLs generated for this page.
- getUrlPath() - Method in class com.aoapps.web.framework.RedirectWebPage
- getUrlPath() - Method in class com.aoapps.web.framework.WebPage
-
Gets the context-relative path for the URL.
- getUrlPattern() - Method in class com.aoapps.web.framework.WebPage
-
Gets the URL pattern for this page as used in
web.xml
. - getVisitedLinkColor(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPageLayout
-
The visited link color for the page or
-1
for browser default. - getWebPage(Class<? extends WebPage>) - Method in class com.aoapps.web.framework.WebPage
-
Gets a web page given no parameters.
- getWebPage(Class<? extends WebPage>, URIParameters) - Method in class com.aoapps.web.framework.WebPage
-
Gets a web page with parameters.
- getWebPage(Class<? extends WebPage>, WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets a web page given no parameters.
- getWebPage(ServletContext, Class<? extends WebPage>) - Static method in class com.aoapps.web.framework.WebPage
-
Gets an instance of
WebPage
given theClass
. - getWebPage(ServletContext, Class<? extends WebPage>, URIParameters) - Static method in class com.aoapps.web.framework.WebPage
-
Gets an instance of
WebPage
given theClass
. - getWebPage(ServletContext, Class<? extends WebPage>, WebSiteRequest) - Static method in class com.aoapps.web.framework.WebPage
-
Gets an instance of
WebPage
given theClass
. - getWebPageAndChildrenLastModified(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Gets the most recent last modified time of this page and its immediate children.
- getWebPageLayout(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the current layout for this page.
- getWebSiteRequest(HttpServletRequest) - Method in class com.aoapps.web.framework.RedirectWebPage
- getWebSiteRequest(HttpServletRequest) - Method in class com.aoapps.web.framework.WebPage
-
Gets the
WebSiteRequest
that handles authentication and other details of this site. - getWebSiteUser(HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Gets the person who is logged in or
null
if no login is performed for this request.
H
- hasChildren() - Method in class com.aoapps.web.framework.TreePageData
- hashCode() - Method in class com.aoapps.web.framework.WebPage
-
The default hashcode for a page is the hashcode of its classname.
- HtmlInputStreamPage - Class in com.aoapps.web.framework
-
Pulls the content from a file with the same name and location as the
.class
and.java
but with a.html
extension. - HtmlInputStreamPage() - Constructor for class com.aoapps.web.framework.HtmlInputStreamPage
I
- includeNavImageAsParent() - Method in class com.aoapps.web.framework.WebPage
-
Determine if the nav image for this page should remain visible, even when its children are displayed.
- Initializer() - Constructor for class com.aoapps.web.framework.TextOnlyLayout.Initializer
- Initializer() - Constructor for class com.aoapps.web.framework.WebSiteRequest.Initializer
- InputStreamPage - Class in com.aoapps.web.framework
-
Reads everything from an input stream and puts it into a page.
- InputStreamPage() - Constructor for class com.aoapps.web.framework.InputStreamPage
- isBlackBerry() - Method in class com.aoapps.web.framework.WebSiteRequest
-
Determines if the request is for a BlackBerry browser.
- isHandler(URIParameters) - Method in class com.aoapps.web.framework.WebPage
-
Determines if this page is the instance that represents a certain set of parameters.
- isHandler(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Determines if this page is the instance that should handle a particular request.
- isLinux() - Method in class com.aoapps.web.framework.WebSiteRequest
-
Determines if the request is for a Linux browser.
- isLoggedIn() - Method in class com.aoapps.web.framework.WebSiteRequest
-
Determines if the user is currently logged in.
- isLynx() - Method in class com.aoapps.web.framework.WebSiteRequest
-
Determines if the request is for a Lynx browser.
- isVisible(WebPage) - Method in class com.aoapps.web.framework.AutoSiteMap
-
Determines if a page should be visible in the generated maps.
L
- LAYOUT - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter that selects the
WebPageLayout
. - LAYOUT_TEXT_CSS - Static variable in class com.aoapps.web.framework.TextOnlyLayout
- lightArea(WebSiteRequest, HttpServletResponse, PC, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a light area, invokes the given area body, then ends the light area.
- lightArea(WebSiteRequest, HttpServletResponse, PC, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a light area, invokes the given area body, then ends the light area.
- lightArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a light area, invokes the given area body, then ends the light area.
- lightArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a light area, invokes the given area body, then ends the light area.
- loadClass(String) - Static method in class com.aoapps.web.framework.WebPage
-
Dynamically loads new classes based on the source .class file's modified time.
- LOGIN_PASSWORD - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter that contains the login password during authentication.
- LOGIN_REQUESTED - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter name used for login requests.
- LOGIN_USERNAME - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter that contains the login username during authentication.
- logout(HttpServletResponse) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Logs out the current user or does nothing if not logged in.
- LOGOUT_REQUESTED - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter name used for logout requests.
M
- MODE_AUTO - Static variable in class com.aoapps.web.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.aoapps.web.framework.TreePage
-
Indicates the TreePage should display its contents in an interactive format.
- MODE_TEXT - Static variable in class com.aoapps.web.framework.TreePage
-
Indicates the TreePage should display its contents in a text-only format.
N
- NAME - Static variable in class com.aoapps.web.framework.TextOnlyLayout
- NONE - Static variable in class com.aoapps.web.framework.WebPageLayout
-
Directional references.
- NUM_COLS - Static variable in class com.aoapps.web.framework.AutoListPage
-
The number of columns in each row.
P
- PreFilePage - Class in com.aoapps.web.framework
-
Pulls the page contents from a file while wrapping it with a PRE block.
- PreFilePage() - Constructor for class com.aoapps.web.framework.PreFilePage
- PreProcessPage - Class in com.aoapps.web.framework
-
Takes the output of a native process and puts it in a PRE block.
- PreProcessPage() - Constructor for class com.aoapps.web.framework.PreProcessPage
- printBelowRelatedPages(__, WebSiteRequest) - Method in class com.aoapps.web.framework.TextOnlyLayout
-
Prints content below the related pages area on the left.
- printContentStart(WebSiteRequest, HttpServletResponse, WebPageLayout, ContentEE<?>, __) - Method in class com.aoapps.web.framework.AutoListPage
-
Prints the content that will be put before the auto-generated list.
- printContentStart(WebSiteRequest, HttpServletResponse, WebPageLayout, ContentEE<?>, __) - Method in class com.aoapps.web.framework.DescriptionAutoListPage
-
Prints the content that will be put before the auto-generated list.
- printFile(Content<?, ?>, File) - Static method in class com.aoapps.web.framework.FilePage
- printFormFields(__) - Method in class com.aoapps.web.framework.WebSiteRequest
-
Prints the hidden variables that contain all of the current settings.
- printHtml(WebSiteRequest, HttpServletResponse, WebPageLayout, ContentEE<?>, __, String, String, AtomicReference<FlowContent<?>>) - Static method in class com.aoapps.web.framework.HtmlInputStreamPage
-
Prints HTML content, parsing for special
@
tags. - printHtmlStream(WebSiteRequest, HttpServletResponse, WebPageLayout, ContentEE<?>, __, InputStream, String, AtomicReference<FlowContent<?>>) - Static method in class com.aoapps.web.framework.HtmlInputStreamPage
-
Prints HTML with template substitutions.
- printJavascriptIncludes(WebSiteRequest, HttpServletResponse, WebPage, __) - Method in class com.aoapps.web.framework.SearchLayout
- printJavascriptIncludes(WebSiteRequest, HttpServletResponse, WebPage, __) - Method in class com.aoapps.web.framework.WebPageLayout
- printLoginForm(WebPage, LoginException, WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Prints the form that is used to login.
- printLogo(WebSiteRequest, HttpServletResponse, WebPage, __) - Method in class com.aoapps.web.framework.TextOnlyLayout
- printPageList(Union_TBODY_THEAD_TFOOT<?>, WebSiteRequest, HttpServletResponse, WebPage[], WebPageLayout) - Static method in class com.aoapps.web.framework.AutoListPage
-
Prints a list of pages.
- printPageList(Union_TBODY_THEAD_TFOOT<?>, WebSiteRequest, HttpServletResponse, WebPage, WebPageLayout) - Static method in class com.aoapps.web.framework.AutoListPage
-
Prints an unordered list of the available pages.
- printSearchOutput(WebSiteRequest, HttpServletResponse, WebPage, __, String, boolean, List<SearchResult>, String[]) - Method in class com.aoapps.web.framework.SearchLayout
- printSearchOutput(WebSiteRequest, HttpServletResponse, WebPage, __, String, boolean, List<SearchResult>, String[]) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints the content HTML that shows the output of a search.
- printStream(WebSiteRequest, HttpServletResponse, WebPageLayout, ContentEE<?>, __, InputStream) - Method in class com.aoapps.web.framework.HtmlInputStreamPage
- printStream(WebSiteRequest, HttpServletResponse, WebPageLayout, ContentEE<?>, __, InputStream) - Method in class com.aoapps.web.framework.InputStreamPage
-
Stream input to servlet output.
- printStream(WebSiteRequest, HttpServletResponse, WebPageLayout, ContentEE<?>, __, InputStream) - Method in class com.aoapps.web.framework.PreProcessPage
- printStreamStatic(Content<?, ?>, InputStream) - Static method in class com.aoapps.web.framework.InputStreamPage
- printUnauthorizedPage(WebPage, WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Prints the unauthorized page message.
- printWebPageLayoutSelector(WebSiteRequest, HttpServletResponse, WebPage, __) - Method in class com.aoapps.web.framework.SearchLayout
- printWebPageLayoutSelector(WebSiteRequest, HttpServletResponse, WebPage, __) - Method in class com.aoapps.web.framework.WebPageLayout
-
Prints the layout selector.
- ProcessPage - Class in com.aoapps.web.framework
-
Pulls information from a native process to be used as the content.
- ProcessPage() - Constructor for class com.aoapps.web.framework.ProcessPage
R
- RedirectWebPage - Class in com.aoapps.web.framework
-
Redirects to the configured URL.
- RedirectWebPage(ServletContext, WebPage, String, int, String, String, String, String) - Constructor for class com.aoapps.web.framework.RedirectWebPage
-
Performs a redirect.
- reHTMLPattern - Static variable in class com.aoapps.web.framework.WebPage
- RESOURCE_GROUP - Static variable in class com.aoapps.web.framework.TextOnlyLayout
-
The name of the application-scope group that will be used for text layout web resources.
S
- search(String[], WebSiteRequest, HttpServletResponse, List<SearchResult>, CharArrayWriter, Set<WebPage>) - Method in class com.aoapps.web.framework.DumpURLs
-
Do not include this in the search results.
- search(String[], WebSiteRequest, HttpServletResponse, List<SearchResult>, CharArrayWriter, Set<WebPage>) - Method in class com.aoapps.web.framework.WebPage
-
Searches this WebPage and all of its subordinate pages, returning the matches in a
ArrayList
with five elements per match. - SEARCH_ENTIRE_SITE - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter value for
WebSiteRequest.SEARCH_TARGET
to search the entire site. - SEARCH_QUERY - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter the contains the search query for in-site search on the current page.
- SEARCH_TARGET - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter that contains the search target (current
WebSiteRequest.SEARCH_ENTIRE_SITE
orWebSiteRequest.SEARCH_THIS_AREA
). - SEARCH_THIS_AREA - Static variable in class com.aoapps.web.framework.WebSiteRequest
-
Parameter value for
WebSiteRequest.SEARCH_TARGET
to search the current area of the site. - SEARCH_TWO - Static variable in class com.aoapps.web.framework.WebPage
-
The name of the search form during per-page searches.
- SearchLayout - Class in com.aoapps.web.framework
-
The layout to be used during search sub-requests.
- SearchLayout() - Constructor for class com.aoapps.web.framework.SearchLayout
- SearchResult - Class in com.aoapps.web.framework
-
Automatically generates a list of all pages.
- SearchResult(String, float, String, String, String, String) - Constructor for class com.aoapps.web.framework.SearchResult
-
Creates a new search result.
- service(HttpServletRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Stores the current response in a request attribute named
WebPage.RESPONSE_REQUEST_ATTRIBUTE
. - setHeaders(WebSiteRequest, HttpServletResponse) - Method in class com.aoapps.web.framework.WebPage
-
Sets headers for this page.
- showInLocationPath(WebSiteRequest) - Method in class com.aoapps.web.framework.WebPage
-
Determines if this page will be displayed in the location bar.
- sourcePage - Variable in class com.aoapps.web.framework.WebSiteRequest
- standardSearch(String[], WebSiteRequest, HttpServletResponse, List<SearchResult>, CharArrayWriter, Set<WebPage>) - Method in class com.aoapps.web.framework.WebPage
-
The standard implementation of the search functionality.
- startContent(WebSiteRequest, HttpServletResponse, WebPage, PC) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts the content area of a page.
- startContent(WebSiteRequest, HttpServletResponse, WebPage, PC, int[], String) - Method in class com.aoapps.web.framework.SearchLayout
- startContent(WebSiteRequest, HttpServletResponse, WebPage, PC, int[], String) - Method in class com.aoapps.web.framework.TextOnlyLayout
- startContent(WebSiteRequest, HttpServletResponse, WebPage, PC, int[], String) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts the content area of a page.
- startContent(WebSiteRequest, HttpServletResponse, WebPage, PC, int, String) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts the content area of a page.
- startContentLine(WebSiteRequest, HttpServletResponse, ContentEE<?>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts one line of content with the initial colspan set to the provided colspan.
- startContentLine(WebSiteRequest, HttpServletResponse, ContentEE<?>, int, String, String) - Method in class com.aoapps.web.framework.SearchLayout
- startContentLine(WebSiteRequest, HttpServletResponse, ContentEE<?>, int, String, String) - Method in class com.aoapps.web.framework.TextOnlyLayout
- startContentLine(WebSiteRequest, HttpServletResponse, ContentEE<?>, int, String, String) - Method in class com.aoapps.web.framework.WebPageLayout
-
Starts one line of content with the initial colspan set to the provided colspan.
- startLightArea(WebSiteRequest, HttpServletResponse, PC) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a lighter colored area of the site.
- startLightArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean) - Method in class com.aoapps.web.framework.SearchLayout
- startLightArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean) - Method in class com.aoapps.web.framework.TextOnlyLayout
- startLightArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a lighter colored area of the site.
- startPage(WebSiteRequest, HttpServletResponse, WebPage, DocumentEE, String) - Method in class com.aoapps.web.framework.SearchLayout
- startPage(WebSiteRequest, HttpServletResponse, WebPage, DocumentEE, String) - Method in class com.aoapps.web.framework.TextOnlyLayout
- startPage(WebSiteRequest, HttpServletResponse, WebPage, DocumentEE, String) - Method in class com.aoapps.web.framework.WebPageLayout
-
Writes all of the HTML preceding the content of the page.
- startWhiteArea(WebSiteRequest, HttpServletResponse, PC) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a white area of the site.
- startWhiteArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean) - Method in class com.aoapps.web.framework.SearchLayout
- startWhiteArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean) - Method in class com.aoapps.web.framework.TextOnlyLayout
- startWhiteArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a white area of the site.
T
- TextOnlyLayout - Class in com.aoapps.web.framework
-
The default text-only layout.
- TextOnlyLayout(String[]) - Constructor for class com.aoapps.web.framework.TextOnlyLayout
- TextOnlyLayout.Initializer - Class in com.aoapps.web.framework
-
Registers the text layout styles in
RegistryEE
. - TREE_LINE_COLOR - Static variable in class com.aoapps.web.framework.TreePage
-
The color of the lines.
- TreePage - Class in com.aoapps.web.framework
-
A tree page creates a user interactive hierarchical representation of the site tree structure.
- TreePage() - Constructor for class com.aoapps.web.framework.TreePage
- TREEPAGE_MODE - Static variable in class com.aoapps.web.framework.TreePage
-
The parameter name to control the TreePage display mode.
- TreePageData - Class in com.aoapps.web.framework
-
Models data used for one page in the page tree.
- TreePageData(String, String, boolean, String...) - Constructor for class com.aoapps.web.framework.TreePageData
-
Creates new tree page data.
- TreePageData(String, String, boolean, Collection<String>) - Constructor for class com.aoapps.web.framework.TreePageData
-
Creates new tree page data.
U
- UP - Static variable in class com.aoapps.web.framework.WebPageLayout
-
Directional references.
- UP_AND_DOWN - Static variable in class com.aoapps.web.framework.WebPageLayout
-
Directional references.
- UploadedFile - Class in com.aoapps.web.framework
-
An
UploadedFile
is a file that has been uploaded by a client request. - UploadedFileTypeMap - Class in com.aoapps.web.framework
-
A mapping used for managing upload file content types.
- UploadedFileTypeMap(WebSiteUser, ServletContext) - Constructor for class com.aoapps.web.framework.UploadedFileTypeMap
- useCodeFont(WebSiteRequest) - Method in class com.aoapps.web.framework.TreePage
- useNavImage() - Method in class com.aoapps.web.framework.WebPage
-
Determines whether or not to display the page in the left navigation.
- useSiteMap() - Method in class com.aoapps.web.framework.WebPage
-
Determines if this page will be displayed in the standard site map.
- useSmoothOutline(WebSiteRequest) - Method in class com.aoapps.web.framework.TreePage
W
- WebPage - Class in com.aoapps.web.framework
-
The main web page provides the overall layout of the site.
- WebPage() - Constructor for class com.aoapps.web.framework.WebPage
- WebPageLayout - Class in com.aoapps.web.framework
-
A
WebPageLayout
controls how aWebPage
looks while providing a little isolation from the code that provides the functionality. - WebPageLayout(String[]) - Constructor for class com.aoapps.web.framework.WebPageLayout
- WebSiteRequest - Class in com.aoapps.web.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.aoapps.web.framework.WebSiteRequest
-
Creates a new website request wrapper.
- WebSiteRequest.Initializer - Class in com.aoapps.web.framework
-
Shuts-down background clean-up thread on application stop.
- WebSiteUser - Interface in com.aoapps.web.framework
-
Represents an authenticated user.
- whiteArea(WebSiteRequest, HttpServletResponse, PC, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a white area, invokes the given area body, then ends the white area.
- whiteArea(WebSiteRequest, HttpServletResponse, PC, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a white area, invokes the given area body, then ends the white area.
- whiteArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean, ServletConsumerE<? super __, Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a white area, invokes the given area body, then ends the white area.
- whiteArea(WebSiteRequest, HttpServletResponse, PC, String, String, boolean, ServletRunnableE<Ex>) - Method in class com.aoapps.web.framework.WebPageLayout
-
Begins a white area, invokes the given area body, then ends the white area.
- writeBodyColorStyle(WebPageLayout, WebSiteRequest, HEAD__<?>) - Static method in class com.aoapps.web.framework.TextOnlyLayout
-
Writes the body color CSS stylesheet, if needed.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form