org.hippoecm.hst.core.container

Interface HstComponentWindowFactory

public interface HstComponentWindowFactory

The factory interface which is responsible for creating HstComponentWindow instances.

Version:

$Id$

Method Summary

Modifier and Type	Method and Description
HstComponentWindow	create(HstContainerConfig requestContainerConfig, HstRequestContext requestContext, HstComponentConfiguration compConfig, HstComponentFactory compFactory) Creates a HstComponentWindow instance.
HstComponentWindow	create(HstContainerConfig requestContainerConfig, HstRequestContext requestContext, HstComponentConfiguration compConfig, HstComponentFactory compFactory, HstComponentWindow parentWindow) Creates a HstComponentWindow instance as a child window of the parentWindow.
String	getReferenceNameSeparator() Returns the reference namespace separator.
void	setReferenceNameSeparator(String referenceNameSeparator) Sets the reference namespace separator.

Method Detail

setReferenceNameSeparator

void setReferenceNameSeparator(String referenceNameSeparator)

Sets the reference namespace separator. If this is set to '_' and the namespace components are 'a', 'b' and 'c', then the reference namespace should be 'a_b_c'.

Parameters:

referenceNameSeparator -

getReferenceNameSeparator

String getReferenceNameSeparator()

Returns the reference namespace separator.

create

HstComponentWindow create(HstContainerConfig requestContainerConfig,
                          HstRequestContext requestContext,
                          HstComponentConfiguration compConfig,
                          HstComponentFactory compFactory)
                   throws HstComponentException

Creates a HstComponentWindow instance.

Parameters:

requestContainerConfig - the container configuration

requestContext - the HstRequestContext instance for the currrent request

compConfig - the component configuration

compFactory - the HstComponentFactory instance for this container

Returns:

an instance of HstComponentWindow

Throws:

HstComponentException

create

HstComponentWindow create(HstContainerConfig requestContainerConfig,
                          HstRequestContext requestContext,
                          HstComponentConfiguration compConfig,
                          HstComponentFactory compFactory,
                          HstComponentWindow parentWindow)
                   throws HstComponentException

Creates a HstComponentWindow instance as a child window of the parentWindow.

Parameters:

requestContainerConfig - the container configuration

requestContext - the HstRequestContext instance for the currrent request

compConfig - the component configuration

compFactory - the HstComponentFactory instance for this container

parentWindow - the parent window

Returns:

an instance of HstComponentWindow

Throws:

HstComponentException