org.kuali.rice.krad.uif.field
Class HeaderField

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase
          org.kuali.rice.krad.uif.field.FieldBase
              org.kuali.rice.krad.uif.field.FieldGroup
                  org.kuali.rice.krad.uif.field.HeaderField

All Implemented Interfaces:

Serializable, Component, Configurable, ScriptEventSupport, Field, org.springframework.core.Ordered

public class HeaderField
extends FieldGroup

Field that contains a header element and optionally a Group to present along with the header text

Generally the group is used to display content to the right of the header, such as links for the group or other information

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

HeaderField()

Method Summary

String	getHeaderDivStyle() Style that should be applied to the header div
String	getHeaderDivStyleClasses() Style class that should be applied to the header div
String	getHeaderLevel() HTML header level (h1 ...
String	getHeaderStyle() Style that should be applied to the header text
String	getHeaderStyleClasses() Style class that should be applied to the header text (h tag)
String	getHeaderText() Text that should be displayed on the header
void	performFinalize(View view, Object model, Component parent) The following finalization is performed: Set render on group to false if no items are configured
void	setHeaderDivStyle(String headerDivStyle) Setter for the header div
void	setHeaderDivStyleClasses(String headerDivStyleClasses) Setter for the header div class
void	setHeaderLevel(String headerLevel) Setter for the header level
void	setHeaderStyle(String headerStyle) Setter for the header style
void	setHeaderStyleClasses(String headerStyleClasses) Setter for the header style class
void	setHeaderText(String headerText) Setter for the header text

Methods inherited from class org.kuali.rice.krad.uif.field.FieldGroup

getComponentsForLifecycle, getGroup, getItems, performInitialization, setGroup, setItems

Methods inherited from class org.kuali.rice.krad.uif.field.FieldBase

getComponentTypeName, getLabel, getLabelField, getLabelPlacement, getShortLabel, isLabelFieldRendered, setLabel, setLabelField, setLabelFieldRendered, setLabelPlacement, setShortLabel, setShowLabel

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshDiscloseMethodToCall, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, performApplyModel, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setConditionalRefresh, setContext, setFactoryId, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshDiscloseMethodToCall, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

Methods inherited from class org.kuali.rice.krad.uif.component.ConfigurableBase

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

Constructor Detail

HeaderField

public HeaderField()

Method Detail

performFinalize

public void performFinalize(View view,
                            Object model,
                            Component parent)

The following finalization is performed:

• Set render on group to false if no items are configured

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class FieldBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

ComponentBase.performFinalize(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

getHeaderText

public String getHeaderText()

Text that should be displayed on the header

Returns:

String header text

setHeaderText

public void setHeaderText(String headerText)

Setter for the header text

Parameters:

headerText -

getHeaderLevel

public String getHeaderLevel()

HTML header level (h1 ... h6) that should be applied to the header text

Returns:

String header level

setHeaderLevel

public void setHeaderLevel(String headerLevel)

Setter for the header level

Parameters:

headerLevel -

getHeaderStyleClasses

public String getHeaderStyleClasses()

Style class that should be applied to the header text (h tag)

Note the style class given here applies to only the header text. The style class property inherited from the Component interface can be used to set the class for the whole field div (which could include a nested Group)

Returns:

String style class

See Also:

org.kuali.rice.krad.uif.Component.getStyleClasses()

setHeaderStyleClasses

public void setHeaderStyleClasses(String headerStyleClasses)

Setter for the header style class

Parameters:

headerStyleClasses -

getHeaderStyle

public String getHeaderStyle()

Style that should be applied to the header text

Note the style given here applies to only the header text. The style property inherited from the Component interface can be used to set the style for the whole field div (which could include a nested Group)

Returns:

String header style

See Also:

org.kuali.rice.krad.uif.Component.getStyle()

setHeaderStyle

public void setHeaderStyle(String headerStyle)

Setter for the header style

Parameters:

headerStyle -

getHeaderDivStyleClasses

public String getHeaderDivStyleClasses()

Style class that should be applied to the header div

Note the style class given here applies to the div surrounding the header tag only

Returns:

String style class

See Also:

org.kuali.rice.krad.uif.Component.getStyleClasses()

setHeaderDivStyleClasses

public void setHeaderDivStyleClasses(String headerDivStyleClasses)

Setter for the header div class

Parameters:

headerStyleClasses -

getHeaderDivStyle

public String getHeaderDivStyle()

Style that should be applied to the header div

Note the style given here applies to the div surrounding the header tag only

Returns:

String header style

See Also:

org.kuali.rice.krad.uif.Component.getStyle()

setHeaderDivStyle

public void setHeaderDivStyle(String headerDivStyle)

Setter for the header div

Parameters:

headerStyle -