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

java.lang.Object
  org.kuali.kfs.sys.document.web.FieldTableJoining
      org.kuali.kfs.sys.document.web.FieldTableJoiningWithHeader
          org.kuali.kfs.sys.document.web.AccountingLineViewSequenceNumberField

All Implemented Interfaces:

ElementNamable, RenderableElement, TableJoining, TableJoiningWithHeader

Direct Known Subclasses:

AccountingLineViewCountedSequenceNumberField

public class AccountingLineViewSequenceNumberField
extends FieldTableJoiningWithHeader

A class to represent the rendering of a sequence number field

Constructor Summary

AccountingLineViewSequenceNumberField()

Method Summary

void	appendFields(List<org.kuali.rice.kns.web.ui.Field> fields) sequence number is never really related to lookups, so this implementation does nothing
HeaderLabel	createHeaderLabel() Returns the property of the accounting line business object that can be used to find the label for the given renderable element
protected AccountingLineTableCell	createTableCell() Creates a table cell that encapsulates this field
protected String	getDisplaySequenceNumber(AccountingLineRenderingContext renderingContext) Given the rendering context, returns what the sequence number of the line to be rendered is
String	getHeaderLabelProperty()
String	getName() Returns the name of this sequence number field
boolean	isReadOnly() Sequence numbers are always read only
void	populateWithTabIndexIfRequested(int reallyHighIndex) Does nothing
void	renderElement(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag, AccountingLineRenderingContext renderingContext) Renders this element
void	setName(String name) Sets the name of this sequence number field

Methods inherited from class org.kuali.kfs.sys.document.web.FieldTableJoiningWithHeader

createHeaderLabelTableCell, getRequestedRowCount, joinRow, joinTable

Methods inherited from class org.kuali.kfs.sys.document.web.FieldTableJoining

isActionBlock, isEmpty, isHidden, performFieldTransformations, readOnlyizeReadOnlyBlocks, removeAllActionBlocks, removeUnviewableBlocks, setEditableBlocks

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kfs.sys.document.web.TableJoiningWithHeader

isHidden

Methods inherited from interface org.kuali.kfs.sys.document.web.TableJoining

performFieldTransformations, readOnlyizeReadOnlyBlocks, removeAllActionBlocks, removeUnviewableBlocks, setEditableBlocks

Constructor Detail

AccountingLineViewSequenceNumberField

public AccountingLineViewSequenceNumberField()

Method Detail

isReadOnly

public boolean isReadOnly()

Sequence numbers are always read only

See Also:

org.kuali.kfs.sys.document.web.AccountingLineViewRenderableElementField#isReadOnly()

getName

public String getName()

Returns the name of this sequence number field

Returns:

the names of this table joining element

See Also:

ElementNamable.getName()

setName

public void setName(String name)

Sets the name of this sequence number field

Parameters:

name - the name to set

getHeaderLabelProperty

public String getHeaderLabelProperty()

See Also:

org.kuali.kfs.sys.document.web.TableJoiningWithHeader#getHeaderLabelProperty()

createTableCell

protected AccountingLineTableCell createTableCell()

Description copied from class: FieldTableJoining

Creates a table cell that encapsulates this field

Overrides:

createTableCell in class FieldTableJoining

Returns:

the created table cell

See Also:

FieldTableJoining.createTableCell()

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

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)

getDisplaySequenceNumber

protected String getDisplaySequenceNumber(AccountingLineRenderingContext renderingContext)

Given the rendering context, returns what the sequence number of the line to be rendered is

Parameters:

renderingContext - the rendering context which holds the accounting line

Returns:

the sequence number to render (not the one to store as a value)

createHeaderLabel

public HeaderLabel createHeaderLabel()

Description copied from interface: TableJoiningWithHeader

Returns the property of the accounting line business object that can be used to find the label for the given renderable element

Returns:

the property to lookup the label in the data dictionary

See Also:

TableJoiningWithHeader.createHeaderLabel()

appendFields

public void appendFields(List<org.kuali.rice.kns.web.ui.Field> fields)

sequence number is never really related to lookups, so this implementation does nothing

See Also:

org.kuali.kfs.sys.document.web.RenderableElement#appendFieldNames(java.util.List)

populateWithTabIndexIfRequested

public void populateWithTabIndexIfRequested(int reallyHighIndex)

Does nothing

Parameters:

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

See Also:

org.kuali.kfs.sys.document.web.RenderableElement#populateWithTabIndexIfRequested(int[], int)