org.kuali.kfs.sys.document.web
Class AccountingLineViewDebitCreditAmountField

java.lang.Object
  extended by org.kuali.kfs.sys.document.web.AccountingLineViewDebitCreditAmountField
All Implemented Interfaces:
ElementNamable, RenderableElement

public class AccountingLineViewDebitCreditAmountField
extends Object
implements RenderableElement, ElementNamable

This class...


Constructor Summary
AccountingLineViewDebitCreditAmountField(org.kuali.rice.kns.web.ui.Field debitOrCreditField, AccountingLineViewFieldDefinition definition, boolean isDebit, String newLineProperty, String collectionProperty)
          Constructs a AccountingLineViewDebitOrCreditAmountField
 
Method Summary
 void appendFields(List<org.kuali.rice.kns.web.ui.Field> fields)
          Asks that the renderable element appends any field names it knows of to the given list; this is so that proper quick finders can be generated and population accomplished when fields themselves are rendered
 int getArbitrarilyHighIndex()
          Gets the arbitrarilyHighIndex attribute.
 String getCollectionProperty()
          Gets the collectionProperty attribute.
 org.kuali.rice.kns.web.ui.Field getDebitOrCreditField()
          Gets the debitOrCreditField attribute.
 AccountingLineViewFieldDefinition getDefinition()
          Gets the definition attribute.
 String getName()
          Returns the name(s) of this table joining element; some table joining elements are compound
 String getNewLineProperty()
          Gets the newLineProperty attribute.
 boolean isActionBlock()
          This is not an action block
 boolean isDebit()
          Gets the isDebit attribute.
 boolean isEmpty()
          This isn't empty
 boolean isHidden()
          This is not hidden
 void populateWithTabIndexIfRequested(int reallyHighIndex)
          Allows the arbitrarily high tab index to be set for controls
protected  void prepareFieldForRendering(org.kuali.rice.kns.web.ui.Field field, VoucherForm form, Integer count)
          Sets up the field for rendering by setting the right property name and zeroing out amounts which aren't needed
 void renderElement(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag, AccountingLineRenderingContext renderingContext)
          Renders this element
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AccountingLineViewDebitCreditAmountField

public AccountingLineViewDebitCreditAmountField(org.kuali.rice.kns.web.ui.Field debitOrCreditField,
                                                AccountingLineViewFieldDefinition definition,
                                                boolean isDebit,
                                                String newLineProperty,
                                                String collectionProperty)
Constructs a AccountingLineViewDebitOrCreditAmountField

Parameters:
debitOrCreditField -
definition -
isDebit -
newLineProperty -
collectionProperty -
Method Detail

appendFields

public void appendFields(List<org.kuali.rice.kns.web.ui.Field> fields)
Description copied from interface: RenderableElement
Asks that the renderable element appends any field names it knows of to the given list; this is so that proper quick finders can be generated and population accomplished when fields themselves are rendered

Specified by:
appendFields in interface RenderableElement
See Also:
RenderableElement.appendFields(java.util.List)

isActionBlock

public boolean isActionBlock()
This is not an action block

Specified by:
isActionBlock in interface RenderableElement
Returns:
true if this is an action block, false otherwise
See Also:
RenderableElement.isActionBlock()

isEmpty

public boolean isEmpty()
This isn't empty

Specified by:
isEmpty in interface RenderableElement
Returns:
true if it should not be rendered, false otherwise
See Also:
RenderableElement.isEmpty()

isHidden

public boolean isHidden()
This is not hidden

Specified by:
isHidden in interface RenderableElement
Returns:
true if hidden, false otherwise
See Also:
RenderableElement.isHidden()

populateWithTabIndexIfRequested

public void populateWithTabIndexIfRequested(int reallyHighIndex)
Description copied from interface: RenderableElement
Allows the arbitrarily high tab index to be set for controls

Specified by:
populateWithTabIndexIfRequested in interface RenderableElement
Parameters:
reallyHighIndex - a really high index for elements who should not be tabbed to
See Also:
RenderableElement.populateWithTabIndexIfRequested(int)

renderElement

public void renderElement(javax.servlet.jsp.PageContext pageContext,
                          javax.servlet.jsp.tagext.Tag parentTag,
                          AccountingLineRenderingContext renderingContext)
                   throws javax.servlet.jsp.JspException
Description copied from interface: RenderableElement
Renders this element

Specified by:
renderElement in interface RenderableElement
Parameters:
pageContext - the context to render to
parentTag - the parent tag that is requesting this rendering
renderingContext - the context about the accounting line that this element would end up rendering
Throws:
javax.servlet.jsp.JspException
See Also:
RenderableElement.renderElement(javax.servlet.jsp.PageContext, javax.servlet.jsp.tagext.Tag, org.kuali.kfs.sys.document.web.AccountingLineRenderingContext)

prepareFieldForRendering

protected void prepareFieldForRendering(org.kuali.rice.kns.web.ui.Field field,
                                        VoucherForm form,
                                        Integer count)
Sets up the field for rendering by setting the right property name and zeroing out amounts which aren't needed

Parameters:
field - the field to prepare
accountingLine - the accounting line being rendered
count - the count of the current line in the source lines, or null if it's a new line

getArbitrarilyHighIndex

public int getArbitrarilyHighIndex()
Gets the arbitrarilyHighIndex attribute.

Returns:
Returns the arbitrarilyHighIndex.

getCollectionProperty

public String getCollectionProperty()
Gets the collectionProperty attribute.

Returns:
Returns the collectionProperty.

getDebitOrCreditField

public org.kuali.rice.kns.web.ui.Field getDebitOrCreditField()
Gets the debitOrCreditField attribute.

Returns:
Returns the debitOrCreditField.

getDefinition

public AccountingLineViewFieldDefinition getDefinition()
Gets the definition attribute.

Returns:
Returns the definition.

isDebit

public boolean isDebit()
Gets the isDebit attribute.

Returns:
Returns the isDebit.

getNewLineProperty

public String getNewLineProperty()
Gets the newLineProperty attribute.

Returns:
Returns the newLineProperty.

getName

public String getName()
Description copied from interface: ElementNamable
Returns the name(s) of this table joining element; some table joining elements are compound

Specified by:
getName in interface ElementNamable
Returns:
the names of this table joining element
See Also:
ElementNamable.getName()


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.