Property and Event Reference



Chapter 3   Page Events

List of events   Top of page

Here are the page events:

cursorChanged
cursorPreChange
dataReceivedAsync
dataReloaded
eventLinkPerformed
fileUploaded
globalValidationFailed
globalValidationTest

handlePageException
pageActionPerformed
pageGenerateBegin
pageLoaded
pageRequestBegin
pageRequestEnd
processPathInfo
propertyChange
rowDataChanged

rowDeleted
rowGenerateBegin
rowInserted
rowPreDelete
rowPreInsert
validationFailed
validationTest
valueChanged

cursorChanged   Top of page

Fires after the row cursor points to a different row.

Declaration

void cursorChanged(AgoPropertyChangeEvent evt)

Usage

Applies to AgpData and AgData.

See also

cursorPreChange, AgpData, AgcDataPrimary

cursorPreChange   Top of page

Fires just before the row cursor points to a different row.

Declaration

void cursorPreChange(AgoPropertyChangeEvent evt)

Usage

Applies to AgpData and AgData.

See also

cursorChanged, AgpData, AgcDataPrimary

dataReceivedAsync   Top of page

Declaration

void dataReceivedAsync(AgoEvent evt)

Usage

Applies to AgpData and AgData.

dataReloaded   Top of page

Fires when all of the underlying data has been reloaded.

Declaration

void dataReloaded(AgoEvent evt)

Usage

Applies to AgpData and AgData.

See also

AgpData, AgcDataPrimary

eventLinkPerformed   Top of page

Fires when the event link has been performed.

Declaration

void eventLinkPerformed(AgpEventLinkEvent evt) throws Exception

Usage

Applies to AgpLabel.

See also

AgpLabel

fileUploaded   Top of page

Fires when a file upload request is made from the browser.

Declaration

void fileUploaded(AgpFileUploadEvent evt)

Usage

Applies to AgpFileUpload.

globalValidationFailed   Top of page

Fires whenever any validation on the page indicates a failure. This includes built-in validations and validation expressions, and calls to validationTest() on individual controls, as well as to globalValidationTest(). The globalValidationFailed event fires after the individual control's validationFailed event and only fires if the control's event handler does not correct the failure. This provides a single point for validation failure processing.

Declaration

void globalValidationFailed(AgoPropertyChangeEvent evt) throws AgoValidationException

Usage

Applies to AgpPage.

See also

globalValidationTest, AgpPage

globalValidationTest   Top of page

Fires when the primary dataset of the page is about to navigate to a new row. This gives the page a last opportunity to validate control data before allowing the user to leave the current row. Note that globalValidationTest does not fire for changes made to individual controls; validation of individual controls can be performed in each control's validationTest() event.

Declaration

void globalValidationTest() throws AgoValidationException

Usage

Applies to AgpPage.

See also

globalValidationFailed, AgpPage

handlePageException   Top of page

This is presented in the designer as a page "event". The programmer may handle an exception gracefully. If the exception is handled, then the user-code should return true, otherwise, the server will create a response page that notifies the end user of the exception.

Declaration

boolean handlePageException(Exception exception,AgiHttpServletRequest req,AgiHttpServletResponse res)

Usage

Applies to AgpPage.

See also

AgpPage

pageActionPerformed   Top of page

Fires when a Submit request is processed by the server.

Declaration

void pageActionPerformed(ActionEvent evt) throws Exception

Usage

Applies to AgpButtonRadio, AgpButtonText, and AgpImageHotSpot.

Applies to the following controls when they have been made programmable: AgpActiveObject, AgpApplet, and AgpImage.

See also

AgpActiveObject, AgpApplet, AgpButtonRadio, AgpButtonText, AgpImage, AgpImageHotSpot

pageGenerateBegin   Top of page

Invoked just before the HTML Generation sequence. Allows post-event handler processing.

Declaration

void pageGenerateBegin() throws Exception

Usage

Applies to AgpPage.

See also

AgpPage

pageLoaded   Top of page

Fires when the page is first loaded in the current user session.

Declaration

void pageLoaded(AgiHttpServletRequest req,AgiHttpServletResponse res) throws Exception

Usage

Applies to AgpPage.

See also

pageRequestBegin, pageRequestEnd, AgpPage

pageRequestBegin   Top of page

Fires immediately after the page is first loaded, and also at the beginning of every subsequent page request.

Declaration

void pageRequestBegin(AgiHttpServletRequest req,AgiHttpServletResponse res) throws Exception

Usage

Applies to AgpPage. The pageRequestBegin event fires before any events on individual controls fire.

See also

pageLoaded, pageRequestEnd, AgpPage

pageRequestEnd   Top of page

Fires at the end of every page request, including the first.

Declaration

void pageRequestEnd(AgiHttpServletRequest req,AgiHttpServletResponse res) throws Exception

Usage

Applies to AgpPage. The pageRequestEnd event fires after any events fired by individual controls.

See also

pageLoaded, pageRequestBegin, AgpPage

processPathInfo   Top of page

Fires before all other page events if the URL specifies a path following the page (or servlet) name.

Declaration

boolean processPathInfo(String pathInfo) throws Exception

Usage

Applies to AgpPage. The path following the page (or servlet) name tells the page what action to perform. Use this event to examine the specified path and perform application-specific processing. If you return false, the page will be loaded and other events on the page will fire. If you return true, the page will not be loaded and the other page events will not fire.

See also

pageLoaded, pageRequestBegin, AgpPage

propertyChange   Top of page

Fires when the control's value changes.

Declaration

void propertyChange(PropertyChangeEvent param0)

Usage

Applies to AgpPresentation when it has been made programmable.

See also

AgpPresentation

rowDataChanged   Top of page

Fires when data in a row has been modified.

Declaration

void rowDataChanged(AgoPropertyChangeEvent evt)

Usage

Applies to AgpData. This event is fired whenever data in a row changes, either from programmatic calls to setProperty() or because of posted data supplied by an end user.

See also

AgpData

rowDeleted   Top of page

Fires after a row has been deleted.

Declaration

void rowDeleted(AgoEvent evt)

Usage

Applies to AgpData and AgData.

See also

rowInserted, rowPreDelete, AgpData, AgcDataPrimary

rowGenerateBegin   Top of page

Fires just before HTML generation for each row of an HTML view.

Declaration

void rowGenerateBegin(AgoEvent evt)

Usage

Applies to AgpViewPanel.

See also

rowDeleted, rowInserted, AgpViewPanel

rowInserted   Top of page

Fires when a new row has been inserted.

Declaration

void rowInserted(AgoEvent evt)

Usage

Applies to AgpData and AgData.

See also

rowDeleted, rowPreInsert, AgpData, AgcDataPrimary

rowPreDelete   Top of page

Fires when a row is about to be deleted.

Declaration

void rowPreDelete(AgoEvent evt)

Usage

Applies to AgpData and AgData.

See also

rowDeleted, rowPreInsert, AgpData, AgcDataPrimary

rowPreInsert   Top of page

Fires just before a new row is inserted.

Declaration

void rowPreInsert(AgoEvent evt)

Usage

Applies to AgpData and AgData.

See also

rowInserted, rowPreDelete, AgpData, AgcDataPrimary

validationFailed   Top of page

Fires when the user has entered a value into the control and the value has failed a validation test.

Declaration

void validationFailed(AgoPropertyChangeEvent evt) throws AgoValidationException

Usage

Applies to AgpTextArea and AgpTextField.

See also

AgpTextArea, AgpTextField

validationTest   Top of page

Fires when the end user changes a control's value.

Declaration

void validationTest(AgoPropertyChangeEvent evt) throws AgoValidationException

Usage

Applies to AgpTextArea and AgpTextField. This event does not fire when a control's value is changed programmatically.

See also

AgpTextArea, AgpTextField

valueChanged   Top of page

Fires whenever the value of a control changes.

Declaration

void valueChanged(AgoPropertyChangeEvent evt)

Usage

Applies to AgpButtonCheck, AgpButtonRadio, AgpChoice, AgpHTMLControl, AgpLabel, AgpList, AgpTextArea, and AgpTextField.

The valueChanged event fires for a page control regardless of whether the user has changed the data in the control. Typically, this event fires for each row in a data set, unless the value of the column bound to the control is the same in two consecutive rows.

The valueChanged event fires only after the value has passed all validation testing.

See also

AgpButtonCheck, AgpButtonRadio, AgpChoice, AgpHTMLControl, AgpLabel, AgpList, AgpTextArea, AgpTextField






Copyright © 2000, SilverStream Software, Inc. All rights reserved.