ImportTemplate (server-common-api)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UINamingContainer
    - - com.webmethods.caf.faces.component.logic.ImportTemplate

All Implemented Interfaces:

IDynamicComponent, IPostPageComponentPhaseListener, IScopedVariableComponent, Serializable, EventListener, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, PhaseListener, SystemEventListenerHolder
```
public class ImportTemplate
extends UINamingContainer
implements PhaseListener, IPostPageComponentPhaseListener, IScopedVariableComponent, IDynamicComponent
```
Imports view tree from some other .view file in the current webapp (or classpath) into the current view tree. To specify a view on the classpath, prefix the import value with "classpath:".

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`fInstanceNumber`
`static String`	`PARAM_ID_PREFIX`
`protected static String`	`VIEW_CHECKED_FORM_NESTING`
`protected static String`	`VIEW_LOADED`

Fields inherited from class javax.faces.component.UINamingContainer
COMPONENT_FAMILY, COMPONENT_TYPE, SEPARATOR_CHAR_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR

Constructor Summary

Constructors
Constructor and Description

ImportTemplate()

Constructors
Constructor and Description
`ImportTemplate()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`afterPhase(PhaseEvent event)`
`void`	`beforePhase(PhaseEvent event)`
`protected void`	`clearComponentBeans(UIComponent component)`
`void`	`encodeBegin(FacesContext context)`
`void`	`encodeChildren(FacesContext context)`
`void`	`encodeEnd(FacesContext context)`
`int`	`getFacetCount()`
`Iterator<UIComponent>`	`getFacetsAndChildren()`
`protected static ImportTemplate`	`getImportContainer(FacesContext context, UIComponent component)` Finds the import control containing the specified component.
`protected Object`	`getInternalPageBean()`
`protected String`	`getInternalPageBeanName()` Deprecated.
`protected String`	`getPageBeanName()`
`PhaseId`	`getPhaseId()`
`PhaseId`	`getPostPagePhaseId()`
`boolean`	`getRendersChildren()`
`Object`	`getScopedVariable()` Gets the scoped variable object
`String`	`getScopedVariableName()` Get the name of the scoped variable
`Object`	`getValue()`
`BaseViewBean`	`getViewPageBean()` Return a reference to the page bean backing this instance, for use cases where the bean needs to be referenced outside the context of the Import control.
`protected void`	`handleNestedForms()`
`protected void`	`importView(String viewId)` Imports the contents of the specified view as children of this control.
`void`	`populateInitialComponents()` Perform the initial programmatic manipulation of the component tree.
`void`	`postPageAfterPhase(PhaseEvent event)`
`void`	`postPageBeforePhase(PhaseEvent event)`
`void`	`processDecodes(FacesContext context)`
`void`	`processEvent(ComponentSystemEvent event)`
`void`	`processRestoreState(FacesContext context, Object state)`
`Object`	`processSaveState(FacesContext context)`
`void`	`processUpdates(FacesContext context)`
`void`	`processValidators(FacesContext context)`
`protected void`	`propagateParametersToPageBean(BaseViewBean pageBean)` Propagates non-content param values from this control to the appropriate properties of the specified page bean.
`protected void`	`reloadViewIfChanged()` If the viewId does not match what was previously loaded, reload the imported view
`void`	`restoreState(FacesContext context, Object state)`
`Object`	`saveState(FacesContext context)`
`void`	`setValue(Object value)`
`boolean`	`visitTree(VisitContext context, VisitCallback callback)`

Methods inherited from class javax.faces.component.UINamingContainer
createUniqueId, getFamily, getSeparatorChar

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.StateHolder
isTransient, setTransient

- Field Detail
  - VIEW_LOADED
```
protected static final String VIEW_LOADED
```
    See Also:
    
    Constant Field Values
  - VIEW_CHECKED_FORM_NESTING
```
protected static final String VIEW_CHECKED_FORM_NESTING
```
    See Also:
    
    Constant Field Values
  - PARAM_ID_PREFIX
```
public static final String PARAM_ID_PREFIX
```
    See Also:
    
    Constant Field Values
  - fInstanceNumber
```
protected Integer fInstanceNumber
```
- Constructor Detail
  - ImportTemplate
```
public ImportTemplate()
```
- Method Detail
  - restoreState
```
public void restoreState(FacesContext context,
                         Object state)
```
    Specified by:
    
    restoreState in interface StateHolder
    
    Overrides:
    
    restoreState in class UIComponentBase
  - saveState
```
public Object saveState(FacesContext context)
```
    Specified by:
    
    saveState in interface StateHolder
    
    Overrides:
    
    saveState in class UIComponentBase
  - afterPhase
```
public void afterPhase(PhaseEvent event)
```
    Specified by:
    
    afterPhase in interface PhaseListener
  - beforePhase
```
public void beforePhase(PhaseEvent event)
```
    Specified by:
    
    beforePhase in interface PhaseListener
  - reloadViewIfChanged
```
protected void reloadViewIfChanged()
```
    If the viewId does not match what was previously loaded, reload the imported view
  - getPhaseId
```
public PhaseId getPhaseId()
```
    Specified by:
    
    getPhaseId in interface PhaseListener
  - postPageBeforePhase
```
public void postPageBeforePhase(PhaseEvent event)
```
    Specified by:
    
    postPageBeforePhase in interface IPostPageComponentPhaseListener
  - postPageAfterPhase
```
public void postPageAfterPhase(PhaseEvent event)
```
    Specified by:
    
    postPageAfterPhase in interface IPostPageComponentPhaseListener
  - getPostPagePhaseId
```
public PhaseId getPostPagePhaseId()
```
    Specified by:
    
    getPostPagePhaseId in interface IPostPageComponentPhaseListener
  - getImportContainer
```
protected static ImportTemplate getImportContainer(FacesContext context,
                                                   UIComponent component)
```
    Finds the import control containing the specified component.
    
    Parameters:
    
    context - Current context.
    
    component - Component whose import control to find.
    
    Returns:
    
    Import control or null.
  - importView
```
protected void importView(String viewId)
```
    Imports the contents of the specified view as children of this control.
  - clearComponentBeans
```
protected void clearComponentBeans(UIComponent component)
```
  - propagateParametersToPageBean
```
protected void propagateParametersToPageBean(BaseViewBean pageBean)
```
    Propagates non-content param values from this control to the appropriate properties of the specified page bean.
  - getValue
```
public Object getValue()
```
  - setValue
```
public void setValue(Object value)
```
  - getViewPageBean
```
public BaseViewBean getViewPageBean()
```
    Return a reference to the page bean backing this instance, for use cases where the bean needs to be referenced outside the context of the Import control.
    
    Returns:
    
    backing bean for the imported view. May be null.
  - getInternalPageBean
```
protected Object getInternalPageBean()
```
  - getInternalPageBeanName
```
@Deprecated
protected String getInternalPageBeanName()
```
    Deprecated.
    
    Use getPageBeanName() instead
    
    Returns:
  - getPageBeanName
```
protected String getPageBeanName()
```
  - getRendersChildren
```
public boolean getRendersChildren()
```
    Overrides:
    
    getRendersChildren in class UIComponentBase
  - encodeBegin
```
public void encodeBegin(FacesContext context)
                 throws IOException
```
    Overrides:
    
    encodeBegin in class UIComponentBase
    
    Throws:
    
    IOException
  - encodeChildren
```
public void encodeChildren(FacesContext context)
                    throws IOException
```
    Overrides:
    
    encodeChildren in class UIComponentBase
    
    Throws:
    
    IOException
  - encodeEnd
```
public void encodeEnd(FacesContext context)
               throws IOException
```
    Overrides:
    
    encodeEnd in class UIComponentBase
    
    Throws:
    
    IOException
  - processDecodes
```
public void processDecodes(FacesContext context)
```
    Overrides:
    
    processDecodes in class UIComponentBase
  - processRestoreState
```
public void processRestoreState(FacesContext context,
                                Object state)
```
    Overrides:
    
    processRestoreState in class UIComponentBase
  - processSaveState
```
public Object processSaveState(FacesContext context)
```
    Overrides:
    
    processSaveState in class UIComponentBase
  - processUpdates
```
public void processUpdates(FacesContext context)
```
    Overrides:
    
    processUpdates in class UIComponentBase
  - processValidators
```
public void processValidators(FacesContext context)
```
    Overrides:
    
    processValidators in class UIComponentBase
  - visitTree
```
public boolean visitTree(VisitContext context,
                         VisitCallback callback)
```
    Overrides:
    
    visitTree in class UINamingContainer
  - getScopedVariableName
```
public String getScopedVariableName()
```
    Description copied from interface: IScopedVariableComponent
    
    Get the name of the scoped variable
    
    Specified by:
    
    getScopedVariableName in interface IScopedVariableComponent
    
    Returns:
  - getScopedVariable
```
public Object getScopedVariable()
```
    Description copied from interface: IScopedVariableComponent
    
    Gets the scoped variable object
    
    Specified by:
    
    getScopedVariable in interface IScopedVariableComponent
    
    Returns:
    
    variable object
  - processEvent
```
public void processEvent(ComponentSystemEvent event)
                  throws AbortProcessingException
```
    Specified by:
    
    processEvent in interface ComponentSystemEventListener
    
    Overrides:
    
    processEvent in class UIComponent
    
    Throws:
    
    AbortProcessingException
  - handleNestedForms
```
protected void handleNestedForms()
```
  - populateInitialComponents
```
public void populateInitialComponents()
```
    Description copied from interface: IDynamicComponent
    
    Perform the initial programmatic manipulation of the component tree.
    
    Specified by:
    
    populateInitialComponents in interface IDynamicComponent
  - getFacetCount
```
public int getFacetCount()
```
    Overrides:
    
    getFacetCount in class UIComponentBase
  - getFacetsAndChildren
```
public Iterator<UIComponent> getFacetsAndChildren()
```
    Overrides:
    
    getFacetsAndChildren in class UIComponentBase

Class ImportTemplate

Field Summary

Fields inherited from class javax.faces.component.UINamingContainer

Fields inherited from class javax.faces.component.UIComponent

Fields inherited from interface javax.faces.component.NamingContainer

Constructor Summary

Method Summary

Methods inherited from class javax.faces.component.UINamingContainer

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Methods inherited from interface javax.faces.component.StateHolder

Field Detail

VIEW_LOADED

VIEW_CHECKED_FORM_NESTING

PARAM_ID_PREFIX

fInstanceNumber

Constructor Detail

ImportTemplate

Method Detail

restoreState

saveState

afterPhase

beforePhase

reloadViewIfChanged

getPhaseId

postPageBeforePhase

postPageAfterPhase

getPostPagePhaseId

getImportContainer

importView

clearComponentBeans

propagateParametersToPageBean

getValue

setValue

getViewPageBean

getInternalPageBean

getInternalPageBeanName

getPageBeanName

getRendersChildren

encodeBegin

encodeChildren

encodeEnd

processDecodes

processRestoreState

processSaveState

processUpdates

processValidators

visitTree

getScopedVariableName

getScopedVariable

processEvent

handleNestedForms

populateInitialComponents

getFacetCount

getFacetsAndChildren