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

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

All Implemented Interfaces:

RenderableElement

Direct Known Subclasses:

FieldHeaderLabel, LiteralHeaderLabel

public abstract class HeaderLabel
extends Object
implements RenderableElement

Base class for header labels

Constructor Summary

HeaderLabel()

Method Summary

void	appendFields(List<org.kuali.rice.kns.web.ui.Field> fields) Header labels aren't really fields, so they append nothing
boolean	isActionBlock() Header labels are never action blocks
boolean	isEmpty() Returns whether the label field is either hidden or empty; this way, any labels for moved hidden fields will be removed
boolean	isHidden() Header labels are never hidden
boolean	isLabeledFieldEmptyOrHidden() Gets the labeledFieldEmptyOrHidden attribute.
void	populateWithTabIndexIfRequested(int reallyHighIndex) Does nothing
void	setLabeledFieldEmptyOrHidden(boolean labeledFieldEmptyOrHidden) Sets the labeledFieldEmptyOrHidden 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.RenderableElement

renderElement

Constructor Detail

HeaderLabel

public HeaderLabel()

Method Detail

isActionBlock

public boolean isActionBlock()

Header labels are never action blocks

Specified by:

isActionBlock in interface RenderableElement

Returns:

true if this is an action block, false otherwise

See Also:

RenderableElement.isActionBlock()

isHidden

public boolean isHidden()

Header labels are never hidden

Specified by:

isHidden in interface RenderableElement

Returns:

true if hidden, false otherwise

See Also:

RenderableElement.isHidden()

isEmpty

public boolean isEmpty()

Returns whether the label field is either hidden or empty; this way, any labels for moved hidden fields will be removed

Specified by:

isEmpty in interface RenderableElement

Returns:

true if it should not be rendered, false otherwise

See Also:

RenderableElement.isEmpty()

isLabeledFieldEmptyOrHidden

public boolean isLabeledFieldEmptyOrHidden()

Gets the labeledFieldEmptyOrHidden attribute.

Returns:

Returns the labeledFieldEmptyOrHidden.

setLabeledFieldEmptyOrHidden

public void setLabeledFieldEmptyOrHidden(boolean labeledFieldEmptyOrHidden)

Sets the labeledFieldEmptyOrHidden attribute value.

Parameters:

labeledFieldEmptyOrHidden - The labeledFieldEmptyOrHidden to set.

appendFields

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

Header labels aren't really fields, so they append nothing

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)

Does nothing

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)