Skip navigation links

oracle.adf.view.rich.render
Class ClientComponent

java.lang.Object
oracle.adf.view.rich.render.ClientComponent

public abstract class ClientComponent

extends java.lang.Object

API for representing client-side component instances which are vended by RichAdfRenderingContext.addClientComponent(). Renderer authors are responsible for specifying any properties to be included in the client-side component instance by calling addProperty().

Nested Class Summary

static class	ClientComponent.AttrType Possible client attribute types.
static class	ClientComponent.Type Possible client component types.

Constructor Summary

ClientComponent()

Method Summary

abstract void	addProperty(org.apache.myfaces.trinidad.bean.PropertyKey propertyKey, java.lang.Object propertyValue) Adds the specified property name and a value to the set of properties that will be sent to the client for this ClientComponent.
abstract java.lang.String	getClientId() Returns the client id for the client-side component instance.
ClientComponent.Type	getType() Returns the client component Type, default to SKIP_UNLESS_REQUIRED_ATTRS in the base implementation and override if needed.
abstract boolean	isActive() Returns true if this client component will, at this point, be sent to the client, or false if it will not be.
boolean	isNull() Returns true if this client component will not become active at any time.
AdfFacesContext.PayloadType	requestPostbackPayloadType(AdfFacesContext.PayloadType payloadType) Requests that a specific payload type be used when posting back this component's values back to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientComponent

public ClientComponent()

Method Detail

getType

public ClientComponent.Type getType()

Returns the client component Type, default to SKIP_UNLESS_REQUIRED_ATTRS in the base implementation and override if needed.

getClientId

public abstract java.lang.String getClientId()

Returns the client id for the client-side component instance. Renderer authors can use this API to retrieve the cached client id value. Note that this method will not necessarily return a non-null value: when a ClientComponent is of type SKIP, this will be null. As a result, clients should use the RichRenderer convenience method to get the client ID, and never call this directly.

addProperty

public abstract void addProperty(org.apache.myfaces.trinidad.bean.PropertyKey propertyKey,
                                 java.lang.Object propertyValue)
                          throws java.io.IOException

Adds the specified property name and a value to the set of properties that will be sent to the client for this ClientComponent. If the property does not need to be sent to the client - in particular, if there is an optimized getter that derived the attribute from the generated DOM - do not call addProperty().

Throws:

java.io.IOException

isActive

public abstract boolean isActive()

Returns true if this client component will, at this point, be sent to the client, or false if it will not be.

isNull

public boolean isNull()

Returns true if this client component will not become active at any time.

requestPostbackPayloadType

public AdfFacesContext.PayloadType requestPostbackPayloadType(AdfFacesContext.PayloadType payloadType)
                                                       throws java.io.IOException

Requests that a specific payload type be used when posting back this component's values back to the server. This method allows components/renderers to opt out of dirty postback behavior. When the dirty postback optimization is enabled, calling requestPostbackPayloadType(PayloadType.FULL) lets the client know that any input values associated with this client component must always be included in the postback payload, whether dirty or not.

Parameters:

payloadType - the preferred payload type for this component

Returns:

the actual payload type that will be used after the request is made. This may differ from the requested payload type, as it is not always possible to honor these requests.

Throws:

java.io.IOException

Skip navigation links