public interface ComponentConfiguration extends ParameterConfiguration
ComponentConfiguration
provides some configuration information to a component.getParameter, getParameterNames, getParameters
String getLocalParameter(String name, ResolvedSiteMapItem hstResolvedSiteMapItem)
Map<String,String> getLocalParameters(ResolvedSiteMapItem hstResolvedSiteMapItem)
hstResolvedSiteMapItem
- List<DynamicParameter> getDynamicComponentParameters()
Optional<DynamicParameter> getDynamicComponentParameter(String name)
Map<String,String> getRawParameters()
ParameterConfiguration.getParameters(ResolvedSiteMapItem)
. Normally, you use ParameterConfiguration.getParameters(ResolvedSiteMapItem)
, unless you want to access
parameter values without having their property placeholders (like ${1}) substituded by the current request context. In other words, the parameter values
exactly the way they are in the HstComponentConfiguration
Map<String,String> getRawLocalParameters()
getLocalParameters(ResolvedSiteMapItem)
. Normally, you use getLocalParameters(ResolvedSiteMapItem)
, unless you want to access
parameter values without having their property placeholders (like ${1}) substituded by the current request context. In other words, the parameter values
exactly the way they are in the HstComponentConfiguration
. Note that this method does not return inherited parameters, but only its local (directly)
configured onesString getRenderPath()
String getServeResourcePath()
HstComponent
String getCanonicalPath()
ComponentConfiguration
's
can share the same canonical path: When a component is added by a reference, this method will return the same canonical path as the
direct (not referenced) component.String getCanonicalIdentifier()
ComponentConfiguration
's can share the same
canonical identifier due to inheritance. Also, multiple subsites can share the same backing configuration, and thus share the same canonical identifiersString getXType()
null
if the component does not have oneString getCType()
null
if the component does not have oneHstComponentConfiguration.Type getComponentType()
HstComponentConfiguration.Type
of this ComponentConfiguration
String getParametersInfoClassName()
ParametersInfo
for a component,
and otherwise null
.Copyright © 2008–2021 Hippo B.V. (http://www.onehippo.com). All rights reserved.