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

Class ComponentExhibit

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.element.ContentElementBase

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

All Implemented Interfaces:

Serializable, Cloneable, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, ContentElement, org.springframework.core.Ordered

public class ComponentExhibit
extends ContentElementBase

The ComponentExhibit component is used to display demostrations of various components along with their source code and documentation

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

Constructors

Constructor and Description
ComponentExhibit()

Method Summary

Modifier and Type	Method and Description
protected <T> void	copyProperties(T component) Copies the properties over for the copy method
List<String>	getAdditionalDemoSourceCode1()
List<String>	getAdditionalDemoSourceCode2()
SyntaxHighlighter	getAdditionalSourceCodeViewer1()
SyntaxHighlighter	getAdditionalSourceCodeViewer2()
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
List<Group>	getDemoGroups() Get the demoGroups demonstrating the component's features
List<String>	getDemoSourceCode() Get the xml sourceCode for the demoGroups' features being demonstrated.
FieldGroup	getDocLinkFields() Get the FieldGroup that contains links to the documentation TODO not yet used
SyntaxHighlighter	getSourceCodeViewer() The SyntaxHighlighter component being used by the exhibit to show the demoSourceCode
TabGroup	getTabGroup() Get the tabGroup used to display the demoGroups
void	performInitialization(View view, Object model) Setup the tabGroup with the demoGroups and setup the sourceCodeViewer
void	setAdditionalDemoSourceCode1(List<String> additionalDemoSourceCode1)
void	setAdditionalDemoSourceCode2(List<String> additionalDemoSourceCode2)
void	setAdditionalSourceCodeViewer1(SyntaxHighlighter additionalSourceCodeViewer1)
void	setAdditionalSourceCodeViewer2(SyntaxHighlighter additionalSourceCodeViewer2)
void	setDemoGroups(List<Group> demoGroups) Sets the demoGroups.
void	setDemoSourceCode(List<String> demoSourceCode) Sets the demoSourceCode.
void	setDocLinkFields(FieldGroup docLinkFields) Sets the docLinkFields fieldGroup
void	setSourceCodeViewer(SyntaxHighlighter sourceCodeViewer) Set the SyntaxHighlighter sourceCodeViewer component
void	setTabGroup(TabGroup tabGroup) Set the tabGroup used to display the demoGroups

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

getComponentTypeName

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

addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, completeValidation, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellStyleClassesAsString, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, 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, performApplyModel, performFinalize, 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, getNamespaceCode, setComponentCode, setNamespaceCode

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, completeValidation, copy, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getBaseId, getCellCssClasses, getCellStyle, getCellWidth, getColSpan, getComponentModifiers, getComponentPrototypes, 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, performApplyModel, performFinalize, 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, getNamespaceCode

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

ComponentExhibit

public ComponentExhibit()

Method Detail

performInitialization

public void performInitialization(View view,
                                  Object model)

Setup the tabGroup with the demoGroups and setup the sourceCodeViewer

Specified by:

performInitialization in interface Component

Overrides:

performInitialization in class ComponentBase

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)

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()

getDemoGroups

public List<Group> getDemoGroups()

Get the demoGroups demonstrating the component's features

Returns:

the demoGroups

setDemoGroups

public void setDemoGroups(List<Group> demoGroups)

Sets the demoGroups. This SHOULD NOT be set by xml - use ComponentLibraryView's setDemoGroups.

Parameters:

demoGroups -

getDemoSourceCode

public List<String> getDemoSourceCode()

Get the xml sourceCode for the demoGroups' features being demonstrated.

Returns:

the sourceCode

setDemoSourceCode

public void setDemoSourceCode(List<String> demoSourceCode)

Sets the demoSourceCode. This SHOULD NOT be set by xml - ComponentLibraryView will automatically read the source.

Parameters:

demoSourceCode -

getSourceCodeViewer

public SyntaxHighlighter getSourceCodeViewer()

The SyntaxHighlighter component being used by the exhibit to show the demoSourceCode

Returns:

the SyntaxHighlighter component

setSourceCodeViewer

public void setSourceCodeViewer(SyntaxHighlighter sourceCodeViewer)

Set the SyntaxHighlighter sourceCodeViewer component

Parameters:

sourceCodeViewer -

getDocLinkFields

public FieldGroup getDocLinkFields()

Get the FieldGroup that contains links to the documentation TODO not yet used

Returns:

the FieldGroup that contains documentation links

setDocLinkFields

public void setDocLinkFields(FieldGroup docLinkFields)

Sets the docLinkFields fieldGroup

Parameters:

docLinkFields -

getTabGroup

public TabGroup getTabGroup()

Get the tabGroup used to display the demoGroups

Returns:

the tabGroup used to display the demoGroups

setTabGroup

public void setTabGroup(TabGroup tabGroup)

Set the tabGroup used to display the demoGroups

Parameters:

tabGroup -

getAdditionalDemoSourceCode1

public List<String> getAdditionalDemoSourceCode1()

setAdditionalDemoSourceCode1

public void setAdditionalDemoSourceCode1(List<String> additionalDemoSourceCode1)

getAdditionalDemoSourceCode2

public List<String> getAdditionalDemoSourceCode2()

setAdditionalDemoSourceCode2

public void setAdditionalDemoSourceCode2(List<String> additionalDemoSourceCode2)

getAdditionalSourceCodeViewer1

public SyntaxHighlighter getAdditionalSourceCodeViewer1()

setAdditionalSourceCodeViewer1

public void setAdditionalSourceCodeViewer1(SyntaxHighlighter additionalSourceCodeViewer1)

getAdditionalSourceCodeViewer2

public SyntaxHighlighter getAdditionalSourceCodeViewer2()

setAdditionalSourceCodeViewer2

public void setAdditionalSourceCodeViewer2(SyntaxHighlighter additionalSourceCodeViewer2)

copyProperties

protected <T> void copyProperties(T component)

Description copied from class: ComponentBase

Copies the properties over for the copy method

Overrides:

copyProperties in class ComponentBase

Parameters:

component - base bean

See Also:

ComponentBase.copy()