org.kuali.rice.kns.web.ui
Interface PropertyRenderingConfigElement

All Known Implementing Classes:

Column, DocumentSearchColumn_DEPR, DocumentSearchField_DEPR, Field

public interface PropertyRenderingConfigElement

Interface to be implemented by user interface elements that hold configuration about rendering a property

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

String	getAdditionalDisplayPropertyName()
String	getAlternateDisplayPropertyName()
Formatter	getFormatter()
String	getPropertyName()
String	getPropertyValue()
void	setAdditionalDisplayPropertyName(String additionalDisplayPropertyName)
void	setAlternateDisplayPropertyName(String alternateDisplayPropertyName)
void	setFormatter(Formatter formatter)
void	setPropertyName(String propertyName)
void	setPropertyValue(String propertyValue)

Method Detail

getPropertyName

String getPropertyName()

Returns:

name of the property that is to be rendered

setPropertyName

void setPropertyName(String propertyName)

Parameters:

propertyName - - name of the property that is to be rendered

getPropertyValue

String getPropertyValue()

Returns:

name of the property that is to be rendered

setPropertyValue

void setPropertyValue(String propertyValue)

Parameters:

propertyValue - - value of the property that is to be rendered

getFormatter

Formatter getFormatter()

Returns:

value of the property that is to be rendered

setFormatter

void setFormatter(Formatter formatter)

Parameters:

formatter - - Formatter that should be use when rendering property value

getAlternateDisplayPropertyName

String getAlternateDisplayPropertyName()

Returns:

name of the property that should be displayed in place of property we are rendering (only applies when read-only)

setAlternateDisplayPropertyName

void setAlternateDisplayPropertyName(String alternateDisplayPropertyName)

Parameters:

alternateDisplayPropertyName - - name of the property that should be displayed in place of property we are rendering (only applies when read-only)

getAdditionalDisplayPropertyName

String getAdditionalDisplayPropertyName()

Returns:

name of the property that should be displayed in addition to the property we are rendering (only applies when read-only)

setAdditionalDisplayPropertyName

void setAdditionalDisplayPropertyName(String additionalDisplayPropertyName)

Parameters:

additionalDisplayPropertyName - - name of the property that should be displayed in addition to the property we are rendering (only applies when read-only)