org.kuali.rice.krad.uif.container
Class SidebarNavigationGroup

java.lang.Object
  org.kuali.rice.krad.datadictionary.DictionaryBeanBase
      org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
          org.kuali.rice.krad.uif.component.ComponentBase
              org.kuali.rice.krad.uif.container.ContainerBase
                  org.kuali.rice.krad.uif.container.Group
                      org.kuali.rice.krad.uif.container.SidebarNavigationGroup

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Container, LifecycleElement, Helpable, org.springframework.core.Ordered

public class SidebarNavigationGroup
extends Group

A navigation group which renders a menu with items, that is shown at the side of the page with collapse functionality

Items of this menu should only be of Header, Action, and ToggleMenu types. Actions and ToggleMenus must have icons to render correctly when using the collapse functionality, but will inherit the defaultItemIconClass if their iconClass properties are not set.

Author:

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

See Also:

Serialized Form

Field Summary

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

templateOptions

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

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

SidebarNavigationGroup()

Method Summary

protected <T> void	copyProperties(T component) Copies properties for copy()
String	getClosedToggleIconClass() Icon class to use to render a closed icon for sub menus (the ToggleMenu items) that exist in this navigation menu
String	getDefaultItemIconClass() The default css class to use for the icons of the items which exist in this navigation menu if they are not set on the items themselves (icons are required by Action and ToggleMenu items in this menu)
String	getOpenedToggleIconClass() Icon class to use to render a opened icon for sub menus (the ToggleMenu items) that exist in this navigation menu
boolean	isRenderCollapse() When true, render the collapse icon (an icon that the user can click to close/open the sidebar navigation)
void	performFinalize(Object model, Component parent) Adds icons and classes to Action and ToggleMenu items which exist in its items for rendering purposes
void	setClosedToggleIconClass(String closedToggleIconClass)
void	setDefaultItemIconClass(String defaultItemIconClass)
void	setOpenedToggleIconClass(String openedToggleIconClass)
void	setRenderCollapse(boolean renderCollapse)

Methods inherited from class org.kuali.rice.krad.uif.container.Group

completeValidation, getComponentsForLifecycle, getComponentTypeName, getDisclosure, getFieldBindByNamePrefix, getFieldBindingObjectPath, getItems, getScrollpane, getSupportedComponents, isRenderLoading, performInitialization, setDisclosure, setFieldBindByNamePrefix, setFieldBindingObjectPath, setItems, setScrollpane

Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase

getComponentPrototypes, getDefaultItemPosition, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, initializePendingTasks, isProcessRemoteFieldHolders, performApplyModel, setDefaultItemPosition, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages, sortItems

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

addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, clone, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializeComponentSecurity, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, notifyCompleted, preventModification, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewStatus, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

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

addDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewStatus, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, notifyCompleted, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getId, isMutable, setId

Methods inherited from interface org.kuali.rice.krad.datadictionary.Copyable

clone, copy, preventModification

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, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

SidebarNavigationGroup

public SidebarNavigationGroup()

Method Detail

performFinalize

public void performFinalize(Object model,
                            Component parent)

Adds icons and classes to Action and ToggleMenu items which exist in its items for rendering purposes

Sets the group to not render if it contains no content The following finalization is performed:

• Sets the headerText of the header Group if it is blank
• Set the messageText of the summary Message if it is blank
• Finalizes LayoutManager

Specified by:

performFinalize in interface LifecycleElement

Overrides:

performFinalize in class Group

Parameters:

model - - top level object containing the data

parent - - parent component

See Also:

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

isRenderCollapse

public boolean isRenderCollapse()

When true, render the collapse icon (an icon that the user can click to close/open the sidebar navigation)

Returns:

true if the collapse icon should be rendered, false otherwise

setRenderCollapse

public void setRenderCollapse(boolean renderCollapse)

See Also:

isRenderCollapse()

getOpenedToggleIconClass

public String getOpenedToggleIconClass()

Icon class to use to render a opened icon for sub menus (the ToggleMenu items) that exist in this navigation menu

Returns:

the opened ToggleMenu icon

setOpenedToggleIconClass

public void setOpenedToggleIconClass(String openedToggleIconClass)

See Also:

getOpenedToggleIconClass()

getClosedToggleIconClass

public String getClosedToggleIconClass()

Icon class to use to render a closed icon for sub menus (the ToggleMenu items) that exist in this navigation menu

Returns:

the closed ToggleMenu icon

setClosedToggleIconClass

public void setClosedToggleIconClass(String closedToggleIconClass)

See Also:

getClosedToggleIconClass()

getDefaultItemIconClass

public String getDefaultItemIconClass()

The default css class to use for the icons of the items which exist in this navigation menu if they are not set on the items themselves (icons are required by Action and ToggleMenu items in this menu)

Returns:

the default icon class

setDefaultItemIconClass

public void setDefaultItemIconClass(String defaultItemIconClass)

See Also:

getDefaultItemIconClass()

copyProperties

protected <T> void copyProperties(T component)

Copies properties for copy()

Overrides:

copyProperties in class Group

Parameters:

component - base bean

See Also:

DictionaryBeanBase.copyProperties(Object)