org.kuali.ole.sys.document.web

Class PlaceHoldingLayoutElement

java.lang.Object

org.kuali.ole.sys.document.web.PlaceHoldingLayoutElement

All Implemented Interfaces:

ElementNamable, TableJoining, TableJoiningWithHeader

public class PlaceHoldingLayoutElement
extends Object
implements TableJoiningWithHeader

There are sometimes line elements which have fewer cells than other line elements within a lines element; this element exists to fill those out.

Constructor Summary

Constructors

Constructor and Description
PlaceHoldingLayoutElement(int colSpan) Constructs a PlaceHoldingLayoutElement, setting the colspan for the element

Method Summary

Methods

Modifier and Type	Method and Description
HeaderLabel	createHeaderLabel() Returns a header with a non-breaking space
int	getColSpan() Gets the colSpan attribute.
protected AccountingLineTableCell	getLabelCell() Creates a place holding label cell
String	getName() Returns an empty String
protected AccountingLineTableCell	getPlaceHoldingCell() Returns an empty table cell, colspan cells wide
int	getRequestedRowCount() This only requests one row, not that it really matters.
boolean	isHidden() The point of this thing is to show up
void	joinRow(AccountingLineTableRow headerLabelRow, AccountingLineTableRow row) Joins the given row and header
void	joinTable(List<AccountingLineTableRow> rows) This will likely never be called
void	performFieldTransformations(List<AccountingLineFieldRenderingTransformation> fieldTransformations, AccountingLine accountingLine, Map unconvertedValues) No fields to transform
void	readOnlyizeReadOnlyBlocks(Set<String> readOnlyBlocks) This will never read onlyize anything
void	removeAllActionBlocks() This doesn't have any child blocks
void	removeUnviewableBlocks(Set<String> unviewableBlocks) This will never remove child blocks
void	setColSpan(int colSpan) Sets the colSpan attribute value.
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

Constructor Detail

PlaceHoldingLayoutElement

public PlaceHoldingLayoutElement(int colSpan)

Constructs a PlaceHoldingLayoutElement, setting the colspan for the element

Parameters:

colSpan - the colspan to set

Method Detail

createHeaderLabel

public HeaderLabel createHeaderLabel()

Returns a header with a non-breaking space

Specified by:

createHeaderLabel in interface TableJoiningWithHeader

Returns:

the property to lookup the label in the data dictionary

See Also:

TableJoiningWithHeader.createHeaderLabel()

isHidden

public boolean isHidden()

The point of this thing is to show up

Specified by:

isHidden in interface TableJoiningWithHeader

Returns:

true if the table joiner will be hidden, false otherwise - in which case a header cell will be rendered

See Also:

TableJoiningWithHeader.isHidden()

getName

public String getName()

Returns an empty String

Specified by:

getName in interface ElementNamable

Returns:

the names of this table joining element

See Also:

ElementNamable.getName()

getRequestedRowCount

public int getRequestedRowCount()

This only requests one row, not that it really matters.

Specified by:

getRequestedRowCount in interface TableJoining

Returns:

the minimum number of rows

See Also:

TableJoining.getRequestedRowCount()

joinRow

public void joinRow(AccountingLineTableRow headerLabelRow,
           AccountingLineTableRow row)

Joins the given row and header

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.ole.sys.document.web.AccountingLineTableRow, org.kuali.ole.sys.document.web.AccountingLineTableRow)

joinTable

public void joinTable(List<AccountingLineTableRow> rows)

This will likely never be called

Specified by:

joinTable in interface TableJoining

Parameters:

rows - the rows to join

See Also:

TableJoining.joinTable(java.util.List)

getLabelCell

protected AccountingLineTableCell getLabelCell()

Creates a place holding label cell

Parameters:

rowSpan - the row span the cell should be

Returns:

a table cell holding a place holding label cell

getPlaceHoldingCell

protected AccountingLineTableCell getPlaceHoldingCell()

Returns an empty table cell, colspan cells wide

Parameters:

rowSpan - the number of rows this cell should span

Returns:

an empty accounting line table cell that will fill up the space

performFieldTransformations

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

No fields to transform

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.ole.sys.document.web.TableJoining#performFieldTransformations(java.util.List, org.kuali.ole.sys.businessobject.AccountingLine, java.util.Map, java.util.Map)

removeAllActionBlocks

public void removeAllActionBlocks()

This doesn't have any child blocks

Specified by:

removeAllActionBlocks in interface TableJoining

See Also:

TableJoining.removeAllActionBlocks()

removeUnviewableBlocks

public void removeUnviewableBlocks(Set<String> unviewableBlocks)

This will never remove child blocks

Specified by:

removeUnviewableBlocks in interface TableJoining

Parameters:

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

See Also:

TableJoining.removeUnviewableBlocks(java.util.Set)

readOnlyizeReadOnlyBlocks

public void readOnlyizeReadOnlyBlocks(Set<String> readOnlyBlocks)

This will never read onlyize anything

Specified by:

readOnlyizeReadOnlyBlocks in interface TableJoining

Parameters:

readOnlyBlocks - the names of blocks to make read only

See Also:

TableJoining.readOnlyizeReadOnlyBlocks(java.util.Set)

getColSpan

public int getColSpan()

Gets the colSpan attribute.

Returns:

Returns the colSpan.

setColSpan

public void setColSpan(int colSpan)

Sets the colSpan attribute value.

Parameters:

colSpan - The colSpan to 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)