org.kuali.kfs.sys.document.web
Interface RenderableElement

All Known Implementing Classes:

AccountingLineTable, AccountingLineTableCell, AccountingLineTableRow, AccountingLineViewActionsField, AccountingLineViewCountedSequenceNumberField, AccountingLineViewDebitCreditAmountField, AccountingLineViewField, AccountingLineViewMultipleReadOnlyFields, AccountingLineViewOverrideField, AccountingLineViewSequenceNumberField, FieldHeaderLabel, FieldTableJoining, FieldTableJoiningWithHeader, HeaderLabel, HideShowBlock, LiteralHeaderLabel, PurapAccountingLineViewField, RenderableAccountingLineContainer

public interface RenderableElement

Methods needed by elements of accounting lines that plan on rendering themselves

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
boolean	isActionBlock() Determines if this element is an action block or not
boolean	isEmpty() Is this renderable element empty of any truly renderable content?
boolean	isHidden() Determines if this element is hidden or not
void	populateWithTabIndexIfRequested(int reallyHighIndex) Allows the arbitrarily high tab index to be set for controls
void	renderElement(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag, AccountingLineRenderingContext renderingContext) Renders this element

Method Detail

isHidden

boolean isHidden()

Determines if this element is hidden or not

Returns:

true if hidden, false otherwise

isActionBlock

boolean isActionBlock()

Determines if this element is an action block or not

Returns:

true if this is an action block, false otherwise

isEmpty

boolean isEmpty()

Is this renderable element empty of any truly renderable content?

Returns:

true if it should not be rendered, false otherwise

renderElement

void renderElement(javax.servlet.jsp.PageContext pageContext,
                   javax.servlet.jsp.tagext.Tag parentTag,
                   AccountingLineRenderingContext renderingContext)
                   throws javax.servlet.jsp.JspException

Renders this element

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

appendFields

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

Parameters:

fieldNames - the List of fields to append fields to

populateWithTabIndexIfRequested

void populateWithTabIndexIfRequested(int reallyHighIndex)

Allows the arbitrarily high tab index to be set for controls

Parameters:

reallyHighIndex - a really high index for elements who should not be tabbed to