Interface HstComponentWindowFilter
-
public interface HstComponentWindowFilter
Interface to implement as a developer to add custom
HstComponentWindow
filtering for some requestContext. You can decorate thewindow
indoFilter(HstRequestContext, HstComponentConfiguration, HstComponentWindow)
and return a decorated / enhanced version, or, returnnull
when thewindow
should be completely removed. The rootHstComponentWindow
is not decorated through thisdoFilter(HstRequestContext, HstComponentConfiguration, HstComponentWindow)
method.The
When you want adoFilter(HstRequestContext, HstComponentConfiguration, HstComponentWindow)
is called on every non rootHstComponentWindow
after allHstComponentWindow
s for the currentHstRequestContext
have been created byHstComponentWindowFactory.create(HstContainerConfig, HstRequestContext, HstComponentConfiguration, HstComponentFactory, HstComponentWindow)
window
to be invisible (doBeforeRender and render skipped, but still processed as window in an AggregationValve) you typically implement this interface and indoFilter(HstRequestContext, HstComponentConfiguration, HstComponentWindow)
return thewindow
after invokingHstComponentWindow.setVisible(boolean)
with argumenttrue
, thus HstComponentWindow#setVisible(true)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HstComponentWindow
doFilter(HstRequestContext requestContext, HstComponentConfiguration compConfig, HstComponentWindow window)
-
-
-
Method Detail
-
doFilter
HstComponentWindow doFilter(HstRequestContext requestContext, HstComponentConfiguration compConfig, HstComponentWindow window) throws HstComponentException
- Parameters:
requestContext
-compConfig
- theHstComponentConfiguration
from whichwindow
is createdwindow
- TheHstComponentWindow
to decorate- Returns:
- A
HstComponentWindow
instance which can be an enhanced or decorated version of thewindow
. If thewindow
should be entirely disabled/skipped,null
should be returned - Throws:
HstComponentException
-
-