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

All Superinterfaces:

ElementNamable

All Known Subinterfaces:

AccountingLineViewLineFillingElement, TableJoiningWithHeader

All Known Implementing Classes:

AccountingLineViewActionsField, AccountingLineViewColumns, AccountingLineViewCountedSequenceNumberField, AccountingLineViewCurrentBaseAmount, AccountingLineViewDebitCreditAmountLayoutElement, AccountingLineViewField, AccountingLineViewLine, AccountingLineViewLines, AccountingLineViewMultipleReadOnlyFields, AccountingLineViewSequenceNumberField, FieldTableJoining, FieldTableJoiningWithHeader, HideShowLayoutElement, PlaceHoldingLayoutElement, PurapAccountingLineViewField

public interface TableJoining
extends ElementNamable

An interface which specifies the behaviors needed from layout elements to join tables

Method Summary

int	getRequestedRowCount() The minimum number of rows this element needs if it is going to join a table
void	joinRow(AccountingLineTableRow headerLabelRow, AccountingLineTableRow row) Requests that this element join a table row
void	joinTable(List<AccountingLineTableRow> rows) Requests that this layout element property join a number of rows which will make up a table
void	performFieldTransformations(List<AccountingLineFieldRenderingTransformation> fieldTransformations, AccountingLine accountingLine, Map unconvertedValues) Performs a transformations on any fields this TableJoining layout element knows about
void	readOnlyizeReadOnlyBlocks(Set<String> readOnlyBlocks) Instructs the element to make any child readOnlyizable blocks named within the given Set to read only
void	removeAllActionBlocks() Removes any action blocks from the given element
void	removeUnviewableBlocks(Set<String> unviewableBlocks) Removes any unviewable blocks within this this table joining element
void	setEditableBlocks(Set<String> editableBlocks) Instructs the element to make any child readOnlyizable blocks named within the given Set to read only

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

getName

Method Detail

joinTable

void joinTable(List<AccountingLineTableRow> rows)

Requests that this layout element property join a number of rows which will make up a table

Parameters:

rows - the rows to join

headerRowCount - the number of header rows

joinRow

void joinRow(AccountingLineTableRow headerLabelRow,
             AccountingLineTableRow row)

Requests that this element join a table row

Parameters:

headerLabelRow - the header row which can be joined

row - the row which can be joined

getRequestedRowCount

int getRequestedRowCount()

The minimum number of rows this element needs if it is going to join a table

Returns:

the minimum number of rows

removeAllActionBlocks

void removeAllActionBlocks()

Removes any action blocks from the given element

removeUnviewableBlocks

void removeUnviewableBlocks(Set<String> unviewableBlocks)

Removes any unviewable blocks within this this table joining element

Parameters:

unviewableBlocks - a Set of the names of blocks that should not be rendered

readOnlyizeReadOnlyBlocks

void readOnlyizeReadOnlyBlocks(Set<String> readOnlyBlocks)

Instructs the element to make any child readOnlyizable blocks named within the given Set to read only

Parameters:

readOnlyBlocks - the names of blocks to make read only

setEditableBlocks

void setEditableBlocks(Set<String> editableBlocks)

Instructs the element to make any child readOnlyizable blocks named within the given Set to read only

Parameters:

readOnlyBlocks - the names of blocks to make read only

performFieldTransformations

void performFieldTransformations(List<AccountingLineFieldRenderingTransformation> fieldTransformations,
                                 AccountingLine accountingLine,
                                 Map unconvertedValues)

Performs a transformations on any fields this TableJoining layout element knows about

Parameters:

accountingDocument - the document the field of the accounting line is associated with

fieldTransformation - a List of field transformations to perform on this element

accountingLine - the accounting line which is being rendering during the transformation

unconvertedValues - any unconverted values from the form