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

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

All Implemented Interfaces:

FieldRenderer, Renderer

Direct Known Subclasses:

CheckboxRenderer, DropDownRenderer, HiddenRenderer, OverrideFieldRenderer, QuickFinderRenderer, RadioButtonGroupRenderer, ReadOnlyRenderer, TextAreaRenderer, TextRenderer

public abstract class FieldRendererBase
extends Object
implements FieldRenderer

Base class for all renderers which render fields

Constructor Summary

FieldRendererBase()

Method Summary

protected String	buildOnBlur() Writes the onblur call for the wrapped field
void	clear() Clears the field
void	closeNoWrapSpan(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Renders the closing of a no wrap span
protected String	getAccessibleTitle() Returns an accessible title for the field being rendered
protected String	getDynamicNameLabel()
protected String	getErrorIconImageTag()
org.kuali.rice.kns.web.ui.Field	getField() Returns the field to render
protected String	getFieldName()
protected int	getQuickfinderTabIndex()
boolean	isShowError() Gets the showError attribute.
void	openNoWrapSpan(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Renders the opening of a no-wrap span
void	overrideOnBlur(String onBlur) Overrides the onBlur setting for this renderer
protected void	renderErrorIcon(javax.servlet.jsp.PageContext pageContext) Renders the error icon
protected void	renderQuickFinderIfNecessary(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.Tag parentTag) Renders a quick finder for the field if one is warranted
void	setAccessibleTitle(String accessibleTitle) Sets the accessible title of the current field
void	setArbitrarilyHighTabIndex(int tabIndex) Sets the tab index the field being rendered should use - if it never ever wants to get tabbed to
void	setDynamicNameLabel(String dynamicNameLabel) On the renderer, sets the name of the dynamic name label
void	setField(org.kuali.rice.kns.web.ui.Field field) Sets the field to render
void	setShowError(boolean showError) Sets the showError attribute value.

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.renderers.FieldRenderer

renderQuickfinder

Methods inherited from interface org.kuali.kfs.sys.document.web.renderers.Renderer

render

Constructor Detail

FieldRendererBase

public FieldRendererBase()

Method Detail

setField

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

Sets the field to render

Specified by:

setField in interface FieldRenderer

Parameters:

field - the field to render

See Also:

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

getField

public org.kuali.rice.kns.web.ui.Field getField()

Returns the field to render

Returns:

the field to render

getFieldName

protected String getFieldName()

Returns:

the name this field should have on the form

clear

public void clear()

Clears the field

Specified by:

clear in interface Renderer

See Also:

Renderer.clear()

getAccessibleTitle

protected String getAccessibleTitle()

Returns an accessible title for the field being rendered

Returns:

an accessible title for the field to render

setAccessibleTitle

public void setAccessibleTitle(String accessibleTitle)

Sets the accessible title of the current field

Specified by:

setAccessibleTitle in interface FieldRenderer

Parameters:

accessibleTitle - the given the accessible title

renderQuickFinderIfNecessary

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

Renders a quick finder for the field if one is warranted

Parameters:

pageContext - the page context to render to

parentTag - the parent tag requesting all of this rendering

businessObjectToRender - the business object that will be rendered

Throws:

javax.servlet.jsp.JspException - thrown if something's off

buildOnBlur

protected String buildOnBlur()

Writes the onblur call for the wrapped field

Returns:

a value for onblur=

overrideOnBlur

public void overrideOnBlur(String onBlur)

Overrides the onBlur setting for this renderer

Specified by:

overrideOnBlur in interface FieldRenderer

Parameters:

onBlur - the onBlur value to set and return from buildOnBlur

getDynamicNameLabel

protected String getDynamicNameLabel()

Returns:

the dynamic name label field

setDynamicNameLabel

public void setDynamicNameLabel(String dynamicNameLabel)

Description copied from interface: FieldRenderer

On the renderer, sets the name of the dynamic name label

Specified by:

setDynamicNameLabel in interface FieldRenderer

Parameters:

dynamicNameLabel - the label to set

See Also:

FieldRenderer.setDynamicNameLabel(java.lang.String)

setArbitrarilyHighTabIndex

public void setArbitrarilyHighTabIndex(int tabIndex)

Description copied from interface: FieldRenderer

Sets the tab index the field being rendered should use - if it never ever wants to get tabbed to

Specified by:

setArbitrarilyHighTabIndex in interface FieldRenderer

Parameters:

tabIndex - a tab index no human will have the patience to reach

See Also:

FieldRenderer.setArbitrarilyHighTabIndex(int)

getQuickfinderTabIndex

protected int getQuickfinderTabIndex()

Returns:

the tab index the quick finder should use - which, by default, is the arbitrarily high tab index

closeNoWrapSpan

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

Description copied from interface: FieldRenderer

Renders the closing of a no wrap span

Specified by:

closeNoWrapSpan in interface FieldRenderer

Parameters:

pageContext - the page contex to render to

parentTag - the tag requesting all of this rendering

Throws:

javax.servlet.jsp.JspException - thrown if something goes wrong in rendering

See Also:

org.kuali.kfs.sys.document.web.renderers.FieldRenderer#closeNoWrapSpan()

openNoWrapSpan

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

Description copied from interface: FieldRenderer

Renders the opening of a no-wrap span

Specified by:

openNoWrapSpan in interface FieldRenderer

Parameters:

pageContext - the page contex to render to

parentTag - the tag requesting all of this rendering

Throws:

javax.servlet.jsp.JspException - thrown if something goes wrong in rendering

See Also:

org.kuali.kfs.sys.document.web.renderers.FieldRenderer#openNoWrapSpan()

isShowError

public boolean isShowError()

Gets the showError attribute.

Returns:

Returns the showError.

setShowError

public void setShowError(boolean showError)

Sets the showError attribute value.

Specified by:

setShowError in interface FieldRenderer

Parameters:

showError - The showError to set.

renderErrorIcon

protected void renderErrorIcon(javax.servlet.jsp.PageContext pageContext)
                        throws javax.servlet.jsp.JspException

Renders the error icon

Parameters:

pageContext - the page context to render to

Throws:

IOException - thrown if the pageContext cannot be written to

javax.servlet.jsp.JspException

getErrorIconImageTag

protected String getErrorIconImageTag()

Returns:

the tag for the error icon