This object contains the set of public, global events that are fired during XIE's WLP interaction lifecycle. The interaction lifecycle involves setting up and executing an Ajax request to the WLP server, receiving a response, and subsequently processing the response. WLP Ajax responses are encoded in an internal JSON format (the form of which is reserved and subject to change), and XIE manages the evaluation and handling of the body of these responses. The suite of public XIE events provides public access to key moments of interest during this lifecycle; listening code can use these event hooks to respond to or even influence the outcome of the interaction.
The XIE interaction lifecycle fires these events over the course of an interactions as follows:
This event delivers an AbandonedPayload
when fired. It can be useful for handling responses
that did not originate from a BEA WebLogic Portal server application. Such cases may include proxy server
redirects.
This event delivers a ResponsePayload
when fired. It can be useful for cleaning up
custom code after an interaction or providing feedback to the user that the interaction is complete.
This event is fired after all other XIE events have completed and necessary scripts have been
executed. This event may or may not fire in error scenarios, depending on the severity of the
error.
This event delivers an ErrorPayload
when fired. This event only fires if XIE encouters
an unexpected problem during a given interaction.
This event delivers a ResponsePayload
when fired. It can be useful for last minute
sanitizing, preparation, or saving of document state before XIE begins replacing portions of the
document with new content.
This event delivers a ContentPayload
when fired. It can be useful for DOM inspection
and modification, after XIE has made any of its own modifications (e.g. rewriting) to the DOM
subtree after injection into the document. As with OnPrepareMarkup
, note
that such changes should be undertaken with great care -- if the integrity of the markup is harmed
during this event, subsequent events for both this markup and the overall interaction may fail.
Also beware that certain HTML elements and artifacts present in the markup exist to support both XIE
and other Disc client-side constructs, and are considered by WLP to be internal implementation
details; relying on the presence of or otherwise interfering with these elements can also cause
irreparable harm to the XIE response processing sequence, or may cause undefined behavior in other
Disc APIs or even general application code.
This event delivers a ContentPayload
when fired. It can be useful for preliminary
DOM inspection and modification, before XIE has made any of its own modifications to the DOM subtree
in preparation for injection into the document. As with OnPrepareMarkup
, note
that such changes should be undertaken with great care -- if the integrity of the markup is harmed
during this event, subsequent events for both this markup and the overall interaction may fail.
Also beware that certain HTML elements and artifacts present in the markup exist to support both XIE
and other Disc client-side constructs, and are considered by WLP to be internal implementation
details; relying on the presence of or otherwise interfering with these elements can also cause
irreparable harm to the XIE response processing sequence, or may cause undefined behavior in other
Disc APIs or even general application code.
This event delivers a MutableMarkupPayload
when fired. It can be useful for filtering
or rewriting the raw markup response or a document fragment before XIE begins processing it. Note
that such filtering should be undertaken with great care -- if the integrity of the markup is harmed
during this event, subsequent events for both this markup and the overall interaction may fail.
Also beware that certain HTML elements and artifacts present in the markup exist to support both XIE
and other Disc client-side constructs, and are considered by WLP to be internal implementation
details; relying on the presence of or otherwise interfering with these elements can also cause
irreparable harm to the XIE response processing sequence, or may cause undefined behavior in other
Disc APIs or even general application code.
This event delivers a MutableUpdatePayload
when fired. It can be useful in preparing
for the coming interaction, saving current UI state, or even preventing the interaction from
occurring (by cancelling the current event; see bea.wlp.disc.event.Event
for more
information on cancelling events).
This event delivers a RedirectPayload
when fired. It can be useful for performing
last minute operations before the redirect is actually performed.
Generated on Tue Aug 19 2008 09:38:26 GMT-0600 (MDT). | Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. |