org.kuali.kfs.sys.document.datadictionary
Class AccountingLineViewFieldDefinition

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.kns.datadictionary.MaintainableItemDefinition
          org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition
              org.kuali.kfs.sys.document.datadictionary.AccountingLineViewFieldDefinition

All Implemented Interfaces:

Serializable, AccountingLineViewRenderableElementDefinition, org.kuali.rice.kns.datadictionary.DataDictionaryDefinition, org.kuali.rice.kns.datadictionary.FieldDefinitionI, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AccountingLineViewSequenceNumberFieldDefinition

public class AccountingLineViewFieldDefinition
extends org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition
implements AccountingLineViewRenderableElementDefinition

Data dictionary definition of a field to be rendered as part of an accounting line view.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition

additionalDisplayAttributeName, alternateDisplayAttributeName, defaultValue, defaultValueFinderClass, fieldLevelHelpUrl, lookupReadOnly, noLookup, overrideFieldConversions, overrideLookupClass, readOnlyAfterAdd, required, showFieldLevelHelp, template, triggerOnChange, unconditionallyReadOnly, webUILeaveFieldCallbackFunction, webUILeaveFieldFunction, webUILeaveFieldFunctionParameters

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

id

Constructor Summary

AccountingLineViewFieldDefinition()

Method Summary

TableJoining	createLayoutElement(Class<? extends AccountingLine> accountingLineClass) Returns the TableJoining element that this definition requires to be part of the accounting line view
Class<? extends AccountingLineViewField>	getAccountingLineViewFieldClass() Gets the accountingLineViewFieldClass attribute.
String	getDynamicLabelProperty() Gets the dynamicLabelProperty attribute.
DynamicNameLabelGenerator	getDynamicNameLabelGenerator() Returns the dynamicNameLabelGenerator for this field definition, if it has one
String	getDynamicNameLabelGeneratorBeanName() Gets the dynamicNameLabelGeneratorBeanName attribute.
protected List<AccountingLineViewOverrideField>	getFieldsForOverrideFields(AccountingLineViewField parentField, Class<? extends AccountingLine> accountingLineClass) For each defined override field within this definition, creates a Field and puts them together as a List
org.kuali.rice.kns.web.ui.Field	getKNSFieldForDefinition(Class<? extends AccountingLine> accountingLineClass) Creates a KNS Field for an AccountingLineViewField definition
protected AccountingLineViewField	getNewAccountingLineViewField() Creates a new instance of the accounting line view field class this definition uses
int	getOverrideColSpan() Gets the overrideColSpan attribute.
List<AccountingLineViewOverrideFieldDefinition>	getOverrideFields() Gets the overrideFields attribute.
String	getOverrideLookupParameters() Gets the overrideLookupParameters attribute.
boolean	isHidden() Gets the hidden attribute.
void	setAccountingLineViewFieldClass(Class<? extends AccountingLineViewField> accountingLineViewFieldClass) Sets the accountingLineViewFieldClass attribute value.
void	setDynamicLabelProperty(String dynamicLabelProperty) Sets the dynamicLabelProperty attribute value.
void	setDynamicNameLabelGeneratorBeanName(String dynamicNameLabelGeneratorBeanName) Sets the dynamicNameLabelGeneratorBeanName attribute value.
void	setHidden(boolean hidden) Sets the hidden attribute value.
void	setOverrideColSpan(int overrideColSpan) Sets the overrideColSpan attribute value.
void	setOverrideFields(List<AccountingLineViewOverrideFieldDefinition> overrideFields) Sets the overrideFields attribute value.
void	setOverrideLookupParameters(String overrideLookupParameters) Sets the overrideLookupParameters attribute value.
void	setUseShortLabel(boolean useShortLabel) Sets the useShortLabel attribute value.
boolean	shouldUseShortLabel() Gets the useShortLabel attribute.

Methods inherited from class org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition

completeValidation, getAdditionalDisplayAttributeName, getAlternateDisplayAttributeName, getDefaultValue, getDefaultValueFinderClass, getFieldLevelHelpUrl, getOverrideFieldConversions, getOverrideLookupClass, getTemplate, getWebUILeaveFieldCallbackFunction, getWebUILeaveFieldFunction, getWebUILeaveFieldFunctionParameters, isLookupReadOnly, isNoLookup, isReadOnlyAfterAdd, isRequired, isShowFieldLevelHelp, isTriggerOnChange, isUnconditionallyReadOnly, setAdditionalDisplayAttributeName, setAlternateDisplayAttributeName, setDefaultValue, setDefaultValueFinderClass, setFieldLevelHelpUrl, setLookupReadOnly, setNoLookup, setOverrideFieldConversions, setOverrideLookupClass, setReadOnlyAfterAdd, setRequired, setShowFieldLevelHelp, setTemplate, setTriggerOnChange, setUnconditionallyReadOnly, setWebUILeaveFieldCallbackFunction, setWebUILeaveFieldFunction, setWebUILeaveFieldFunctionParameters, toString

Methods inherited from class org.kuali.rice.kns.datadictionary.MaintainableItemDefinition

getName, setName

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

afterPropertiesSet, getId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.kns.datadictionary.FieldDefinitionI

getName

Constructor Detail

AccountingLineViewFieldDefinition

public AccountingLineViewFieldDefinition()

Method Detail

getDynamicLabelProperty

public String getDynamicLabelProperty()

Gets the dynamicLabelProperty attribute.

Returns:

Returns the dynamicLabelProperty.

setDynamicLabelProperty

public void setDynamicLabelProperty(String dynamicLabelProperty)

Sets the dynamicLabelProperty attribute value.

Parameters:

dynamicLabelProperty - The dynamicLabelProperty to set.

shouldUseShortLabel

public boolean shouldUseShortLabel()

Gets the useShortLabel attribute.

Returns:

Returns the useShortLabel.

setUseShortLabel

public void setUseShortLabel(boolean useShortLabel)

Sets the useShortLabel attribute value.

Parameters:

useShortLabel - The useShortLabel to set.

isHidden

public boolean isHidden()

Gets the hidden attribute.

Returns:

Returns the hidden.

setHidden

public void setHidden(boolean hidden)

Sets the hidden attribute value.

Parameters:

hidden - The hidden to set.

getOverrideFields

public List<AccountingLineViewOverrideFieldDefinition> getOverrideFields()

Gets the overrideFields attribute.

Returns:

Returns the overrideFields.

setOverrideFields

public void setOverrideFields(List<AccountingLineViewOverrideFieldDefinition> overrideFields)

Sets the overrideFields attribute value.

Parameters:

overrideFields - The overrideFields to set.

getDynamicNameLabelGeneratorBeanName

public String getDynamicNameLabelGeneratorBeanName()

Gets the dynamicNameLabelGeneratorBeanName attribute.

Returns:

Returns the dynamicNameLabelGeneratorBeanName.

setDynamicNameLabelGeneratorBeanName

public void setDynamicNameLabelGeneratorBeanName(String dynamicNameLabelGeneratorBeanName)

Sets the dynamicNameLabelGeneratorBeanName attribute value.

Parameters:

dynamicNameLabelGeneratorBeanName - The dynamicNameLabelGeneratorBeanName to set.

getOverrideColSpan

public int getOverrideColSpan()

Gets the overrideColSpan attribute.

Returns:

Returns the overrideColSpan.

setOverrideColSpan

public void setOverrideColSpan(int overrideColSpan)

Sets the overrideColSpan attribute value.

Parameters:

overrideColSpan - The overrideColSpan to set.

getAccountingLineViewFieldClass

public Class<? extends AccountingLineViewField> getAccountingLineViewFieldClass()

Gets the accountingLineViewFieldClass attribute.

Returns:

Returns the accountingLineViewFieldClass.

setAccountingLineViewFieldClass

public void setAccountingLineViewFieldClass(Class<? extends AccountingLineViewField> accountingLineViewFieldClass)

Sets the accountingLineViewFieldClass attribute value.

Parameters:

accountingLineViewFieldClass - The accountingLineViewFieldClass to set.

getDynamicNameLabelGenerator

public DynamicNameLabelGenerator getDynamicNameLabelGenerator()

Returns the dynamicNameLabelGenerator for this field definition, if it has one

Returns:

an implementation of DynamicNameLabelGenerator to use for this field

createLayoutElement

public TableJoining createLayoutElement(Class<? extends AccountingLine> accountingLineClass)

Description copied from interface: AccountingLineViewRenderableElementDefinition

Returns the TableJoining element that this definition requires to be part of the accounting line view

Specified by:

createLayoutElement in interface AccountingLineViewRenderableElementDefinition

Returns:

a properly created TableJoining element

See Also:

org.kuali.kfs.sys.document.datadictionary.AccountingLineViewRenderableElementDefinition#createLayoutElement()

getNewAccountingLineViewField

protected AccountingLineViewField getNewAccountingLineViewField()

Creates a new instance of the accounting line view field class this definition uses

Returns:

a new AccountingLineViewField instance or child class instance

getKNSFieldForDefinition

public org.kuali.rice.kns.web.ui.Field getKNSFieldForDefinition(Class<? extends AccountingLine> accountingLineClass)

Creates a KNS Field for an AccountingLineViewField definition

Parameters:

accountingLineClass - the class of the accounting line used by this definition

Returns:

a properly initialized KNS field

getFieldsForOverrideFields

protected List<AccountingLineViewOverrideField> getFieldsForOverrideFields(AccountingLineViewField parentField,
                                                                           Class<? extends AccountingLine> accountingLineClass)

For each defined override field within this definition, creates a Field and puts them together as a List

Parameters:

parentField - the AccountingLineViewField which will own all of the override fields

accountingLineClass - the class of accounting lines which will be rendered

Returns:

a List of override fields, or if no override fields were defined, an empty List

getOverrideLookupParameters

public String getOverrideLookupParameters()

Gets the overrideLookupParameters attribute.

Returns:

Returns the overrideLookupParameters.

setOverrideLookupParameters

public void setOverrideLookupParameters(String overrideLookupParameters)

Sets the overrideLookupParameters attribute value.

Parameters:

overrideLookupParameters - The overrideLookupParameters to set.