public final class ClientMetadata extends Object implements Cloneable, Serializable
Type | Property and Description |
---|---|
boolean |
hasRequired
Returns true if there are any required properties.
|
Modifier and Type | Class and Description |
---|---|
static class |
ClientMetadata.Secured |
Constructor and Description |
---|
ClientMetadata(org.apache.myfaces.trinidad.bean.FacesBean.Type beanType)
Creates a ClientMetadata object.
|
Modifier and Type | Method and Description |
---|---|
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)
Convenience function for marking a property as always secure.
|
void |
addSecureProperty(org.apache.myfaces.trinidad.bean.PropertyKey key, ClientMetadata.Secured secured)
Registers a key as a secure property key with specified secure type.
|
ClientMetadata |
clone()
Clones a ClientMetadata
|
Set<String> |
getAlwaysSecurePropertyKeyNames()
Retrieve the property key names that are always secure.
|
ClientComponent.AttrType |
getPropertyType(org.apache.myfaces.trinidad.bean.PropertyKey key)
Returns the type of a given attribute.
|
ClientMetadata.Secured |
getSecured(org.apache.myfaces.trinidad.bean.PropertyKey key)
Returns the secure type of the specified property if the property key is not registered, it will be of type Secured.NEVER, meaning it is always settable by client.
|
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)
Deprecated.
use the public API ClientMetadata.getSecured(PropertyKey) instead
|
public ClientMetadata(org.apache.myfaces.trinidad.bean.FacesBean.Type beanType)
beanType
- the type of the FacesBean for this componentpublic boolean hasRequiredProperty()
public ClientComponent.AttrType getPropertyType(org.apache.myfaces.trinidad.bean.PropertyKey key)
public void addRequiredProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)
public void addIfComponentProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)
public void addSecureProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)
key
- the property key to be registeredpublic void addSecureProperty(org.apache.myfaces.trinidad.bean.PropertyKey key, ClientMetadata.Secured secured)
key
- the property key to be registeredsecured
- security type associated with the keypublic boolean isSecure(org.apache.myfaces.trinidad.bean.PropertyKey key)
public ClientMetadata.Secured getSecured(org.apache.myfaces.trinidad.bean.PropertyKey key)
key
- the property key to check for secure typepublic Set<String> getAlwaysSecurePropertyKeyNames()
public void addPersistedProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)
public boolean isPersistedProperty(org.apache.myfaces.trinidad.bean.PropertyKey key)
public ClientMetadata clone()