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

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

All Implemented Interfaces:

ElementNamable, RenderableElement, TableJoining

Direct Known Subclasses:

FieldTableJoiningWithHeader

public abstract class FieldTableJoining
extends Object
implements TableJoining, RenderableElement

Abstract class which contains functionality of table joining layout elements that will eventually render fields

Constructor Summary

FieldTableJoining()

Method Summary

protected AccountingLineTableCell	createTableCell() Creates a table cell that encapsulates this field
int	getRequestedRowCount() Always returns 1 - any field can live within 1 row.
boolean	isActionBlock() We're going to go out on a limb and bet that this isn't an action block
boolean	isEmpty() This is a field.
boolean	isHidden() Default: assumes the field is not hidden
void	joinRow(AccountingLineTableRow headerLabelRow, AccountingLineTableRow row) Joins ths field to the header row, spans the regular 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) Sets this to read only if possible
void	removeAllActionBlocks() Removes any action blocks from the given element
void	removeUnviewableBlocks(Set<String> unviewableBlocks) This method really doesn't do much - it assumes there are no child fields to remove
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 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.ElementNamable

getName

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

appendFields, populateWithTabIndexIfRequested, renderElement

Constructor Detail

FieldTableJoining

public FieldTableJoining()

Method Detail

getRequestedRowCount

public int getRequestedRowCount()

Always returns 1 - any field can live within 1 row.

Specified by:

getRequestedRowCount in interface TableJoining

Returns:

the minimum number of rows

See Also:

org.kuali.kfs.sys.document.web.AccountingLineViewRenderableElement#getRequestedRowCount()

createTableCell

protected AccountingLineTableCell createTableCell()

Creates a table cell that encapsulates this field

Returns:

the created table cell

joinTable

public void joinTable(List<AccountingLineTableRow> rows)

Description copied from interface: TableJoining

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

Specified by:

joinTable in interface TableJoining

Parameters:

rows - the rows to join

See Also:

org.kuali.kfs.sys.document.web.AccountingLineViewRenderableElement#joinTable(java.util.List)

removeAllActionBlocks

public void removeAllActionBlocks()

Description copied from interface: TableJoining

Removes any action blocks from the given element

Specified by:

removeAllActionBlocks in interface TableJoining

See Also:

TableJoining.removeAllActionBlocks()

isHidden

public boolean isHidden()

Default: assumes the field is not hidden

Specified by:

isHidden in interface RenderableElement

Returns:

true if hidden, false otherwise

See Also:

RenderableElement.isHidden()

isActionBlock

public boolean isActionBlock()

We're going to go out on a limb and bet that this isn't an action block

Specified by:

isActionBlock in interface RenderableElement

Returns:

true if this is an action block, false otherwise

See Also:

RenderableElement.isActionBlock()

joinRow

public void joinRow(AccountingLineTableRow headerLabelRow,
                    AccountingLineTableRow row)

Joins ths field to the header row, spans the regular row

Specified by:

joinRow in interface TableJoining

Parameters:

headerLabelRow - the header row which can be joined

row - the row which can be joined

See Also:

TableJoining.joinRow(org.kuali.kfs.sys.document.web.AccountingLineTableRow, org.kuali.kfs.sys.document.web.AccountingLineTableRow)

isEmpty

public boolean isEmpty()

This is a field. It's never empty.

Specified by:

isEmpty in interface RenderableElement

Returns:

true if it should not be rendered, false otherwise

See Also:

RenderableElement.isEmpty()

removeUnviewableBlocks

public void removeUnviewableBlocks(Set<String> unviewableBlocks)

This method really doesn't do much - it assumes there are no child fields to remove

Specified by:

removeUnviewableBlocks in interface TableJoining

Parameters:

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

See Also:

org.kuali.kfs.sys.document.web.TableJoining#removeUnviewableBlocks()

readOnlyizeReadOnlyBlocks

public void readOnlyizeReadOnlyBlocks(Set<String> readOnlyBlocks)

Sets this to read only if possible

Specified by:

readOnlyizeReadOnlyBlocks in interface TableJoining

Parameters:

readOnlyBlocks - the names of blocks to make read only

See Also:

TableJoining.readOnlyizeReadOnlyBlocks(java.util.Set)

setEditableBlocks

public void setEditableBlocks(Set<String> editableBlocks)

Description copied from interface: TableJoining

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

Specified by:

setEditableBlocks in interface TableJoining

See Also:

TableJoining.setEditableBlocks(java.util.Set)

performFieldTransformations

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

Description copied from interface: TableJoining

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

Specified by:

performFieldTransformations in interface TableJoining

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

unconvertedValues - any unconverted values from the form

See Also:

org.kuali.kfs.sys.document.web.TableJoining#performFieldTransformation(org.kuali.kfs.sys.document.service.AccountingLineFieldRenderingTransformation, org.kuali.kfs.sys.businessobject.AccountingLine, java.util.Map, java.util.Map)