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, org.kuali.rice.krad.datadictionary.control.ControlDefinition, org.kuali.rice.krad.datadictionary.Copyable, org.kuali.rice.krad.datadictionary.DataDictionaryDefinition, org.kuali.rice.krad.datadictionary.DictionaryBean
Direct Known Subclasses:
ButtonControlDefinition, CheckboxControlDefinition, CurrencyControlDefinition, FileControlDefinition, HiddenControlDefinition, KualiUserControlDefinition, LinkControlDefinition, LookupHiddenControlDefinition, LookupReadonlyControlDefinition, MultivalueControlDefinitionBase, TextareaControlDefinition, TextControlDefinition, WorkflowWorkgroupControlDefinition
@Deprecated public abstract class ControlDefinitionBase extends org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase implements org.kuali.rice.krad.datadictionary.control.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:

  • 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 org.kuali.rice.krad.datadictionary.control.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 org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getDatePickerFormat

      public String getDatePickerFormat()
      Deprecated.
      Specified by:
      getDatePickerFormat in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • setDatePickerFormat

      public void setDatePickerFormat(String datePickerFormat)
      Deprecated.
      Specified by:
      setDatePickerFormat in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isExpandedTextArea

      public boolean isExpandedTextArea()
      Deprecated.
      Specified by:
      isExpandedTextArea in interface org.kuali.rice.krad.datadictionary.control.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 org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isCheckbox

      public boolean isCheckbox()
      Deprecated.
      Specified by:
      isCheckbox in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isHidden

      public boolean isHidden()
      Deprecated.
      Specified by:
      isHidden in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isRadio

      public boolean isRadio()
      Deprecated.
      Specified by:
      isRadio in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isSelect

      public boolean isSelect()
      Deprecated.
      Specified by:
      isSelect in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isMultiselect

      public boolean isMultiselect()
      Deprecated.
      Specified by:
      isMultiselect in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isText

      public boolean isText()
      Deprecated.
      Specified by:
      isText in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isTextarea

      public boolean isTextarea()
      Deprecated.
      Specified by:
      isTextarea in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isCurrency

      public boolean isCurrency()
      Deprecated.
      Specified by:
      isCurrency in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isKualiUser

      public boolean isKualiUser()
      Deprecated.
      Specified by:
      isKualiUser in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isWorkflowWorkgroup

      public boolean isWorkflowWorkgroup()
      Deprecated.
      Specified by:
      isWorkflowWorkgroup in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isFile

      public boolean isFile()
      Deprecated.
      Specified by:
      isFile in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isLookupHidden

      public boolean isLookupHidden()
      Deprecated.
      Specified by:
      isLookupHidden in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isLookupReadonly

      public boolean isLookupReadonly()
      Deprecated.
      Specified by:
      isLookupReadonly in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isButton

      public boolean isButton()
      Deprecated.
      Specified by:
      isButton in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isLink

      public boolean isLink()
      Deprecated.
      Specified by:
      isLink in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • setValuesFinderClass

      public void setValuesFinderClass(String valuesFinderClass)
      Deprecated.
      Specified by:
      setValuesFinderClass in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • setValuesFinderProperties

      public void setValuesFinderProperties(Map<String,Object> valuesFinderProperties)
      Deprecated.
      Specified by:
      setValuesFinderProperties in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getBusinessObjectClass

      public String getBusinessObjectClass()
      Deprecated.
      Specified by:
      getBusinessObjectClass in interface org.kuali.rice.krad.datadictionary.control.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 org.kuali.rice.krad.datadictionary.control.ControlDefinition
      Parameters:
      businessObjectClass - the dataObjectClass to set

    • getIncludeBlankRow

      public Boolean getIncludeBlankRow()
      Deprecated.
      Specified by:
      getIncludeBlankRow in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition
      Returns:
      the includeBlankRow

    • setIncludeBlankRow

      public void setIncludeBlankRow(Boolean includeBlankRow)
      Deprecated.
      Specified by:
      setIncludeBlankRow in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getIncludeKeyInLabel

      public Boolean getIncludeKeyInLabel()
      Deprecated.
      Specified by:
      getIncludeKeyInLabel in interface org.kuali.rice.krad.datadictionary.control.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 org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getKeyAttribute

      public String getKeyAttribute()
      Deprecated.
      Specified by:
      getKeyAttribute in interface org.kuali.rice.krad.datadictionary.control.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 org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getLabelAttribute

      public String getLabelAttribute()
      Deprecated.
      Specified by:
      getLabelAttribute in interface org.kuali.rice.krad.datadictionary.control.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 org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getValuesFinderClass

      public String getValuesFinderClass()
      Deprecated.
      Specified by:
      getValuesFinderClass in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getValuesFinderProperties

      public Map<String,Object> getValuesFinderProperties()
      Deprecated.
      Specified by:
      getValuesFinderProperties in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • setSize

      public void setSize(Integer size)
      Deprecated.
      Size of a text control.
      Specified by:
      setSize in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getSize

      public Integer getSize()
      Deprecated.
      Specified by:
      getSize in interface org.kuali.rice.krad.datadictionary.control.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 org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getRows

      public Integer getRows()
      Deprecated.
      Specified by:
      getRows in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • setCols

      public void setCols(Integer cols)
      Deprecated.
      Number of columns to display on a text-area widget.
      Specified by:
      setCols in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • getCols

      public Integer getCols()
      Deprecated.
      Specified by:
      getCols in interface org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • completeValidation

      public void completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass)
      Deprecated.
      Directly validate simple fields
      Specified by:
      completeValidation in interface org.kuali.rice.krad.datadictionary.DataDictionaryDefinition
      Overrides:
      completeValidation in class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

    • getScript

      public String getScript()
      Deprecated.
      Specified by:
      getScript in interface org.kuali.rice.krad.datadictionary.control.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 org.kuali.rice.krad.datadictionary.control.ControlDefinition

    • isRanged

      public boolean isRanged()
      Deprecated.
      Specified by:
      isRanged in interface org.kuali.rice.krad.datadictionary.control.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