org.kuali.rice.krad.demo.uif.components

Class ComponentLibraryView

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.view.View

org.kuali.rice.krad.uif.view.FormView

org.kuali.rice.krad.demo.uif.components.ComponentLibraryView

All Implemented Interfaces:

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

public class ComponentLibraryView
extends FormView

View for the ComponentLibrary demo examples of Uif Components

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComponentLibraryView.ExampleSize

Field Summary

Fields inherited from class org.kuali.rice.krad.uif.view.View

applyDirtyCheck, viewIndex

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

templateOptions

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

componentCode

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

Constructors

Constructor and Description
ComponentLibraryView() ComponentLibraryView constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentName() The name of the component (to be used by this page's header)
List<Group>	getDemoGroups() List of groups that will demostrate the functionality fo the component being demonstrated, these groups are copied directly into componentExhibit - this is an ease of use property
String	getDescription() The description of the component being demoed by this view
Group	getDetailsGroup() The details group that will contain the description, usage, and properties tabGroup
String	getDocBookAnchor() The anchor in the docbook this component is described at (do not include #)
ComponentLibraryView.ExampleSize	getExampleSize()
ComponentExhibit	getExhibit() Gets the exhibit that will display the example, source code, and tabs to switch between examples
SyntaxHighlighter	getHtmlCodeViewer() Html code viewer SyntaxHighlighter for displaying the html output by each example
String	getJavaFullClassPath() Set the java path to the class being used by this component TODO not yet used
String	getLargeExampleFieldId()
String	getRootDocBookAddress() Get the root address to the docbook for KRAD
String	getRootJavadocAddress() The root address to the javadoc for Rice
String	getUsage() Gets the usage description and examples of how to use this component
String	getXmlFilePath() The xml file path that contains the source being used for this demo, must start with / (relative path)
void	performInitialization(Object model) Initializes the TabGroup that contains description and usage.
void	setComponentName(String componentName) Sets the componentName
void	setDemoGroups(List<Group> demoGroups) Set the demoGroups used for demonstrating features of the component
void	setDescription(String description) Sets the description
void	setDetailsGroup(Group detailsGroup) Set the details group
void	setDocBookAnchor(String docBookAnchor) Set the docBookAnchor name for the component described by this view
void	setExampleSize(ComponentLibraryView.ExampleSize exampleSize)
void	setExhibit(ComponentExhibit exhibit) Set the ComponentExhibit for this demo
void	setHtmlCodeViewer(SyntaxHighlighter htmlCodeViewer)
void	setJavaFullClassPath(String javaFullClassPath) Get the java full class path
void	setLargeExampleFieldId(String largeExampleFieldId)
void	setRootDocBookAddress(String rootDocBookAddress) Set the docbook root address
void	setRootJavadocAddress(String rootJavadocAddress) Set the root address to the javadoc for Rice
void	setUsage(String usage) Set the usage text
void	setXmlFilePath(String xmlFilePath) Set the xml file path

Methods inherited from class org.kuali.rice.krad.uif.view.FormView

getAdditionalHiddenValues, getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, performFinalize, setAdditionalHiddenValues, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSide

Methods inherited from class org.kuali.rice.krad.uif.view.View

addViewTemplate, afterEvaluateExpression, clearIndex, clone, completeValidation, getActionFlags, getAdditionalCssFiles, getAdditionalHeadLinks, getAdditionalMetaTags, getAdditionalScriptFiles, getApplicationFooter, getApplicationHeader, getApplicationTitleText, getAuthorizer, getBreadcrumbItem, getBreadcrumbItems, getBreadcrumbOptions, getBreadcrumbs, getBuildFooter, getComponentTypeName, getContentContainerClassesAsString, getContentContainerCssClasses, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getDialogs, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getItems, getNamespaceCode, getNavigation, getNavigationBlockUI, getObjectPathToConcreteClassMapping, getPage, getPagesForPreprocessing, getParentLocation, getPathBasedBreadcrumbs, getPreloadPoolSize, getPreLoadScript, getPreModelContext, getPresentationController, getRefreshBlockUI, getRequestAuthorizationCacheClass, getSessionPolicy, getStateMapping, getStateObjectBindingPath, getSupportedComponents, getTheme, getTopGroup, getViewHelperService, getViewHelperServiceClass, getViewIndex, getViewName, getViewRequestParameters, getViewTemplates, getViewTypeName, initializeDialogLoadScript, initializeDialogReclocationScript, isApplyDirtyCheck, isDisableBrowserCache, isDisableNativeAutocomplete, isGrowlMessagingEnabled, isMergeWithPageItems, isPersistFormToSession, isSinglePageView, isStickyApplicationFooter, isStickyApplicationHeader, isStickyBreadcrumbs, isStickyFooter, isStickyHeader, isStickyTopGroup, isSupportsRequestOverrideOfReadOnlyFields, isTranslateCodesOnReadOnlyDisplay, isUnifiedHeader, isUseLibraryCssClasses, notifyCompleted, performApplyModel, setActionFlags, setAdditionalCssFiles, setAdditionalHeadLinks, setAdditionalMetaTags, setAdditionalScriptFiles, setApplicationFooter, setApplicationHeader, setApplicationTitleText, setApplyDirtyCheck, setAuthorizer, setAuthorizerClass, setBreadcrumbItem, setBreadcrumbOptions, setBreadcrumbs, setBuildFooter, setContentContainerCssClasses, setCurrentPageId, setDefaultBindingObjectPath, setDialogs, setDisableBrowserCache, setDisableNativeAutocomplete, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowls, setItems, setMergeWithPageItems, setNamespaceCode, setNavigation, setNavigationBlockUI, setNestedComponentId, setObjectPathToConcreteClassMapping, setPage, setParentLocation, setPathBasedBreadcrumbs, setPersistFormToSession, setPreloadPoolSize, setPreLoadScript, setPresentationController, setPresentationControllerClass, setRefreshBlockUI, setRequestAuthorizationCacheClass, setSessionPolicy, setSinglePageView, setStateMapping, setStateObjectBindingPath, setStickyApplicationFooter, setStickyApplicationHeader, setStickyBreadcrumbs, setStickyFooter, setStickyHeader, setStickyTopGroup, setSupportsRequestOverrideOfReadOnlyFields, setTheme, setTopGroup, setTranslateCodesOnReadOnlyDisplay, setUnifiedHeader, setUseLibraryCssClasses, setViewHelperService, setViewHelperServiceClass, setViewName, setViewRequestParameters, setViewTemplates, setViewTypeName, sortItems

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

getAdditionalTemplates, getDefaultItemPosition, getEnterKeyAction, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, isProcessRemoteFieldHolders, setDefaultItemPosition, setEnterKeyAction, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages

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

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

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

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

copy, dataDictionaryPostProcessing, getComponentCode, setComponentCode

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOmitFromFormPost, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

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

dataDictionaryPostProcessing, getComponentCode

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

checkMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

ComponentLibraryView

public ComponentLibraryView()

ComponentLibraryView constructor

Method Detail

performInitialization

public void performInitialization(Object model)

Initializes the TabGroup that contains description and usage. Processes ths source code marked with the ex: comment tags and adds them to the ComponentExhibit for this view. The following initialization is performed:

• If a single paged view, set items in page group and put the page in the items list
• If ViewSessionPolicy.enableTimeoutWarning is enabled add the session timeout dialogs to the views list of dialog groups

The following initialization is performed:

• Sorts the containers list of components
• Initializes the instructional field if necessary
• Initializes LayoutManager

The following updates are done here:

• Invoke performInitialize on component modifiers

Initializes the component

Where components can set defaults and setup other necessary state. The initialize method should only be called once per component lifecycle and is invoked within the initialize phase of the view lifecylce.

Specified by:

performInitialization in interface LifecycleElement

Overrides:

performInitialization in class View

Parameters:

model - - object instance containing the view data

See Also:

ComponentDefaultInitializeTask

getComponentName

public String getComponentName()

The name of the component (to be used by this page's header)

Returns:

componentName the name of the component being demoed

setComponentName

public void setComponentName(String componentName)

Sets the componentName

Parameters:

componentName -

getJavaFullClassPath

public String getJavaFullClassPath()

Set the java path to the class being used by this component TODO not yet used

Returns:

the java path to the class

setJavaFullClassPath

public void setJavaFullClassPath(String javaFullClassPath)

Get the java full class path

Parameters:

javaFullClassPath -

getXmlFilePath

public String getXmlFilePath()

The xml file path that contains the source being used for this demo, must start with / (relative path)

Returns:

the xml file path

setXmlFilePath

public void setXmlFilePath(String xmlFilePath)

Set the xml file path

Parameters:

xmlFilePath -

getDescription

public String getDescription()

The description of the component being demoed by this view

Returns:

the description

setDescription

public void setDescription(String description)

Sets the description

Parameters:

description -

getUsage

public String getUsage()

Gets the usage description and examples of how to use this component

Returns:

the usage text

setUsage

public void setUsage(String usage)

Set the usage text

Parameters:

usage -

getDetailsGroup

@ViewLifecycleRestriction(value="PRE_PROCESS")
public Group getDetailsGroup()

The details group that will contain the description, usage, and properties tabGroup

Returns:

the details group

setDetailsGroup

public void setDetailsGroup(Group detailsGroup)

Set the details group

Parameters:

detailsGroup -

getExhibit

@ViewLifecycleRestriction(value="PRE_PROCESS")
public ComponentExhibit getExhibit()

Gets the exhibit that will display the example, source code, and tabs to switch between examples

Returns:

the ComponentExhibit for this component demo view

setExhibit

public void setExhibit(ComponentExhibit exhibit)

Set the ComponentExhibit for this demo

Parameters:

exhibit -

getDemoGroups

@ViewLifecycleRestriction(value="PRE_PROCESS")
public List<Group> getDemoGroups()

List of groups that will demostrate the functionality fo the component being demonstrated, these groups are copied directly into componentExhibit - this is an ease of use property

Returns:

the demoGroups

setDemoGroups

public void setDemoGroups(List<Group> demoGroups)

Set the demoGroups used for demonstrating features of the component

Parameters:

demoGroups -

getRootJavadocAddress

public String getRootJavadocAddress()

The root address to the javadoc for Rice

Returns:

the javadoc root address

setRootJavadocAddress

public void setRootJavadocAddress(String rootJavadocAddress)

Set the root address to the javadoc for Rice

Parameters:

rootJavadocAddress -

getRootDocBookAddress

public String getRootDocBookAddress()

Get the root address to the docbook for KRAD

Returns:

KRAD's docbook address (url)

setRootDocBookAddress

public void setRootDocBookAddress(String rootDocBookAddress)

Set the docbook root address

Parameters:

rootDocBookAddress -

getDocBookAnchor

public String getDocBookAnchor()

The anchor in the docbook this component is described at (do not include #)

Returns:

the anchor name

setDocBookAnchor

public void setDocBookAnchor(String docBookAnchor)

Set the docBookAnchor name for the component described by this view

Parameters:

docBookAnchor -

getExampleSize

public ComponentLibraryView.ExampleSize getExampleSize()

setExampleSize

public void setExampleSize(ComponentLibraryView.ExampleSize exampleSize)

getLargeExampleFieldId

public String getLargeExampleFieldId()

setLargeExampleFieldId

public void setLargeExampleFieldId(String largeExampleFieldId)

getHtmlCodeViewer

@ViewLifecycleRestriction(value="PRE_PROCESS")
public SyntaxHighlighter getHtmlCodeViewer()

Html code viewer SyntaxHighlighter for displaying the html output by each example

Returns:

the SyntaxHighlighter

setHtmlCodeViewer

public void setHtmlCodeViewer(SyntaxHighlighter htmlCodeViewer)

See Also:

getHtmlCodeViewer()