public interface HstComponentWindow
Modifier and Type | Method and Description |
---|---|
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() |
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 |
Object |
removeAttribute(String name) |
void |
setAttribute(String name,
Object value) |
void |
setVisible(boolean visible) |
String getName()
String getReferenceName()
String getReferenceNamespace()
String getComponentName()
HstComponent getComponent()
HstComponentMetadata getComponentMetadata()
boolean hasComponentExceptions()
List<HstComponentException> getComponentExceptions()
void addComponentExcpetion(HstComponentException e)
void clearComponentExceptions()
String getRenderPath()
String getNamedRenderer()
null
when getRenderPath()
does not return null
getRenderPath()
String getServeResourcePath()
String getNamedResourceServer()
null
when getServeResourcePath()
does not return null
getServeResourcePath()
String getParameter(String name)
name
- the name of the parametername
and null
if not existingorg.hippoecm.hst.configuration.components.HstComponentConfiguration#getParameter(String)}
String getLocalParameter(String paramName)
paramName
- the name of the parametername
and null
if not existingorg.hippoecm.hst.configuration.components.HstComponentConfiguration#getLocalParameter(String)}
HstComponentWindow getParentWindow()
null
when there is no parent windowMap<String,HstComponentWindow> getChildWindowMap()
List<String> getChildWindowNames()
HstComponentWindow getChildWindow(String name)
name
- the name of the child component windowHstComponentWindow getChildWindowByReferenceName(String referenceName)
referenceName
- the referenceName of the child component windowHstResponseState getResponseState()
HstComponentInfo getComponentInfo()
Enumeration<String> getAttributeNames()
String getPageErrorHandlerClassName()
PageErrorHandler
boolean isVisible()
true, the HstComponentWindow
is still part of the hierarchy of HstComponentWindow
s, but
the doBeforeRender of the getComponent()
and dispatched from the HstResponse
will be skipped.
true
when this HstComponentWindow
should be visible, false
otherwisevoid setVisible(boolean visible)
visible
- sets whether this HstComponentWindow
is visible or not. Setting this HstComponentWindow
visibility to false, automatically sets all descendant HstComponentWindow
s visibility to false as wellCopyright © 2008-2013 Hippo B.V. (http://www.onehippo.com). All Rights Reserved.