com.sapportals.wcm.rendering.property
Class PropertyRendererFactory

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.property_api.jar]

com.sapportals.wcm.rendering.property.PropertyRendererFactory

All Implemented Interfaces:

IFactoryInfoProvider

public final class PropertyRendererFactory

implements IFactoryInfoProvider

Inner classes inherited from class com.sapportals.wcm.rendering.base.IFactoryInfoProvider

IFactoryInfoProvider.MappingInformation

Field Summary

static java.lang.String	KEY_ALIAS
static java.lang.String	KEY_CLASS
static java.lang.String	LINE_BREAK constant used to separate debugging information

Method Summary

void	configEvent(com.sapportals.config.event.ConfigEvent parm1) is called by the configuration, if configuration for the factory was changed.
java.lang.String	getConfigListenerId() Gets the configListenerId attribute of the PropertyRendererFactory object
java.lang.String	getFactoryName()
static PropertyRendererFactory	getInstance() Gets the instance attribute of the PropertyRendererFactory class.
long	getLastReloadTime()
java.util.List	getMappings(java.util.Locale locale)
java.lang.Object	getRenderer(IMetaName name, PropertyDisplayMode mode)
Status	getStatus()

Field Detail

LINE_BREAK

public static final java.lang.String LINE_BREAK

constant used to separate debugging information

KEY_ALIAS

public static final java.lang.String KEY_ALIAS

KEY_CLASS

public static final java.lang.String KEY_CLASS

Method Detail

getInstance

public static PropertyRendererFactory getInstance()

Gets the instance attribute of the PropertyRendererFactory class.

Returns:

the only available instance of this factory in the VM.

getConfigListenerId

public java.lang.String getConfigListenerId()

Gets the configListenerId attribute of the PropertyRendererFactory object

Returns:

The configListenerId value

configEvent

public void configEvent(com.sapportals.config.event.ConfigEvent parm1)

is called by the configuration, if configuration for the factory was changed. If the event is of type ConfigEvent.CONFIGURABLE_LOADED or ConfigEvent.CONFIGMANAGER_TERMINATED , the factory deletes all its entries and reloads the configuration, creating all propertyRenderers anew.

Parameters:

parm1 - the event raised by the configuration

getMappings

public java.util.List getMappings(java.util.Locale locale)

Specified by:

getMappings in interface IFactoryInfoProvider

Following copied from interface: com.sapportals.wcm.rendering.base.IFactoryInfoProvider

Parameters:

locale - defines the language to use, if the factory offers translated information, must not be null

Returns:

a list that must only contain IFactoryInfoProvider.MappingInformation, must not be null

getStatus

public Status getStatus()

Specified by:

getStatus in interface IFactoryInfoProvider

Following copied from interface: com.sapportals.wcm.rendering.base.IFactoryInfoProvider

Returns:

the aggregated status of the factory. If, e.g., there have been errors creating a class defined in the config, the factory should return Status.ERROR

getRenderer

public java.lang.Object getRenderer(IMetaName name,
                                    PropertyDisplayMode mode)

getFactoryName

public java.lang.String getFactoryName()

Specified by:

getFactoryName in interface IFactoryInfoProvider

Following copied from interface: com.sapportals.wcm.rendering.base.IFactoryInfoProvider

Returns:

a human-readable name of the factory, must not be null

getLastReloadTime

public long getLastReloadTime()

Specified by:

getLastReloadTime in interface IFactoryInfoProvider

Following copied from interface: com.sapportals.wcm.rendering.base.IFactoryInfoProvider

Returns:

the time of the last reload of the config by this factory. Expects a format such as returned by System.currentTimeMillis(). An implementing class might also return -1 to indicate, that no information is available.