org.hippoecm.hst.configuration.components
Class DelegatingHstComponentInfo

java.lang.Object
  org.hippoecm.hst.configuration.components.DelegatingHstComponentInfo

All Implemented Interfaces:

HstComponentInfo

public class DelegatingHstComponentInfo
extends Object
implements HstComponentInfo

DelegatingHstComponentInfo

Version:

$Id: DelegatingHstComponentInfo.java 30330 2011-09-20 16:10:30Z aschrijvers $

Constructor Summary

DelegatingHstComponentInfo(HstComponentInfo delegatee)
Deprecated. Use DelegatingHstComponentInfo(HstComponentInfo, String) instead.

DelegatingHstComponentInfo(HstComponentInfo delegatee, String componentName)
HST Component Info constructor with delegatee and component name arguments.

Method Summary

String	getComponentClassName()
String	getId() Returns the id for this component configuration.
String	getName() Return the name of this component configuration.
boolean	isStandalone()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegatingHstComponentInfo

public DelegatingHstComponentInfo(HstComponentInfo delegatee)

Deprecated. Use DelegatingHstComponentInfo(HstComponentInfo, String) instead.

Parameters:

delegatee -

DelegatingHstComponentInfo

public DelegatingHstComponentInfo(HstComponentInfo delegatee,
                                  String componentName)

HST Component Info constructor with delegatee and component name arguments. Normally, the component name can be full qualified class name which also can be retrieved from HstComponentWindow.

Parameters:

delegatee -

componentName -

Method Detail

getComponentClassName

public String getComponentClassName()

Specified by:

getComponentClassName in interface HstComponentInfo

Returns:

the fully-qualified class name of the class implementing the HstComponent interface

getId

public String getId()

Description copied from interface: HstComponentInfo

Returns the id for this component configuration. The id must be unique within the container HstComponentsConfiguration, or null if it is not needed to be directly accessed by the HstComponentsConfiguration through HstComponentsConfiguration.getComponentConfiguration(String). Every HstComponentConfiguration that can be referred to from within a HstSiteMapItem must have an id.

Specified by:

getId in interface HstComponentInfo

Returns:

the id of this component configuration or null if no id set

getName

public String getName()

Description copied from interface: HstComponentInfo

Return the name of this component configuration. It must be unique amongst siblings. The value returned by this method, is the value that must be used in rendering code (jsp/velocity/freemarker) to include the output of a child HstComponent instance.

Specified by:

getName in interface HstComponentInfo

Returns:

the logical name this component configuration, unique amongst its siblings

isStandalone

public boolean isStandalone()

Specified by:

isStandalone in interface HstComponentInfo

Returns:

true when this HstComponentConfiguration is configured to be rendered standalone in case of HstURL.COMPONENT_RENDERING_TYPE