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

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

All Implemented Interfaces:

RenderableElement

public class AccountingLineTableCell
extends Object
implements RenderableElement

A class which represents a number of fields held in a table cell.

Constructor Summary

AccountingLineTableCell()

Method Summary

void	addRenderableElement(RenderableElement element) Adds a renderable element to the elements this cell can render
void	appendFields(List<org.kuali.rice.kns.web.ui.Field> fields) Goes through fields, appending field names
int	getColSpan() Gets the colSpan attribute.
String	getExtraStyle() Gets the extraStyle attribute.
List<RenderableElement>	getRenderableElement() Gets the renderableElement attribute.
int	getRowSpan() Gets the rowSpan attribute.
String	getStyleClassOverride() Gets the styleClassOverride attribute.
boolean	hasChildElements() Determines if this cell has child elements
boolean	isActionBlock() This is not an action block
boolean	isEmpty() Is this renderable element empty of any truly renderable content?
boolean	isHidden() Determines if this element is hidden or not
boolean	isNeverEmpty() Gets the neverEmpty attribute.
boolean	isRendersAsHeader() Gets the rendersAsHeader attribute.
void	populateWithTabIndexIfRequested(int reallyHighIndex) Allows the arbitrarily high tab index to be set for controls
void	renderChildrenElements(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Requests that this cell render all of its children cells
void	renderElement(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag, AccountingLineRenderingContext renderingContext) Renders this element
boolean	safeToRemove() Determines if this field is safe to remove.
void	setColSpan(int colSpan) Sets the colSpan attribute value.
void	setExtraStyle(String extraStyle) Sets the extraStyle attribute value.
void	setNeverEmpty(boolean neverEmpty) Sets the neverEmpty attribute value.
void	setRenderableElement(List<RenderableElement> renderableElement) Sets the renderableElement attribute value.
void	setRendersAsHeader(boolean rendersAsHeader) Sets the rendersAsHeader attribute value.
void	setRowSpan(int rowSpan) Sets the rowSpan attribute value.
void	setStyleClassOverride(String styleClassOverride) Sets the styleClassOverride attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountingLineTableCell

public AccountingLineTableCell()

Method Detail

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.

getRowSpan

public int getRowSpan()

Gets the rowSpan attribute.

Returns:

Returns the rowSpan.

setRowSpan

public void setRowSpan(int rowSpan)

Sets the rowSpan attribute value.

Parameters:

rowSpan - The rowSpan to set.

getRenderableElement

public List<RenderableElement> getRenderableElement()

Gets the renderableElement attribute.

Returns:

Returns the renderableElement.

setRenderableElement

public void setRenderableElement(List<RenderableElement> renderableElement)

Sets the renderableElement attribute value.

Parameters:

renderableElement - The renderableElement to set.

addRenderableElement

public void addRenderableElement(RenderableElement element)

Adds a renderable element to the elements this cell can render

Parameters:

element - another element to render within this cell

isHidden

public boolean isHidden()

Description copied from interface: RenderableElement

Determines if this element is hidden or not

Specified by:

isHidden in interface RenderableElement

Returns:

true if hidden, false otherwise

See Also:

RenderableElement.isHidden()

isActionBlock

public boolean isActionBlock()

This is not an action block

Specified by:

isActionBlock in interface RenderableElement

Returns:

true if this is an action block, false otherwise

See Also:

RenderableElement.isActionBlock()

isEmpty

public boolean isEmpty()

Description copied from interface: RenderableElement

Is this renderable element empty of any truly renderable content?

Specified by:

isEmpty in interface RenderableElement

Returns:

true if it should not be rendered, false otherwise

See Also:

RenderableElement.isEmpty()

isRendersAsHeader

public boolean isRendersAsHeader()

Gets the rendersAsHeader attribute.

Returns:

Returns the rendersAsHeader.

setRendersAsHeader

public void setRendersAsHeader(boolean rendersAsHeader)

Sets the rendersAsHeader attribute value.

Parameters:

rendersAsHeader - The rendersAsHeader to set.

getExtraStyle

public String getExtraStyle()

Gets the extraStyle attribute.

Returns:

Returns the extraStyle.

setExtraStyle

public void setExtraStyle(String extraStyle)

Sets the extraStyle attribute value.

Parameters:

extraStyle - The extraStyle to set.

isNeverEmpty

public boolean isNeverEmpty()

Gets the neverEmpty attribute.

Returns:

Returns the neverEmpty.

setNeverEmpty

public void setNeverEmpty(boolean neverEmpty)

Sets the neverEmpty attribute value.

Parameters:

neverEmpty - The neverEmpty to set.

getStyleClassOverride

public String getStyleClassOverride()

Gets the styleClassOverride attribute.

Returns:

Returns the styleClassOverride.

setStyleClassOverride

public void setStyleClassOverride(String styleClassOverride)

Sets the styleClassOverride attribute value.

Parameters:

styleClassOverride - The styleClassOverride to set.

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

Specified by:

renderElement in interface RenderableElement

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:

org.kuali.kfs.sys.document.web.RenderableElement#renderElement(javax.servlet.jsp.PageContext, javax.servlet.jsp.tagext.Tag)

renderChildrenElements

public void renderChildrenElements(javax.servlet.jsp.PageContext pageContext,
                                   javax.servlet.jsp.tagext.Tag parentTag)
                            throws javax.servlet.jsp.JspException

Requests that this cell render all of its children cells

Parameters:

pageContext - the page context of the rendering

parentTag - the parent tag requesting all this rendering

accountingLine - the accounting line getting rendered

accountingLineProperty - the property to get from the form to the accounting line

Throws:

javax.servlet.jsp.JspException - Oh. Shoot. Something went...wrong.

hasChildElements

public boolean hasChildElements()

Determines if this cell has child elements

Returns:

True if this cell has child elements, false otherwise

appendFields

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

Goes through fields, appending field names

Specified by:

appendFields in interface RenderableElement

See Also:

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

populateWithTabIndexIfRequested

public void populateWithTabIndexIfRequested(int reallyHighIndex)

Description copied from interface: RenderableElement

Allows the arbitrarily high tab index to be set for controls

Specified by:

populateWithTabIndexIfRequested in interface RenderableElement

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)

safeToRemove

public boolean safeToRemove()

Determines if this field is safe to remove. If any child elements are instances of FieldTableJoining, then it assumes not

Returns:

true if this cell is safe to remove; false otherwise