Package org.kuali.rice.kns.datadictionary.control

Class ControlDefinitionBase

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

org.kuali.rice.kns.datadictionary.control.ControlDefinitionBase

All Implemented Interfaces:

Serializable, Cloneable, ControlDefinition, Copyable, DataDictionaryDefinition, DictionaryBean

Direct Known Subclasses:

ButtonControlDefinition, CheckboxControlDefinition, CurrencyControlDefinition, FileControlDefinition, HiddenControlDefinition, KualiUserControlDefinition, LinkControlDefinition, LookupHiddenControlDefinition, LookupReadonlyControlDefinition, MultivalueControlDefinitionBase, TextareaControlDefinition, TextControlDefinition, WorkflowWorkgroupControlDefinition

@Deprecated
public abstract class ControlDefinitionBase
extends DataDictionaryDefinitionBase
implements ControlDefinition

Deprecated.

Only used by KNS classes, use KRAD.

A single HTML control definition in the DataDictionary, which contains information relating to the HTML control used to realize a specific attribute. All types of controls are represented by an instance of this class; you have to call one of the is* methods to figure out which of the other accessors should return useful values.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	cols	Deprecated.
protected boolean	datePicker	Deprecated.
protected String	datePickerFormat	Deprecated.
protected boolean	expandedTextArea	Deprecated.
protected boolean	ranged	Deprecated.
protected Integer	rows	Deprecated.
protected String	script	Deprecated.
protected Integer	size	Deprecated.
protected String	valuesFinderClass	Deprecated.
protected Map<String,Object>	valuesFinderProperties	Deprecated.

Fields inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

embeddedDataObjectMetadata, generatedFromMetadata, id

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor	Description
ControlDefinitionBase()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass)	Deprecated. Directly validate simple fields
boolean	equals(Object object)	Deprecated.
String	getBusinessObjectClass()	Deprecated.
Integer	getCols()	Deprecated.
String	getDatePickerFormat()	Deprecated.
Boolean	getIncludeBlankRow()	Deprecated.
Boolean	getIncludeKeyInLabel()	Deprecated.
String	getKeyAttribute()	Deprecated.
String	getLabelAttribute()	Deprecated.
Integer	getRows()	Deprecated.
String	getScript()	Deprecated.
Integer	getSize()	Deprecated.
String	getValuesFinderClass()	Deprecated.
Map<String,Object>	getValuesFinderProperties()	Deprecated.
int	hashCode()	Deprecated.
boolean	hasScript()	Deprecated.
boolean	isButton()	Deprecated.
boolean	isCheckbox()	Deprecated.
boolean	isCurrency()	Deprecated.
boolean	isDatePicker()	Deprecated.
boolean	isExpandedTextArea()	Deprecated.
boolean	isFile()	Deprecated.
boolean	isHidden()	Deprecated.
boolean	isKualiUser()	Deprecated.
boolean	isLink()	Deprecated.
boolean	isLookupHidden()	Deprecated.
boolean	isLookupReadonly()	Deprecated.
boolean	isMultiselect()	Deprecated.
boolean	isRadio()	Deprecated.
boolean	isRanged()	Deprecated.
boolean	isSelect()	Deprecated.
boolean	isText()	Deprecated.
boolean	isTextarea()	Deprecated.
boolean	isWorkflowWorkgroup()	Deprecated.
void	setBusinessObjectClass(String businessObjectClass)	Deprecated. Used by a PersistableBusinessObjectValuesFinder to automatically query and display a list of business objects as part of a select list or set of radio buttons.
void	setCols(Integer cols)	Deprecated. Number of columns to display on a text-area widget.
void	setDatePicker(boolean datePicker)	Deprecated. Whether this control should have a date picker button next to the field.
void	setDatePickerFormat(String datePickerFormat)	Deprecated.
void	setExpandedTextArea(boolean eTextArea)	Deprecated. Whether this control should have a expanded text area button next to the field.
void	setIncludeBlankRow(Boolean includeBlankRow)	Deprecated.
void	setIncludeKeyInLabel(Boolean includeKeyInLabel)	Deprecated. Whether to include the key in the label for select lists and radio buttons.
void	setKeyAttribute(String keyAttribute)	Deprecated. Attribute of the given dataObjectClass to use as the value of a select list or set of radio buttons.
void	setLabelAttribute(String labelAttribute)	Deprecated. Attribute of the given dataObjectClass to use as the displayed label on a select list or set of radio buttons.
void	setRanged(boolean ranged)	Deprecated. Sets the control as a ranged (from and to) date field if true, or a single date field if false
void	setRows(Integer rows)	Deprecated. Number of rows to display on a text-area widget.
void	setScript(String script)	Deprecated. JavaScript script to run when a select control's value is changed.
void	setSize(Integer size)	Deprecated. Size of a text control.
void	setValuesFinderClass(String valuesFinderClass)	Deprecated.
void	setValuesFinderProperties(Map<String,Object> valuesFinderProperties)	Deprecated.

Methods inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

completeValidation, getId, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadata

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

clone, copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.datadictionary.DataDictionaryDefinition

completeValidation, getId

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Details

datePicker

protected boolean datePicker

Deprecated.

datePickerFormat

protected String datePickerFormat

Deprecated.

expandedTextArea

protected boolean expandedTextArea

Deprecated.

script

protected String script

Deprecated.

valuesFinderClass

protected String valuesFinderClass

Deprecated.

valuesFinderProperties

protected Map<String,Object> valuesFinderProperties

Deprecated.

size

protected Integer size

Deprecated.

rows

protected Integer rows

Deprecated.

cols

protected Integer cols

Deprecated.

ranged

protected boolean ranged

Deprecated.

Constructor Details

ControlDefinitionBase

public ControlDefinitionBase()

Deprecated.

Method Details

isDatePicker

public boolean isDatePicker()

Deprecated.

Specified by:

isDatePicker in interface ControlDefinition

setDatePicker

public void setDatePicker(boolean datePicker)

Deprecated.

Whether this control should have a date picker button next to the field. Valid for text fields.

Specified by:

setDatePicker in interface ControlDefinition

getDatePickerFormat

public String getDatePickerFormat()

Deprecated.

Specified by:

getDatePickerFormat in interface ControlDefinition

setDatePickerFormat

public void setDatePickerFormat(String datePickerFormat)

Deprecated.

Specified by:

setDatePickerFormat in interface ControlDefinition

isExpandedTextArea

public boolean isExpandedTextArea()

Deprecated.

Specified by:

isExpandedTextArea in interface ControlDefinition

setExpandedTextArea

public void setExpandedTextArea(boolean eTextArea)

Deprecated.

Whether this control should have a expanded text area button next to the field. Valid for textarea fields.

Specified by:

setExpandedTextArea in interface ControlDefinition

isCheckbox

public boolean isCheckbox()

Deprecated.

Specified by:

isCheckbox in interface ControlDefinition

isHidden

public boolean isHidden()

Deprecated.

Specified by:

isHidden in interface ControlDefinition

isRadio

public boolean isRadio()

Deprecated.

Specified by:

isRadio in interface ControlDefinition

isSelect

public boolean isSelect()

Deprecated.

Specified by:

isSelect in interface ControlDefinition

isMultiselect

public boolean isMultiselect()

Deprecated.

Specified by:

isMultiselect in interface ControlDefinition

isText

public boolean isText()

Deprecated.

Specified by:

isText in interface ControlDefinition

isTextarea

public boolean isTextarea()

Deprecated.

Specified by:

isTextarea in interface ControlDefinition

isCurrency

public boolean isCurrency()

Deprecated.

Specified by:

isCurrency in interface ControlDefinition

isKualiUser

public boolean isKualiUser()

Deprecated.

Specified by:

isKualiUser in interface ControlDefinition

isWorkflowWorkgroup

public boolean isWorkflowWorkgroup()

Deprecated.

Specified by:

isWorkflowWorkgroup in interface ControlDefinition

isFile

public boolean isFile()

Deprecated.

Specified by:

isFile in interface ControlDefinition

isLookupHidden

public boolean isLookupHidden()

Deprecated.

Specified by:

isLookupHidden in interface ControlDefinition

isLookupReadonly

public boolean isLookupReadonly()

Deprecated.

Specified by:

isLookupReadonly in interface ControlDefinition

isButton

public boolean isButton()

Deprecated.

Specified by:

isButton in interface ControlDefinition

isLink

public boolean isLink()

Deprecated.

Specified by:

isLink in interface ControlDefinition

setValuesFinderClass

public void setValuesFinderClass(String valuesFinderClass)

Deprecated.

Specified by:

setValuesFinderClass in interface ControlDefinition

setValuesFinderProperties

public void setValuesFinderProperties(Map<String,Object> valuesFinderProperties)

Deprecated.

Specified by:

setValuesFinderProperties in interface ControlDefinition

getBusinessObjectClass

public String getBusinessObjectClass()

Deprecated.

Specified by:

getBusinessObjectClass in interface ControlDefinition

Returns:

the dataObjectClass

setBusinessObjectClass

public void setBusinessObjectClass(String businessObjectClass)

Deprecated.

Used by a PersistableBusinessObjectValuesFinder to automatically query and display a list of business objects as part of a select list or set of radio buttons. The keyAttribute, labelAttribute, and includeKeyInLabel are used with this property.

Specified by:

setBusinessObjectClass in interface ControlDefinition

Parameters:

businessObjectClass - the dataObjectClass to set

getIncludeBlankRow

public Boolean getIncludeBlankRow()

Deprecated.

Specified by:

getIncludeBlankRow in interface ControlDefinition

Returns:

the includeBlankRow

setIncludeBlankRow

public void setIncludeBlankRow(Boolean includeBlankRow)

Deprecated.

Specified by:

setIncludeBlankRow in interface ControlDefinition

getIncludeKeyInLabel

public Boolean getIncludeKeyInLabel()

Deprecated.

Specified by:

getIncludeKeyInLabel in interface ControlDefinition

Returns:

the includeKeyInLabel

setIncludeKeyInLabel

public void setIncludeKeyInLabel(Boolean includeKeyInLabel)

Deprecated.

Whether to include the key in the label for select lists and radio buttons.

Specified by:

setIncludeKeyInLabel in interface ControlDefinition

getKeyAttribute

public String getKeyAttribute()

Deprecated.

Specified by:

getKeyAttribute in interface ControlDefinition

Returns:

the keyAttribute

setKeyAttribute

public void setKeyAttribute(String keyAttribute)

Deprecated.

Attribute of the given dataObjectClass to use as the value of a select list or set of radio buttons.

Specified by:

setKeyAttribute in interface ControlDefinition

getLabelAttribute

public String getLabelAttribute()

Deprecated.

Specified by:

getLabelAttribute in interface ControlDefinition

Returns:

the labelAttribute

setLabelAttribute

public void setLabelAttribute(String labelAttribute)

Deprecated.

Attribute of the given dataObjectClass to use as the displayed label on a select list or set of radio buttons.

Specified by:

setLabelAttribute in interface ControlDefinition

getValuesFinderClass

public String getValuesFinderClass()

Deprecated.

Specified by:

getValuesFinderClass in interface ControlDefinition

getValuesFinderProperties

public Map<String,Object> getValuesFinderProperties()

Deprecated.

Specified by:

getValuesFinderProperties in interface ControlDefinition

setSize

public void setSize(Integer size)

Deprecated.

Size of a text control.

Specified by:

setSize in interface ControlDefinition

getSize

public Integer getSize()

Deprecated.

Specified by:

getSize in interface ControlDefinition

hasScript

public boolean hasScript()

Deprecated.

setRows

public void setRows(Integer rows)

Deprecated.

Number of rows to display on a text-area widget.

Specified by:

setRows in interface ControlDefinition

getRows

public Integer getRows()

Deprecated.

Specified by:

getRows in interface ControlDefinition

setCols

public void setCols(Integer cols)

Deprecated.

Number of columns to display on a text-area widget.

Specified by:

setCols in interface ControlDefinition

getCols

public Integer getCols()

Deprecated.

Specified by:

getCols in interface ControlDefinition

completeValidation

public void completeValidation(Class<?> rootBusinessObjectClass,
 Class<?> otherBusinessObjectClass)

Deprecated.

Directly validate simple fields

Specified by:

completeValidation in interface DataDictionaryDefinition

Overrides:

completeValidation in class DataDictionaryDefinitionBase

getScript

public String getScript()

Deprecated.

Specified by:

getScript in interface ControlDefinition

setScript

public void setScript(String script)

Deprecated.

JavaScript script to run when a select control's value is changed.

Specified by:

setScript in interface ControlDefinition

isRanged

public boolean isRanged()

Deprecated.

Specified by:

isRanged in interface ControlDefinition

setRanged

public void setRanged(boolean ranged)

Deprecated.

Sets the control as a ranged (from and to) date field if true, or a single date field if false

Parameters:

ranged - boolean true for a ranged control, false for a single date field

equals

public boolean equals(Object object)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object