com.telerik.widget.dataform.engine

Interface EntityProperty

All Known Implementing Classes:

EntityPropertyBase, EntityPropertyCore, JsonEntityProperty

public interface EntityProperty

This class represents a combination of a get and a set methods which together define a property.

Method Summary

Modifier and Type	Method and Description
void	addCommitListener(EntityPropertyCommitListener listener)
void	addOnChangedListener(EntityPropertyChangedListener listener) Use to add an implementation of the EntityPropertyChangedListener interface to the collection of objects that listen for changes of the value of this property.
void	addValidationCompletedListener(ValidationCompletedListener listener)
void	commit() Persists the validated value candidate on the source object's property.
int	getColumnPosition()
int	getColumnSpan()
PropertyConverter	getConverter()
int	getCoreEditorLayoutId()
Object	getCustomMetadata()
int	getEditorLayoutId()
HashMap<String,Object>	getEditorParams()
Class<? extends EntityPropertyEditor>	getEditorType()
Object[]	getEnumConstants()
String	getGroupName()
String	getHeader()
int	getHeaderLayoutId()
String	getHintText()
int	getImageResource()
Entity	getOwner()
int	getPosition()
boolean	getReadOnly()
boolean	getRequired()
boolean	getSkip()
int	getValidationLayoutId()
PropertyValidator	getValidator()
Object	getValue() Gets the value currently persisted on the source object.
Object	getValueCandidate() Gets the current value candidate that, in case of successful validation, will be persisted on the source object's property.
Class<? extends EntityPropertyViewer>	getViewerType()
boolean	isTypePrimitive()
boolean	isValid()
String	name() Returns the name of the property.
void	readMetadata(EntityPropertyMetadata metadata)
void	removeCommitListener(EntityPropertyCommitListener listener)
void	removeOnChangedListener(EntityPropertyChangedListener listener) Use to remove the provided implementation of the EntityPropertyChangedListener interface from the collection of objects that listen for changes of the value of this property.
void	removeValidationCompletedListener(ValidationCompletedListener listener)
void	setColumnPosition(int value)
void	setColumnSpan(int value)
void	setConverter(PropertyConverter converter)
void	setCoreEditorLayoutId(int value)
void	setCustomMetadata(Object value)
void	setEditorLayoutId(int value)
void	setEditorParams(HashMap<String,Object> params)
void	setEditorType(Class<EntityPropertyEditor> value)
void	setGroupName(String value)
void	setHeader(String value)
void	setHeaderLayoutId(int value)
void	setHintText(String value)
void	setImageResource(int value)
void	setPosition(int value)
void	setReadOnly(boolean value)
void	setRequired(boolean value)
void	setSkip(boolean value)
void	setValidationLayoutId(int value)
void	setValidator(PropertyValidator validator)
void	setValueCandidate(Object value) Sets a value that, in case of successful validation, will be persisted on the source object's property when EntityProperty.commit() is called.
void	setViewerType(Class<EntityPropertyViewer> value)
void	tryCommit(Object value) Tries to validate the provided value and if the validation succeeds, the value is committed.
Class	type() Gets the type of the property.
void	updateValues(Object[] values)
void	validate(Object value)

Method Detail

setCustomMetadata

void setCustomMetadata(Object value)

getCustomMetadata

Object getCustomMetadata()

setReadOnly

void setReadOnly(boolean value)

getReadOnly

boolean getReadOnly()

getEditorLayoutId

int getEditorLayoutId()

setEditorLayoutId

void setEditorLayoutId(int value)

getCoreEditorLayoutId

int getCoreEditorLayoutId()

setCoreEditorLayoutId

void setCoreEditorLayoutId(int value)

getHeaderLayoutId

int getHeaderLayoutId()

setHeaderLayoutId

void setHeaderLayoutId(int value)

getValidationLayoutId

int getValidationLayoutId()

setValidationLayoutId

void setValidationLayoutId(int value)

getEnumConstants

Object[] getEnumConstants()

isTypePrimitive

boolean isTypePrimitive()

readMetadata

void readMetadata(EntityPropertyMetadata metadata)

getViewerType

Class<? extends EntityPropertyViewer> getViewerType()

setViewerType

void setViewerType(Class<EntityPropertyViewer> value)

getEditorType

Class<? extends EntityPropertyEditor> getEditorType()

setEditorType

void setEditorType(Class<EntityPropertyEditor> value)

getEditorParams

HashMap<String,Object> getEditorParams()

setEditorParams

void setEditorParams(HashMap<String,Object> params)

getSkip

boolean getSkip()

setSkip

void setSkip(boolean value)

setColumnPosition

void setColumnPosition(int value)

getColumnPosition

int getColumnPosition()

getColumnSpan

int getColumnSpan()

setColumnSpan

void setColumnSpan(int value)

getPosition

int getPosition()

setPosition

void setPosition(int value)

getHeader

String getHeader()

setHeader

void setHeader(String value)

getImageResource

int getImageResource()

setImageResource

void setImageResource(int value)

getGroupName

String getGroupName()

setGroupName

void setGroupName(String value)

getHintText

String getHintText()

setHintText

void setHintText(String value)

getRequired

boolean getRequired()

setRequired

void setRequired(boolean value)

addOnChangedListener

void addOnChangedListener(EntityPropertyChangedListener listener)

Use to add an implementation of the EntityPropertyChangedListener interface to the collection of objects that listen for changes of the value of this property.

Parameters:

listener - the event listener.

removeOnChangedListener

void removeOnChangedListener(EntityPropertyChangedListener listener)

Use to remove the provided implementation of the EntityPropertyChangedListener interface from the collection of objects that listen for changes of the value of this property.

Parameters:

listener - the event listener to remove.

addValidationCompletedListener

void addValidationCompletedListener(ValidationCompletedListener listener)

removeValidationCompletedListener

void removeValidationCompletedListener(ValidationCompletedListener listener)

addCommitListener

void addCommitListener(EntityPropertyCommitListener listener)

removeCommitListener

void removeCommitListener(EntityPropertyCommitListener listener)

type

Class type()

Gets the type of the property.

Returns:

an instance of the Class class representing the type.

name

String name()

Returns the name of the property.

Returns:

a string representing the property name.

getValueCandidate

Object getValueCandidate()

Gets the current value candidate that, in case of successful validation, will be persisted on the source object's property.

Returns:

the value candidate.

setValueCandidate

void setValueCandidate(Object value)

Sets a value that, in case of successful validation, will be persisted on the source object's property when EntityProperty.commit() is called.

Parameters:

value - the value candidate to set.

getOwner

Entity getOwner()

getValue

Object getValue()

Gets the value currently persisted on the source object.

Returns:

the value;

commit

void commit()

Persists the validated value candidate on the source object's property. If there's not a valid value candidate an exception will be thrown.

tryCommit

void tryCommit(Object value)

Tries to validate the provided value and if the validation succeeds, the value is committed.

setConverter

void setConverter(PropertyConverter converter)

getConverter

PropertyConverter getConverter()

setValidator

void setValidator(PropertyValidator validator)

getValidator

PropertyValidator getValidator()

validate

void validate(Object value)

isValid

boolean isValid()

updateValues

void updateValues(Object[] values)