org.minimalj.frontend.page

Class Page

java.lang.Object

org.minimalj.frontend.page.Page

Direct Known Subclasses:

AuthenticationFailedPage, EmptyPage, HtmlPage, ObjectPage, QueryPage, SearchPage, TableFormPage.DetailPage, TablePage

public abstract class Page
extends Object

Pages are one of the building blocks of an application. They are intended to fill the whole space of a window (or simply the display space if the frontend has no windows). Their content is static in contrast to dialogs which are meant to allow inputs.

A page can have a title and a content. Pages are meant to be ContentProvider. Pages are allocated a lot. They should be lightweight! The heavy stuff should be done when calling getContent().

Constructor Summary

Constructors

Constructor and Description
Page()

Method Summary

Modifier and Type	Method and Description
List<Action>	getActions()
abstract Frontend.IContent	getContent()
String	getRoute() Allows the Frontend to make a bookmark or a link for this Page.
String	getTitle()
static boolean	validateRoute(String route) Route String must obey some rules to be valid: no '/' at start or end Only characters or digits or the three characters -_/ are allowed

Methods inherited from class java.lang.Object

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

Constructor Detail

Page

public Page()

Method Detail

getTitle

public String getTitle()

getContent

public abstract Frontend.IContent getContent()

getActions

public List<Action> getActions()

Returns:

List of Action specific to this page and it's content. These Actions can be displayed by the frontend as context menu or at the right side of the page. Actions can be enabled or disabled but not added or removed. Actions can be grouped with an ActionGroup.

getRoute

public String getRoute()

Allows the Frontend to make a bookmark or a link for this Page. Note that the user may see this String (for example in the URL). The parts of the route should be glued together with '/'. For example "person/42". Although there is no explicit limit to the length of the route it should stay human readable.

If the validateRoute method in this class doesn't accept the returned string the route is ignored by the frontend.

Returns:

null if this Page class or object is not routable.

See Also:

Application.createPage(String), validateRoute(String)

validateRoute

public static boolean validateRoute(String route)

Route String must obey some rules to be valid:

• no '/' at start or end
• Only characters or digits or the three characters -_/ are allowed

Parameters:

route - String provided by a page

Returns:

Frontend will accept route or not

See Also:

Base64.getUrlEncoder()