Package org.kuali.rice.krad.uif.view
Class IframeView
- All Implemented Interfaces:
Serializable,Cloneable,Copyable,DictionaryBean,UifDictionaryBean,Component,Ordered,ScriptEventSupport,Container,LifecycleElement,Helpable,org.springframework.core.Ordered
IframeView is a View component that shows another website's content in an iframe.
This View will always have one page itself and will always contain an iframe component. The location property allows ease of setting the url for the iframe. If the site being shown in the iframe is a KRAD View itself, the default bean for this class will attempt to pass a url parameter notifying the View that it is being shown in an iframe; this can be used in SpringEL to invoke special logic (such as not rendering some components, like the app header)
- Author:
- Kuali Rice Team (rice.collab@kuali.org)
- See Also:
-
Field Summary
Fields inherited from class org.kuali.rice.krad.uif.view.View
applyDirtyCheck, viewIndexFields inherited from class org.kuali.rice.krad.uif.component.ComponentBase
templateOptionsFields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase
componentCodeFields inherited from interface org.kuali.rice.krad.uif.component.Ordered
INITIAL_ORDER_VALUEFields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetHref()The iframe component to be used as the content of this view, nothing needs to be set on this directly if using the default bean for this ViewGet the url object representing the locationvoidperformApplyModel(Object model, LifecycleElement parent) Evaluates expressions that may appear in location properties and sets the source of iframe automatically The following updates are done here: Invoke expression evaluation on view theme Invoke theme to configure defaultsvoidperformInitialization(Object model) Forces this view to be only one page, and sets the iframe as one of its items The following initialization is performed: If a single paged view, set items in page group and put the page in the items list IfViewSessionPolicy.enableTimeoutWarningis 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 componentvoidvoidvoidsetLocation(UrlInfo location) Methods inherited from class org.kuali.rice.krad.uif.view.FormView
getAdditionalHiddenValues, getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, performFinalize, setAdditionalHiddenValues, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSideMethods 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, 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, sortItemsMethods 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, setValidationMessagesMethods 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, skipLifecycleMethods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressionsMethods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase
copy, dataDictionaryPostProcessing, getComponentCode, setComponentCodeMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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, setWrapperStyleMethods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean
dataDictionaryPostProcessing, getComponentCodeMethods 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, skipLifecycleMethods 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, setOnUnloadScriptMethods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean
getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions
-
Constructor Details
-
IframeView
public IframeView()
-
-
Method Details
-
performInitialization
Forces this view to be only one page, and sets the iframe as one of its items 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.enableTimeoutWarningis enabled add the session timeout dialogs to the views list of dialog groups
- Sorts the containers list of components
- Initializes the instructional field if necessary
- Initializes LayoutManager
- Invoke performInitialize on component modifiers
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:
performInitializationin interfaceLifecycleElement- Overrides:
performInitializationin classView- Parameters:
model- - object instance containing the view data- See Also:
-
performApplyModel
Evaluates expressions that may appear in location properties and sets the source of iframe automatically The following updates are done here:- Invoke expression evaluation on view theme
- Invoke theme to configure defaults
- Specified by:
performApplyModelin interfaceLifecycleElement- Overrides:
performApplyModelin classView- Parameters:
model- - Top level object containing the data (could be the form or a top level business object, dto)parent- parent lifecycle element
-
getLocation
Get the url object representing the location- Returns:
- the url location object
-
setLocation
- See Also:
-
getHref
- See Also:
-
setHref
- See Also:
-
getIframe
The iframe component to be used as the content of this view, nothing needs to be set on this directly if using the default bean for this View- Returns:
- the iframe component
-
setIframe
- See Also:
-