HstComponentWindow (Hippo Site Toolkit 4.1.0 API)

All Known Implementing Classes:

MockHstComponentWindow
```
public interface HstComponentWindow
```
HST Component Window. This interface represents a fragment window of a page which is generated by a HstComponent.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addComponentExcpetion(HstComponentException e)` Adds a component exceptions during initialization or runtime.
`void`	`bindResponseState(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse parentResponse)` Creates and binds the `HstResponseState` to this `HstComponentWindow`.
`void`	`clearComponentExceptions()` Adds a component exceptions during initialization or runtime.
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`HstComponentWindow`	`getChildWindow(String name)` The child component window which can be accessed by the name.
`HstComponentWindow`	`getChildWindowByReferenceName(String referenceName)` The child component window which can be accessed by the reference name.
`Map<String,HstComponentWindow>`	`getChildWindowMap()` The child component windows contained in this component window.
`List<String>`	`getChildWindowNames()` The child component window names contained in this component window.
`HstComponent`	`getComponent()` The actual HstComponent instance.
`List<HstComponentException>`	`getComponentExceptions()` The component exceptions during initialization or runtime.
`HstComponentInfo`	`getComponentInfo()`
`HstComponentMetadata`	`getComponentMetadata()` The metadata of the actual HstComponent class.
`String`	`getComponentName()` The HstComponent name.
`String`	`getLocalParameter(String paramName)`
`String`	`getName()` The name of the component window.
`String`	`getNamedRenderer()`
`String`	`getNamedResourceServer()`
`String`	`getPageErrorHandlerClassName()`
`String`	`getParameter(String name)`
`HstComponentWindow`	`getParentWindow()` The parent component window containing this component window.
`String`	`getReferenceName()` The reference name of the component window.
`String`	`getReferenceNamespace()` The reference namespace of the component window.
`String`	`getRenderPath()` The dispatching path path to render this component window.
`HstResponseState`	`getResponseState()` Returns the response state of this component window.
`String`	`getServeResourcePath()` The dispatching path path to serve resource in this component window.
`boolean`	`hasComponentExceptions()` Whether it has component exceptions or not
`boolean`	`isVisible()` When this method returns `true, the HstComponentWindow is still part of the hierarchy of HstComponentWindows, but the doBeforeRender of the getComponent() and dispatched from the HstResponse will be skipped.`
`Object`	`removeAttribute(String name)`
`void`	`removeChildWindow(HstComponentWindow window)` removes the `window` from the child windows if exists and otherwise does nothing
`void`	`setAttribute(String name, Object value)`
`void`	`setVisible(boolean visible)`

- Method Detail
  - getName
```
String getName()
```
    The name of the component window.
    
    Returns:
    
    the name of the component window
  - getReferenceName
```
String getReferenceName()
```
    The reference name of the component window.
    
    Returns:
    
    the reference name of the component window
  - getReferenceNamespace
```
String getReferenceNamespace()
```
    The reference namespace of the component window.
    
    Returns:
    
    the reference namespace of the component window
  - getComponentName
```
String getComponentName()
```
    The HstComponent name. Normally the component name is fully qualified class name.
    
    Returns:
    
    the HstComponent name
  - getComponent
```
HstComponent getComponent()
```
    The actual HstComponent instance.
    
    Returns:
    
    the actual HstComponent instance
  - getComponentMetadata
```
HstComponentMetadata getComponentMetadata()
```
    The metadata of the actual HstComponent class.
    
    Returns:
    
    the metadata of the actual HstComponent class.
  - hasComponentExceptions
```
boolean hasComponentExceptions()
```
    Whether it has component exceptions or not
  - getComponentExceptions
```
List<HstComponentException> getComponentExceptions()
```
    The component exceptions during initialization or runtime.
    
    Returns:
    
    the possible component exception list
  - addComponentExcpetion
```
void addComponentExcpetion(HstComponentException e)
```
    Adds a component exceptions during initialization or runtime.
  - clearComponentExceptions
```
void clearComponentExceptions()
```
    Adds a component exceptions during initialization or runtime.
  - getRenderPath
```
String getRenderPath()
```
    The dispatching path path to render this component window.
    
    Returns:
    
    the dispatching path to render this component window
  - getNamedRenderer
```
String getNamedRenderer()
```
    Returns:
    
    the name of the renderer, when using named servlet. Returns null when getRenderPath() does not return null
    
    See Also:
    
    getRenderPath()
  - getServeResourcePath
```
String getServeResourcePath()
```
    The dispatching path path to serve resource in this component window.
    
    Returns:
    
    the dispatching path to serve resource in this component window
  - getNamedResourceServer
```
String getNamedResourceServer()
```
    Returns:
    
    the name of the resource server, when using named servlet. Returns null when getServeResourcePath() does not return null
    
    See Also:
    
    getServeResourcePath()
  - getParameter
```
String getParameter(String name)
```
    Parameters:
    
    name - the name of the parameter
    
    Returns:
    
    the configured parameter value for this name and null if not existing
    
    See Also:
    
    HstComponentConfiguration.getParameter(String)
  - getLocalParameter
```
String getLocalParameter(String paramName)
```
    Parameters:
    
    paramName - the name of the parameter
    
    Returns:
    
    the configured parameter value for this name and null if not existing
    
    See Also:
    
    HstComponentConfiguration.getLocalParameter(String)
  - getParentWindow
```
HstComponentWindow getParentWindow()
```
    The parent component window containing this component window.
    
    Returns:
    
    the component window containing this component window, or null when there is no parent window
  - getChildWindowMap
```
Map<String,HstComponentWindow> getChildWindowMap()
```
    The child component windows contained in this component window.
    
    Returns:
    
    the component windows contained in this component window
  - getChildWindowNames
```
List<String> getChildWindowNames()
```
    The child component window names contained in this component window.
    
    Returns:
    
    the component window names contained in this component window
  - getChildWindow
```
HstComponentWindow getChildWindow(String name)
```
    The child component window which can be accessed by the name.
    
    Parameters:
    
    name - the name of the child component window
    
    Returns:
    
    the child component window which has the referenceName
  - getChildWindowByReferenceName
```
HstComponentWindow getChildWindowByReferenceName(String referenceName)
```
    The child component window which can be accessed by the reference name.
    
    Parameters:
    
    referenceName - the referenceName of the child component window
    
    Returns:
    
    the child component window which has the referenceName
  - bindResponseState
```
void bindResponseState(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse parentResponse)
```
    Creates and binds the HstResponseState to this HstComponentWindow. After this method has been invoked, getResponseState() will return the bound HstResponseState. If bindResponseState(HttpServletRequest, HttpServletResponse) gets invoked for a second (or more) time, the method won't change any state and directly return
    
    Parameters:
    
    request - the HttpServletRequest request
    
    parentResponse - the HttpServletResponse response of the parent window or in case of the root window the http response of the container
  - getResponseState
```
HstResponseState getResponseState()
```
    Returns the response state of this component window.
  - getComponentInfo
```
HstComponentInfo getComponentInfo()
```
  - getAttribute
```
Object getAttribute(String name)
```
  - setAttribute
```
void setAttribute(String name,
                  Object value)
```
  - removeAttribute
```
Object removeAttribute(String name)
```
  - getAttributeNames
```
Enumeration<String> getAttributeNames()
```
  - getPageErrorHandlerClassName
```
String getPageErrorHandlerClassName()
```
    Returns:
    
    the fully classified className of the class implementing PageErrorHandler
  - isVisible
```
boolean isVisible()
```
    When this method returns true, the HstComponentWindow is still part of the hierarchy of HstComponentWindows, but the doBeforeRender of the getComponent() and dispatched from the HstResponse will be skipped.
    Returns: true when this HstComponentWindow should be visible, false otherwise
  setVisible void setVisible(boolean visible) Parameters: visible - sets whether this HstComponentWindow is visible or not. Setting this HstComponentWindow visibility to false, automatically sets all descendant HstComponentWindows visibility to false as well removeChildWindow void removeChildWindow(HstComponentWindow window) removes the window from the child windows if exists and otherwise does nothing Parameters: window - the window to remove

Interface HstComponentWindow

Method Summary

Method Detail

getName

getReferenceName

getReferenceNamespace

getComponentName

getComponent

getComponentMetadata

hasComponentExceptions

getComponentExceptions

addComponentExcpetion

clearComponentExceptions

getRenderPath

getNamedRenderer

getServeResourcePath

getNamedResourceServer

getParameter

getLocalParameter

getParentWindow

getChildWindowMap

getChildWindowNames

getChildWindow

getChildWindowByReferenceName

bindResponseState

getResponseState

getComponentInfo

getAttribute

setAttribute

removeAttribute

getAttributeNames

getPageErrorHandlerClassName

isVisible

setVisible

removeChildWindow