Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


oracle.adf.view.rich.activedata
Class SimpleActiveDataEncoder

java.lang.Object
  extended by oracle.adf.view.rich.activedata.ActiveDataEncoder
      extended by oracle.adf.view.rich.activedata.SimpleActiveDataEncoder


public class SimpleActiveDataEncoder
extends ActiveDataEncoder

Implementation of ActiveDataEncoder that causes the component to completely redraw itself if either a non-update ActiveDataEntry is delivered to encode, or an update ActiveDataEntry is delivered for one of the attributes that the SimpleActiveDataEncoder supports.


Constructor Summary
SimpleActiveDataEncoder(java.util.Set<java.lang.String> supportedAttributesNames)
          Create a SimpleActiveDataEncoder

 

Method Summary
 boolean encode(ClientEncoder clientEncoder, java.io.Writer writer, ActiveDataUpdateEvent event)
          Encode active data contents for the given ActiveDataEvent.

 

Methods inherited from class oracle.adf.view.rich.activedata.ActiveDataEncoder
encode, encode, encode

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

SimpleActiveDataEncoder

public SimpleActiveDataEncoder(java.util.Set<java.lang.String> supportedAttributesNames)
Create a SimpleActiveDataEncoder
Parameters:
supportedAttributesNames - Set of supported attributes names. The associated component will only redraw in response to an ActiveDataEntry.ChangeType.UPDATE that includes one of the supported names.

Method Detail

encode

public boolean encode(ClientEncoder clientEncoder,
                      java.io.Writer writer,
                      ActiveDataUpdateEvent event)
               throws java.io.IOException
Encode active data contents for the given ActiveDataEvent. The encoded contents is written to the writer. Encoder could optionally choose not to encode active data because of the high volum of change data. If active data is not encoded, active data channel will notify the component to refresh to get lastest data.
Overrides:
encode in class ActiveDataEncoder
Parameters:
event - the active data upate event
writer - the output writer used by the encoder to write encoded contents
Returns:
true if the active data is encoded; Otherwise return false
Throws:
java.io.IOException
See Also:
ActiveDataUpdateEvent

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.