public interface HstComponentWindowFilter
Interface to implement as a developer to add custom HstComponentWindow
filtering for some requestContext.
You can decorate the window
in doFilter(HstRequestContext, HstComponentConfiguration, HstComponentWindow)
and return
a decorated / enhanced version, or, return null
when the window
should be completely disabled. The root HstComponentWindow
is not decorated through this doFilter(HstRequestContext, HstComponentConfiguration, HstComponentWindow)
method.
The doFilter(HstRequestContext, HstComponentConfiguration, HstComponentWindow)
is called on every non root HstComponentWindow
after
all HstComponentWindow
s for the current HstRequestContext
have been created by HstComponentWindowFactory.create(HstContainerConfig, HstRequestContext, HstComponentConfiguration, HstComponentFactory, HstComponentWindow)
When you want a window
to be invisible (doBeforeRender and render skipped, but still processed as window in an AggregationValve)
you typically implement this interface and in doFilter(HstRequestContext, HstComponentConfiguration, HstComponentWindow)
return
the window
after calling HstComponentWindow#setVisible(false)
Modifier and Type | Method and Description |
---|---|
HstComponentWindow |
doFilter(HstRequestContext requestContext,
HstComponentConfiguration compConfig,
HstComponentWindow window) |
HstComponentWindow doFilter(HstRequestContext requestContext, HstComponentConfiguration compConfig, HstComponentWindow window) throws HstComponentException
requestContext
- compConfig
- the HstComponentConfiguration
from which window
is createdwindow
- The HstComponentWindow
to decorateHstComponentWindow
instance which can be an enhanced or decorated version of the window
. If the window
should be entirely disabled/skipped, null
should be returnedHstComponentException
Copyright © 2008-2013 Hippo B.V. (http://www.onehippo.com). All Rights Reserved.