oracle.adf.view.rich.activedata

Class ActiveComponentEncoder

java.lang.Object

oracle.adf.view.rich.activedata.ActiveComponentEncoder

Direct Known Subclasses:

ClientComponentCellEncoder, JavascriptCellEncoder, PPRingActiveCellEncoder

public abstract class ActiveComponentEncoder
extends Object

Called during active data on a component to encode actice data updates, insertions and removals for a component residing on the user agent. An instance of this class is returned by a RichRenderer.createActiveComponentEncoder for each component that is bound to active data. While instances of this class are created on the request thread, the actual encoding performed by this class will occur on the thread delivering the active data notification. All necessary context is provided by the ActiveUpdateContext passed to the encoding methods.

See Also:

RichRenderer.createActiveComponentEncoder(javax.faces.component.UIComponent, java.util.Collection<java.lang.String>), ActiveUpdateContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActiveComponentEncoder.CreateBy The possible aditional operations after method encodeClientScrip is called

Constructor Summary

Constructors

Constructor and Description
ActiveComponentEncoder()

Method Summary

Modifier and Type	Method and Description
abstract ActiveComponentEncoder.CreateBy	encodeCreation(ActiveUpdateContext activeContext, Appendable outputScript)
abstract void	encodeUpdate(ActiveUpdateContext activeContext, Appendable outputScript) Encodes client script for a component to handle the active message on client side
abstract String	getClientConstructor()
abstract Set<ActiveComponentEncoder.CreateBy>	getSupportedCreationStrategies()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveComponentEncoder

public ActiveComponentEncoder()

Method Detail

encodeUpdate

public abstract void encodeUpdate(ActiveUpdateContext activeContext,
                                  Appendable outputScript)
                           throws IOException

Encodes client script for a component to handle the active message on client side

Parameters:

activeContext - client encoder of the component

outputScript - the output script

Throws:

IOException - If an I/O error occurs

getClientConstructor

public abstract String getClientConstructor()

getSupportedCreationStrategies

public abstract Set<ActiveComponentEncoder.CreateBy> getSupportedCreationStrategies()

encodeCreation

public abstract ActiveComponentEncoder.CreateBy encodeCreation(ActiveUpdateContext activeContext,
                                                               Appendable outputScript)
                                                        throws IOException

Throws:

IOException