org.kuali.rice.krad.uif.element
Class Header

java.lang.Object
  org.kuali.rice.krad.uif.component.ConfigurableBase
      org.kuali.rice.krad.uif.component.ComponentBase
          org.kuali.rice.krad.uif.element.ContentElementBase
              org.kuali.rice.krad.uif.element.Header

All Implemented Interfaces:

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

public class Header
extends ContentElementBase

Content element that renders 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

Header()

Method Summary

List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
String	getHeaderLevel() HTML header level (h1 ...
String	getHeaderStyleClassesAsString() Builds the HTML class attribute string by combining the headerStyleClasses list with a space delimiter
List<String>	getHeaderTagCssClasses() Style classes that should be applied to the header text (h tag)
String	getHeaderTagStyle() Style that should be applied to the header h tag
String	getHeaderText() Text that should be displayed on the header
List<? extends Component>	getItems() List of Component instances contained in the lower header group
Group	getLowerGroup() Nested group instance that can be used to render contents below the header text
Group	getRightGroup() Nested group instance that can be used to render contents to the right of the header text
Group	getUpperGroup() Nested group instance that can be used to render contents above the header text
void	performFinalize(View view, Object model, Component parent) The following finalization is performed: Set render on header group to false if no items are configured
void	setHeaderLevel(String headerLevel) Setter for the header level
void	setHeaderTagCssClasses(List<String> headerTagCssClasses) Setter for the list of classes to apply to the header h tag
void	setHeaderTagStyle(String headerTagStyle) Setter for the header h tag style
void	setHeaderText(String headerText) Setter for the header text
void	setItems(List<? extends Component> items) Setter for the lower group's items
void	setLowerGroup(Group lowerGroup) Setter for the header group instance that is rendered below the header text
void	setRightGroup(Group rightGroup) Setter for the header group instance that is rendered to the right of the header text
void	setUpperGroup(Group upperGroup) Setter for the header group instance that is rendered above the header text

Methods inherited from class org.kuali.rice.krad.uif.element.ContentElementBase

getComponentTypeName

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

addDataAttribute, addStyleClass, appendToStyle, getAlign, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getDataMetaAttribute, getDataRoleAttribute, getDataTypeAttribute, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setBaseId, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDataMetaAttribute, setDataRoleAttribute, setDataTypeAttribute, setDisableSessionPersistence, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, 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

addDataAttribute, addStyleClass, appendToStyle, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip

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, setOnBlurScript, setOnLoadScript

Constructor Detail

Header

public Header()

Method Detail

performFinalize

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

The following finalization is performed:

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

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class ComponentBase

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)

getComponentsForLifecycle

public List<Component> getComponentsForLifecycle()

Description copied from interface: Component

List of components that are contained within the component and should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getComponentsForLifecycle in interface Component

Overrides:

getComponentsForLifecycle in class ComponentBase

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

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 -

getHeaderTagCssClasses

public List<String> getHeaderTagCssClasses()

Style classes 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:

List list of style classes

See Also:

Component.getCssClasses()

setHeaderTagCssClasses

public void setHeaderTagCssClasses(List<String> headerTagCssClasses)

Setter for the list of classes to apply to the header h tag

Parameters:

headerTagCssClasses -

getHeaderStyleClassesAsString

public String getHeaderStyleClassesAsString()

Builds the HTML class attribute string by combining the headerStyleClasses list with a space delimiter

Returns:

String class attribute string

getHeaderTagStyle

public String getHeaderTagStyle()

Style that should be applied to the header h tag

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 header div (which could include a nested Group)

Returns:

String header style

See Also:

Component.getStyle()

setHeaderTagStyle

public void setHeaderTagStyle(String headerTagStyle)

Setter for the header h tag style

Parameters:

headerTagStyle -

getUpperGroup

public Group getUpperGroup()

Nested group instance that can be used to render contents above the header text

The header group is useful for adding content such as links or actions that is presented with the header

Returns:

Group instance

setUpperGroup

public void setUpperGroup(Group upperGroup)

Setter for the header group instance that is rendered above the header text

Parameters:

upperGroup -

getRightGroup

public Group getRightGroup()

Nested group instance that can be used to render contents to the right of the header text

The header group is useful for adding content such as links or actions that is presented with the header

Returns:

Group instance

setRightGroup

public void setRightGroup(Group rightGroup)

Setter for the header group instance that is rendered to the right of the header text

Parameters:

rightGroup -

getLowerGroup

public Group getLowerGroup()

Nested group instance that can be used to render contents below the header text

The header group is useful for adding content such as links or actions that is presented with the header

Returns:

Group instance

setLowerGroup

public void setLowerGroup(Group lowerGroup)

Setter for the header group instance that is rendered below the header text

Parameters:

lowerGroup -

getItems

public List<? extends Component> getItems()

List of Component instances contained in the lower header group

Convenience method for configuration to get the items List from the lower header group

Returns:

List items

setItems

public void setItems(List<? extends Component> items)

Setter for the lower group's items

Convenience method for configuration to set the items List for the lower header group

Parameters:

items -