Uses of Class
com.aoapps.web.framework.WebPage

Uses of WebPage in com.aoapps.web.framework

Subclasses of WebPage in com.aoapps.web.framework

Modifier and Type	Class	Description
class	AutoListPage	Automatically generates a list of all pages.
class	AutoSiteMap	Automatically builds a site map of the entire site.
class	DescriptionAutoListPage	Automatically generates the description along with a list of all pages.
class	DumpURLs	Generates a list of all URLs in the site.
class	FilePage	Pulls information from a file to be used as the content.
class	HtmlInputStreamPage	Pulls the content from a file with the same name and location as the .class and .java but with a .html extension.
class	InputStreamPage	Reads everything from an input stream and puts it into a page.
class	PreFilePage	Pulls the page contents from a file while wrapping it with a PRE block.
class	PreProcessPage	Takes the output of a native process and puts it in a PRE block.
class	ProcessPage	Pulls information from a native process to be used as the content.
class	RedirectWebPage	Redirects to the configured URL.
class	TreePage	A tree page creates a user interactive hierarchical representation of the site tree structure.

Fields in com.aoapps.web.framework declared as WebPage

Modifier and Type	Field	Description
protected static final WebPage[]	WebPage.emptyWebPageArray	An empty array of WebPage objects to be used in returning no web pages.
protected final WebPage	WebSiteRequest.sourcePage

Methods in com.aoapps.web.framework that return WebPage

Modifier and Type	Method	Description
WebPage[]	WebPage.getCachedChildren(WebSiteRequest req, HttpServletResponse resp)	Gets all of the pages that are children of this one in the page hierarchy.
protected WebPage[]	WebPage.getChildren(WebSiteRequest req, HttpServletResponse resp)	Gets all of the children pages of this one in the page hierarchy.
WebPage[]	TextOnlyLayout.getCommonPages(WebPage page, WebSiteRequest req)
final WebPage	WebPage.getNextPage(WebSiteRequest req, HttpServletResponse resp)	Gets the WebPage that follows this one in the parents list of pages.
WebPage	RedirectWebPage.getParent()
abstract WebPage	WebPage.getParent()	Gets the parent of this page or null for none.
final WebPage	WebPage.getPreviousPage(WebSiteRequest req, HttpServletResponse resp)	Gets the WebPage that proceeds this one in the parents list of pages.
final WebPage	WebPage.getRootPage()	Gets the root page in the web page hierarchy.
WebPage	WebPage.getWebPage(Class<? extends WebPage> clazz)	Gets a web page given no parameters.
WebPage	WebPage.getWebPage(Class<? extends WebPage> clazz, URIParameters params)	Gets a web page with parameters.
WebPage	WebPage.getWebPage(Class<? extends WebPage> clazz, WebSiteRequest req)	Gets a web page given no parameters.
static WebPage	WebPage.getWebPage(ServletContext context, Class<? extends WebPage> clazz)	Gets an instance of WebPage given the Class.
static WebPage	WebPage.getWebPage(ServletContext context, Class<? extends WebPage> clazz, URIParameters params)	Gets an instance of WebPage given the Class.
static WebPage	WebPage.getWebPage(ServletContext context, Class<? extends WebPage> clazz, WebSiteRequest req)	Gets an instance of WebPage given the Class.

Methods in com.aoapps.web.framework that return types with arguments of type WebPage

Modifier and Type	Method	Description
static Class<? extends WebPage>	WebPage.loadClass(String className)	Dynamically loads new classes based on the source .class file's modified time.

Methods in com.aoapps.web.framework with parameters of type WebPage

Modifier and Type	Method	Description
void	TextOnlyLayout.configureResources(ServletContext servletContext, WebSiteRequest req, HttpServletResponse resp, WebPage page, Registry requestRegistry)
void	WebPageLayout.configureResources(ServletContext servletContext, WebSiteRequest req, HttpServletResponse resp, WebPage page, Registry requestRegistry)	Configures the request-scope web resources that this layout uses.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	WebPageLayout.content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int[] startContentColumnSpans, String width, int[] endContentColumnSpans, ServletConsumerE<? super __,Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	WebPageLayout.content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int[] startContentColumnSpans, String width, int[] endContentColumnSpans, ServletRunnableE<Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	WebPageLayout.content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int startContentColumns, String width, int endContentColumns, ServletConsumerE<? super __,Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	WebPageLayout.content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int startContentColumns, String width, int endContentColumns, ServletRunnableE<Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	WebPageLayout.content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, ServletConsumerE<? super __,Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>, Ex extends Throwable> void	WebPageLayout.content(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, ServletRunnableE<Ex> content)	Starts a content area, invokes the given area body, then ends the content area.
final void	WebPageLayout.contentTitle(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content)	Prints an entire content line including the provided title.
final void	WebPageLayout.contentTitle(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int contentColumns)	Prints an entire content line including the provided title.
final <__ extends FlowContent<__>, Ex extends Throwable> void	WebPageLayout.doPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload, ServletConsumerE<? super __,Ex> body)	Starts the page, invokes the given page body, then ends the page.
final <Ex extends Throwable> void	WebPageLayout.doPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload, ServletRunnableE<Ex> body)	Starts the page, invokes the given page body, then ends the page.
void	SearchLayout.endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int[] contentColumnSpans)
void	TextOnlyLayout.endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int[] contentColumnSpans)
final void	WebPageLayout.endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content)	Ends the content area of a page.
final void	WebPageLayout.endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int contentColumns)	Ends the content area of a page.
abstract void	WebPageLayout.endContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, ContentEE<?> content, int[] contentColumnSpans)	Ends the content area of a page.
protected void	TextOnlyLayout.endContentCopyright(WebSiteRequest req, HttpServletResponse resp, WebPage page, TABLE_c<DocumentEE> table, int totalColumns)
void	SearchLayout.endPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, FlowContent<?> flow)
void	TextOnlyLayout.endPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, FlowContent<?> flow)
abstract void	WebPageLayout.endPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, FlowContent<?> flow)	Writes all of the HTML following the content of the page.
boolean	WebPage.equals(WebPage other)	Determines if this page equals another page.
String	WebPage.generateUrlPath(WebPage page)	Generates a URL path for this or another page, please call getUrlPath() instead.
WebPage[]	TextOnlyLayout.getCommonPages(WebPage page, WebSiteRequest req)
String	WebPage.getCopyright(WebSiteRequest req, HttpServletResponse resp, WebPage requestPage)	Gets the copyright information for this page.
String	WebSiteRequest.getEncodedUrl(WebPage page, URIParameters params, HttpServletResponse resp)	Gets the URL.
String	WebSiteRequest.getEncodedUrl(WebPage page, HttpServletResponse resp)	Gets the URL.
String	WebSiteRequest.getUrl(WebPage page)	Gets the context-relative URL to a web page.
String	WebSiteRequest.getUrl(WebPage page, URIParameters params)	Gets the context-relative URL to a web page.
protected abstract boolean	AutoSiteMap.isVisible(WebPage page)	Determines if a page should be visible in the generated maps.
protected <__ extends ScriptSupportingContent<__>> void	SearchLayout.printJavascriptIncludes(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ content)
protected <__ extends ScriptSupportingContent<__>> void	WebPageLayout.printJavascriptIncludes(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ content)
void	WebPage.printLoginForm(WebPage page, LoginException loginException, WebSiteRequest req, HttpServletResponse resp)	Prints the form that is used to login.
<__ extends FlowContent<__>> void	TextOnlyLayout.printLogo(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ td)
static void	AutoListPage.printPageList(Union_TBODY_THEAD_TFOOT<?> tbody, WebSiteRequest req, HttpServletResponse resp, WebPage[] pages, WebPageLayout layout)	Prints a list of pages.
static void	AutoListPage.printPageList(Union_TBODY_THEAD_TFOOT<?> tbody, WebSiteRequest req, HttpServletResponse resp, WebPage parent, WebPageLayout layout)	Prints an unordered list of the available pages.
final <__ extends FlowContent<__>> void	SearchLayout.printSearchOutput(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ flow, String query, boolean isEntireSite, List<SearchResult> results, String[] words)
<__ extends FlowContent<__>> void	WebPageLayout.printSearchOutput(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ flow, String query, boolean isEntireSite, List<SearchResult> results, String[] words)	Prints the content HTML that shows the output of a search.
void	WebPage.printUnauthorizedPage(WebPage page, WebSiteRequest req, HttpServletResponse resp)	Prints the unauthorized page message.
final <__ extends FlowContent<__>> boolean	SearchLayout.printWebPageLayoutSelector(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ flow)
<__ extends FlowContent<__>> boolean	WebPageLayout.printWebPageLayoutSelector(WebSiteRequest req, HttpServletResponse resp, WebPage page, __ flow)	Prints the layout selector.
<PC extends FlowContent<PC>, __ extends ContentEE<__>> __	SearchLayout.startContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int[] contentColumnSpans, String width)
<PC extends FlowContent<PC>, __ extends ContentEE<__>> __	TextOnlyLayout.startContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int[] contentColumnSpans, String width)
final <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	WebPageLayout.startContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc)	Starts the content area of a page.
abstract <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	WebPageLayout.startContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int[] contentColumnSpans, String width)	Starts the content area of a page.
final <PC extends FlowContent<PC>, __ extends ContentEE<__>> __	WebPageLayout.startContent(WebSiteRequest req, HttpServletResponse resp, WebPage page, PC pc, int contentColumns, String width)	Starts the content area of a page.
<__ extends FlowContent<__>> __	SearchLayout.startPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload)
<__ extends FlowContent<__>> __	TextOnlyLayout.startPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload)
abstract <__ extends FlowContent<__>> __	WebPageLayout.startPage(WebSiteRequest req, HttpServletResponse resp, WebPage page, DocumentEE document, String onload)	Writes all of the HTML preceding the content of the page.

Method parameters in com.aoapps.web.framework with type arguments of type WebPage

Modifier and Type	Method	Description
String	WebSiteRequest.getEncodedUrl(Class<? extends WebPage> clazz, URIParameters params, HttpServletResponse resp)	Gets the URL.
String	WebSiteRequest.getEncodedUrl(Class<? extends WebPage> clazz, HttpServletResponse resp)	Gets the URL.
String	WebSiteRequest.getUrl(Class<? extends WebPage> clazz)
String	WebSiteRequest.getUrl(Class<? extends WebPage> clazz, URIParameters params)	Gets the context-relative URL to a web page.
WebPage	WebPage.getWebPage(Class<? extends WebPage> clazz)	Gets a web page given no parameters.
WebPage	WebPage.getWebPage(Class<? extends WebPage> clazz, URIParameters params)	Gets a web page with parameters.
WebPage	WebPage.getWebPage(Class<? extends WebPage> clazz, WebSiteRequest req)	Gets a web page given no parameters.
static WebPage	WebPage.getWebPage(ServletContext context, Class<? extends WebPage> clazz)	Gets an instance of WebPage given the Class.
static WebPage	WebPage.getWebPage(ServletContext context, Class<? extends WebPage> clazz, URIParameters params)	Gets an instance of WebPage given the Class.
static WebPage	WebPage.getWebPage(ServletContext context, Class<? extends WebPage> clazz, WebSiteRequest req)	Gets an instance of WebPage given the Class.
void	DumpURLs.search(String[] words, WebSiteRequest req, HttpServletResponse response, List<SearchResult> results, CharArrayWriter buffer, Set<WebPage> finishedPages)	Do not include this in the search results.
void	WebPage.search(String[] words, WebSiteRequest req, HttpServletResponse response, List<SearchResult> results, CharArrayWriter buffer, Set<WebPage> finishedPages)	Searches this WebPage and all of its subordinate pages, returning the matches in a ArrayList with five elements per match.
final void	WebPage.standardSearch(String[] words, WebSiteRequest req, HttpServletResponse resp, List<SearchResult> results, CharArrayWriter buffer, Set<WebPage> finishedPages)	The standard implementation of the search functionality.

Constructors in com.aoapps.web.framework with parameters of type WebPage

Modifier	Constructor	Description
	RedirectWebPage(ServletContext context, WebPage parent, String path, int redirectType, String description, String keywords, String navImageAlt, String title)	Performs a redirect.
	WebSiteRequest(WebPage sourcePage, HttpServletRequest req)	Creates a new website request wrapper.