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, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Container, 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

viewIndex

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
protected <T> void	copyProperties(T component) Copies the properties over for the copy method
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
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(View view, 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	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

getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSide

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

assignComponentId, assignComponentIds, assignPageIds, completeValidation, getActionFlags, getAdditionalCssFiles, getAdditionalScriptFiles, getApplicationFooter, getApplicationHeader, getAuthorizer, getBreadcrumbItem, getBreadcrumbOptions, getBreadcrumbs, getComponentsForLifecycle, getComponentTypeName, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getDialogs, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getIdSequence, getItems, getNamespaceCode, getNavigation, getNavigationBlockUI, getNextId, getObjectPathToConcreteClassMapping, getPage, getParentLocation, getPathBasedBreadcrumbs, getPreLoadScript, getPresentationController, getRefreshBlockUI, getSessionPolicy, getStateMapping, getStateObjectBindingPath, getSupportedComponents, getTheme, getTopGroup, getViewHelperService, getViewHelperServiceClass, getViewIndex, getViewMenuGroupName, getViewMenuLink, getViewName, getViewRequestParameters, getViewStatus, getViewTemplates, getViewTypeName, index, isApplyDirtyCheck, isDisableBrowserCache, isDisableNativeAutocomplete, isFinal, isGrowlMessagingEnabled, isInitialized, isMergeWithPageItems, isPersistFormToSession, isSinglePageView, isStickyApplicationFooter, isStickyApplicationHeader, isStickyBreadcrumbs, isStickyFooter, isStickyHeader, isStickyTopGroup, isSupportsRequestOverrideOfReadOnlyFields, isTranslateCodesOnReadOnlyDisplay, isUnifiedHeader, isUseLibraryCssClasses, performApplyModel, performFinalize, setActionFlags, setAdditionalCssFiles, setAdditionalScriptFiles, setApplicationFooter, setApplicationHeader, setApplyDirtyCheck, setAuthorizer, setAuthorizerClass, setBreadcrumbItem, setBreadcrumbOptions, setBreadcrumbs, setCurrentPageId, setDefaultBindingObjectPath, setDialogs, setDisableBrowserCache, setDisableNativeAutocomplete, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowls, setIdSequence, setItems, setMergeWithPageItems, setNamespaceCode, setNavigation, setNavigationBlockUI, setObjectPathToConcreteClassMapping, setPage, setParentLocation, setPathBasedBreadcrumbs, setPersistFormToSession, setPreLoadScript, setPresentationController, setPresentationControllerClass, setRefreshBlockUI, setSessionPolicy, setSinglePageView, setStateMapping, setStateObjectBindingPath, setStickyApplicationFooter, setStickyApplicationHeader, setStickyBreadcrumbs, setStickyFooter, setStickyHeader, setStickyTopGroup, setSupportsRequestOverrideOfReadOnlyFields, setTheme, setTopGroup, setTranslateCodesOnReadOnlyDisplay, setUnifiedHeader, setUseLibraryCssClasses, setViewHelperService, setViewHelperServiceClass, setViewMenuGroupName, setViewMenuLink, setViewName, setViewRequestParameters, setViewStatus, setViewTemplates, setViewTypeName, sortItems

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

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

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

addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getComponentSecurityClass, 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, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, 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, setWidth

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

getComponentCode, setComponentCode

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

addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setBaseId, setCellCssClasses, setCellStyle, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, 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, setWidth

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

getComponentCode

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

ComponentLibraryView

public ComponentLibraryView()

ComponentLibraryView constructor

Method Detail

performInitialization

public void performInitialization(View view,
                         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.

Specified by:

performInitialization in interface Component

Overrides:

performInitialization in class View

Parameters:

view - - view instance in which the component belongs

model - - object instance containing the view data

See Also:

Component.performInitialization(org.kuali.rice.krad.uif.view.View, Object)

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

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

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

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)

copyProperties

protected <T> void copyProperties(T component)

Description copied from class: ComponentBase

Copies the properties over for the copy method

Overrides:

copyProperties in class FormView

Parameters:

component - base bean

See Also:

ComponentBase.copy()