Skip navigation links

oracle.adf.view.rich.render
Class ClientMetadata

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

All Implemented Interfaces:

java.lang.Cloneable

public final class ClientMetadata

extends java.lang.Object

implements java.lang.Cloneable

Encapsulates the metadata for a type of client component.

Constructor Summary

ClientMetadata(org.apache.myfaces.trinidad.bean.FacesBean.Type beanType)
Creates a ClientMetadata object.

Method Summary

void	addIfComponentProperty(org.apache.myfaces.trinidad.bean.PropertyKey key) Registers a key as a property that should be sent if there will be a client component.
void	addPersistedProperty(org.apache.myfaces.trinidad.bean.PropertyKey key) Adds a 'persistence' property.
void	addRequiredProperty(org.apache.myfaces.trinidad.bean.PropertyKey key) Registers a key as a required property.
void	addSecureProperty(org.apache.myfaces.trinidad.bean.PropertyKey key) Adds a 'secure' property.
ClientMetadata	clone() Clones a ClientMetadata
ClientComponent.AttrType	getPropertyType(org.apache.myfaces.trinidad.bean.PropertyKey key) Returns the type of a given attribute.
boolean	hasRequiredProperty() Returns true if there are any required properties.
boolean	isPersistedProperty(org.apache.myfaces.trinidad.bean.PropertyKey key) Returns true if a property is persistence and any client changes should be peristed using change manager
boolean	isSecure(org.apache.myfaces.trinidad.bean.PropertyKey key) Returns true if a property is secure and should not be synced back from client changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientMetadata

public ClientMetadata(org.apache.myfaces.trinidad.bean.FacesBean.Type beanType)

Creates a ClientMetadata object.

Parameters:

beanType - the type of the FacesBean for this component

Method Detail

hasRequiredProperty

public boolean hasRequiredProperty()

Returns true if there are any required properties.

getPropertyType

public ClientComponent.AttrType getPropertyType(org.apache.myfaces.trinidad.bean.PropertyKey key)

Returns the type of a given attribute. All anonymous keys (keys that are not registered on this type) will be considered REQUIRED.

addRequiredProperty

public void addRequiredProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)

Registers a key as a required property. Required properties will force the instantiation of a client component. This method must only be called when a ClientMetadata object is first being set up.

addIfComponentProperty

public void addIfComponentProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)

Registers a key as a property that should be sent if there will be a client component. This method must only be called when a ClientMetadata object is first being set up.

addSecureProperty

public void addSecureProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)

Adds a 'secure' property. Secure properties will not be synced back from client changes. This method must only be called when a ClientMetadata object is first being set up.

isSecure

public boolean isSecure(org.apache.myfaces.trinidad.bean.PropertyKey key)

Returns true if a property is secure and should not be synced back from client changes.

addPersistedProperty

public void addPersistedProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)

Adds a 'persistence' property. Persistence properties will be persisted using change manager during attribute synch from client

isPersistedProperty

public boolean isPersistedProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)

Returns true if a property is persistence and any client changes should be peristed using change manager

clone

public ClientMetadata clone()

Clones a ClientMetadata

Overrides:

clone in class java.lang.Object

Skip navigation links