org.hippoecm.hst.core.container
Interface HstComponentWindow

All Known Implementing Classes:

HstComponentWindowImpl, MockHstComponentWindow

public interface HstComponentWindow

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

Version:

$Id: HstComponentWindow.java 28734 2011-06-28 20:55:01Z wko $

Method Summary

void	addComponentExcpetion(HstComponentException e) Adds a component exceptions during initialization or runtime.
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()
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
Object	removeAttribute(String name)
void	setAttribute(String name, Object value)

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

hasComponentExceptions

boolean hasComponentExceptions()

Whether it has component exceptions or not

Returns:

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:

org.hippoecm.hst.configuration.components.HstComponentConfiguration#getParameter(String)}

getLocalParameter

String getLocalParameter(String paramName)

Parameters:

name - the name of the parameter

Returns:

the configured parameter value for this name and null if not existing

See Also:

org.hippoecm.hst.configuration.components.HstComponentConfiguration#getLocalParameter(String)}

getParentWindow

HstComponentWindow getParentWindow()

The parent component window containing this component window.

Returns:

the component window containing this component 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

getResponseState

HstResponseState getResponseState()

Returns the response state of this component window

getComponentInfo

HstComponentInfo getComponentInfo()

Returns:

getAttribute

Object getAttribute(String name)

Parameters:

name -

Returns:

setAttribute

void setAttribute(String name,
                  Object value)

Parameters:

name -

value -

removeAttribute

Object removeAttribute(String name)

Parameters:

name -

Returns:

getAttributeNames

Enumeration<String> getAttributeNames()

Returns:

getPageErrorHandlerClassName

String getPageErrorHandlerClassName()

Returns:

the fully classified className of the class implementing PageErrorHandler