org.apache.myfaces.trinidad.render
Class ClientRowKeyManager
java.lang.Object
org.apache.myfaces.trinidad.render.ClientRowKeyManager
- All Implemented Interfaces:
- java.io.Serializable
public abstract class ClientRowKeyManager
- extends java.lang.Object
- implements java.io.Serializable
This class manages server-side
rowkey Objects with client-side string keys.
This class must be Serializable as it is state-saved along with the
UIComponent state.
- See Also:
- Serialized Form
Method Summary |
abstract java.lang.String |
getClientRowKey(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.Object rowKey)
Gets a string version of a key that identifies the row with the given rowkey. |
abstract java.lang.Object |
getRowKey(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String clientRowKey)
Gets the corresponding server-side rowkey object from the given client-side string
key. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ClientRowKeyManager
public ClientRowKeyManager()
getClientRowKey
public abstract java.lang.String getClientRowKey(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.Object rowKey)
- Gets a string version of a key that identifies the row with the given rowkey.
This string key can be used on the client-side to identify the row.
If a string key for the given rowkey does not exist, then a new one is
created. The lifespan of this string rowkey is entirely upto each
implementation. Implementors must ensure that if a particular row is still
present on the client-side, then its string key must also continue to be valid.
- Parameters:
rowKey
- the rowkey to convert into a client key. Note that
null is special and is not allowed.
getRowKey
public abstract java.lang.Object getRowKey(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String clientRowKey)
- Gets the corresponding server-side rowkey object from the given client-side string
key. If the string key has expired, implementors should return null. However,
if any part of a row is still present on the client-side, its corresponding
string-key may not expire.
- Parameters:
clientRowKey
- the string key
- Returns:
- null, if the string key has expired, or never existed.
Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.