org.kuali.kfs.sys.document.web.renderers
Class OverrideFieldRenderer

java.lang.Object
  org.kuali.kfs.sys.document.web.renderers.FieldRendererBase
      org.kuali.kfs.sys.document.web.renderers.OverrideFieldRenderer

All Implemented Interfaces:

FieldRenderer, Renderer

public class OverrideFieldRenderer
extends FieldRendererBase

The renderer of an override field

Constructor Summary

OverrideFieldRenderer()

Method Summary

protected String	buildLabelSpanClosing()
protected String	buildLabelSpanOpening()
protected String	buildLineBreak()
protected String	buildNonBreakingSpace()
void	clear() Cleans up the tags used to display this field
protected void	clearOverrideHiddenTag() Cleans up the hidden that displays information for the override
protected void	clearOverrideNeededTag() Cleans up the HiddenTag that renders override needed properties
AccountingLine	getAccountingLine() Gets the accountingLine attribute.
String	getOverrideNeededValue() Gets the overrideNeededValue attribute.
boolean	isReadOnly() Gets the readOnly attribute.
void	render(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Renders the override field and its associated override needed field
protected void	renderOverrideAsHidden(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Renders the override field as a hidden field
protected void	renderOverrideAsNonHidden(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Renders the override field as non-hidden (probably a checkbox)
protected void	renderOverrideNeededField(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Renders the overrideNeeded field (which is always hidden)
protected void	renderOverridePresent(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Renders the override field as a hidden field
boolean	renderQuickfinder() We never render quick finders on these
void	setAccountingLine(AccountingLine accountingLine) Sets the accountingLine attribute value.
void	setField(org.kuali.rice.kns.web.ui.Field overrideField) Also sets the overrideNeededProperty name
void	setOverrideNeededValue(String overrideNeededValue) Sets the overrideNeededValue attribute value.
void	setReadOnly(boolean readOnly) Sets the readOnly attribute value.

Methods inherited from class org.kuali.kfs.sys.document.web.renderers.FieldRendererBase

buildOnBlur, closeNoWrapSpan, getAccessibleTitle, getDynamicNameLabel, getErrorIconImageTag, getField, getFieldName, getQuickfinderTabIndex, isShowError, openNoWrapSpan, overrideOnBlur, renderErrorIcon, renderQuickFinderIfNecessary, setAccessibleTitle, setArbitrarilyHighTabIndex, setDynamicNameLabel, setShowError

Methods inherited from class java.lang.Object

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

Constructor Detail

OverrideFieldRenderer

public OverrideFieldRenderer()

Method Detail

renderQuickfinder

public boolean renderQuickfinder()

We never render quick finders on these

Returns:

true if a quick finder should be rendered, false otherwise

See Also:

FieldRenderer.renderQuickfinder()

clear

public void clear()

Cleans up the tags used to display this field

Specified by:

clear in interface Renderer

Overrides:

clear in class FieldRendererBase

See Also:

FieldRendererBase.clear()

clearOverrideHiddenTag

protected void clearOverrideHiddenTag()

Cleans up the hidden that displays information for the override

clearOverrideNeededTag

protected void clearOverrideNeededTag()

Cleans up the HiddenTag that renders override needed properties

setField

public void setField(org.kuali.rice.kns.web.ui.Field overrideField)

Also sets the overrideNeededProperty name

Specified by:

setField in interface FieldRenderer

Overrides:

setField in class FieldRendererBase

Parameters:

overrideField - the field to render

See Also:

FieldRendererBase.setField(org.kuali.rice.kns.web.ui.Field)

isReadOnly

public boolean isReadOnly()

Gets the readOnly attribute.

Returns:

Returns the readOnly.

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the readOnly attribute value.

Parameters:

readOnly - The readOnly to set.

getOverrideNeededValue

public String getOverrideNeededValue()

Gets the overrideNeededValue attribute.

Returns:

Returns the overrideNeededValue.

setOverrideNeededValue

public void setOverrideNeededValue(String overrideNeededValue)

Sets the overrideNeededValue attribute value.

Parameters:

overrideNeededValue - The overrideNeededValue to set.

getAccountingLine

public AccountingLine getAccountingLine()

Gets the accountingLine attribute.

Returns:

Returns the accountingLine.

setAccountingLine

public void setAccountingLine(AccountingLine accountingLine)

Sets the accountingLine attribute value.

Parameters:

accountingLine - The accountingLine to set.

render

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

Renders the override field and its associated override needed field

Parameters:

pageContext - the JSP page context to render to

parentTag - the tag that is the "parent" of this rendering

Throws:

javax.servlet.jsp.JspException

See Also:

Renderer.render(javax.servlet.jsp.PageContext, javax.servlet.jsp.tagext.Tag)

buildLineBreak

protected String buildLineBreak()

Returns:

the HTML for a line break

buildNonBreakingSpace

protected String buildNonBreakingSpace()

Returns:

the HTML for a non-breaking space

buildLabelSpanOpening

protected String buildLabelSpanOpening()

Returns:

builds the opening of the span tag to go around the label

buildLabelSpanClosing

protected String buildLabelSpanClosing()

Returns:

builds the closing of the span tag to go around the label

renderOverrideAsNonHidden

protected void renderOverrideAsNonHidden(javax.servlet.jsp.PageContext pageContext,
                                         javax.servlet.jsp.tagext.Tag parentTag)
                                  throws javax.servlet.jsp.JspException

Renders the override field as non-hidden (probably a checkbox)

Parameters:

pageContext - the page context to render to

parentTag - the tag requesting all this rendering

Throws:

javax.servlet.jsp.JspException - thrown if rendering fails

renderOverrideAsHidden

protected void renderOverrideAsHidden(javax.servlet.jsp.PageContext pageContext,
                                      javax.servlet.jsp.tagext.Tag parentTag)
                               throws javax.servlet.jsp.JspException

Renders the override field as a hidden field

Parameters:

pageContext - the page context to render to

parentTag - the tag requesting all this rendering

Throws:

javax.servlet.jsp.JspException - thrown if rendering fails

renderOverridePresent

protected void renderOverridePresent(javax.servlet.jsp.PageContext pageContext,
                                     javax.servlet.jsp.tagext.Tag parentTag)
                              throws javax.servlet.jsp.JspException

Renders the override field as a hidden field

Parameters:

pageContext - the page context to render to

parentTag - the tag requesting all this rendering

Throws:

javax.servlet.jsp.JspException - thrown if rendering fails

renderOverrideNeededField

protected void renderOverrideNeededField(javax.servlet.jsp.PageContext pageContext,
                                         javax.servlet.jsp.tagext.Tag parentTag)
                                  throws javax.servlet.jsp.JspException

Renders the overrideNeeded field (which is always hidden)

Parameters:

pageContext - the page context to render to

parentTag - the tag requesting all this rendering

Throws:

javax.servlet.jsp.JspException - thrown if rendering fails