org.apache.click.examples.page.cayenne

Class FormTablePage

java.lang.Object

org.apache.click.Page

org.apache.click.examples.page.BorderPage

org.apache.click.examples.page.cayenne.FormTablePage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AccommodationDemo, CayenneFormPage, EnrollmentDemo, TabbedCayenneFormPage

public abstract class FormTablePage
extends BorderPage

Provides an abstract CayenneForm and Table Page for creating and editing DataObjects.

Subclasses must implement the abstract methods:

• getDataObjectClass() - to define the DataObject class to edit
• getDataObject(Object) - to look up the DataObject for the given id
• getRowList() - to provide the table the list of DataObject to display

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionLink	editLink
protected org.apache.click.extras.cayenne.CayenneForm	form
protected ActionLink	removeLink
protected Table	table

Fields inherited from class org.apache.click.Page

controls, format, forward, headElements, headers, includeControlHeadElements, messages, model, PAGE_ACTION, PAGE_MESSAGES, pageImports, path, redirect, stateful, template

Constructor Summary

Constructors

Constructor and Description
FormTablePage() Create a FormTablePage instance and initialize the form and table properties.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the form dataObject and any errors it might have.
org.apache.click.extras.cayenne.CayenneForm	createForm() Return a new CayenneForm instance.
void	deleteDataObject(org.apache.cayenne.DataObject dataObject) Delete the given DataObject.
abstract org.apache.cayenne.DataObject	getDataObject(Object id) Return the DataObject for the given id.
abstract Class	getDataObjectClass() Return the DataObject class to edit and display.
int	getMaxTableSize() Return the maximum number of rows to display in the table.
abstract List	getRowList() Return the list of DataObjects to display in the table.
boolean	onCancelClick() The cancel event handler.
boolean	onEditClick() The edit event handler.
void	onInit() Complete the initialization of the form and table controls.
boolean	onRemoveClick() The remove event handler.
void	onRender()
boolean	onSaveClick() The save event handler.
boolean	onSecurityCheck() Perform a form submission check to ensure the form was not double posted.
void	saveDataObject(org.apache.cayenne.DataObject dataObject) Save the given DataObject.

Methods inherited from class org.apache.click.examples.page.BorderPage

getTemplate, onDestroy

Methods inherited from class org.apache.click.Page

addControl, addModel, getContentType, getContext, getControls, getFormat, getForward, getHeadElements, getHeaders, getHtmlImports, getMessage, getMessage, getMessages, getModel, getPageImports, getPath, getRedirect, hasControls, hasHeaders, isIncludeControlHeadElements, isStateful, onGet, onPost, removeControl, setFormat, setForward, setForward, setForward, setHeader, setHeaders, setIncludeControlHeadElements, setPageImports, setPath, setRedirect, setRedirect, setRedirect, setRedirect, setStateful, setTemplate

Methods inherited from class java.lang.Object

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

Field Detail

form

protected org.apache.click.extras.cayenne.CayenneForm form

table

protected Table table

editLink

protected ActionLink editLink

removeLink

protected ActionLink removeLink

Constructor Detail

FormTablePage

public FormTablePage()

Create a FormTablePage instance and initialize the form and table properties.

Method Detail

onSecurityCheck

public boolean onSecurityCheck()

Perform a form submission check to ensure the form was not double posted.

Overrides:

onSecurityCheck in class Page

See Also:

Page.onSecurityCheck()

onInit

public void onInit()

Complete the initialization of the form and table controls.

Overrides:

onInit in class BorderPage

See Also:

Page.onInit()

onSaveClick

public boolean onSaveClick()

The save event handler.

Returns:

true if processing should continue, false otherwise

onCancelClick

public boolean onCancelClick()

The cancel event handler.

Returns:

true if processing should continue, false otherwise

onEditClick

public boolean onEditClick()

The edit event handler.

Returns:

true if processing should continue, false otherwise

onRemoveClick

public boolean onRemoveClick()

The remove event handler.

Returns:

true if processing should continue, false otherwise

clear

public void clear()

Clear the form dataObject and any errors it might have.

onRender

public void onRender()

Overrides:

onRender in class Page

See Also:

Page.onRender()

getDataObject

public abstract org.apache.cayenne.DataObject getDataObject(Object id)

Return the DataObject for the given id.

Parameters:

id - the DataObject identifier

Returns:

the DataObject for the given id

getDataObjectClass

public abstract Class getDataObjectClass()

Return the DataObject class to edit and display.

Returns:

the DataObject class to edit and display

getRowList

public abstract List getRowList()

Return the list of DataObjects to display in the table.

Returns:

the list of DataObject to display in the table

createForm

public org.apache.click.extras.cayenne.CayenneForm createForm()

Return a new CayenneForm instance. This method is invoked in the FormTablePage constructor.

Returns:

a new CayenneForm instance

saveDataObject

public void saveDataObject(org.apache.cayenne.DataObject dataObject)

Save the given DataObject.

Parameters:

dataObject - the DataObject to save

deleteDataObject

public void deleteDataObject(org.apache.cayenne.DataObject dataObject)

Delete the given DataObject.

Parameters:

dataObject - the DataObject to delete

getMaxTableSize

public int getMaxTableSize()

Return the maximum number of rows to display in the table. Subclasses should override this method to display a different number of rows.

Returns:

the maximum number of rows to display in the table