com.sapportals.wcm.service.propertystructure

Class AbstractGroupRenderer

java.lang.Object
  com.sapportals.wcm.service.propertystructure.AbstractGroupRenderer

All Implemented Interfaces:

IAccessibilityGroupRenderer, IExtendedGroupRenderer, IStructuredGroupRenderer

public abstract class AbstractGroupRenderer
extends Object
implements IStructuredGroupRenderer, IAccessibilityGroupRenderer, IExtendedGroupRenderer

Abstract group renderer that should be extended by every property structure group renderer.

Constructor Summary

AbstractGroupRenderer()

Method Summary

String[]	getConfigParameters() Returns configuration parameters of the group renderer.
IStructuredGroup	getGroup() Returns the group object.
IPropertyMap	getProperties(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) Gets the properties with their entered values after the response has been returned.
boolean	is508Required() Returns a boolean value according to 508 required mode
String[]	processEvent(com.sapportals.htmlb.event.Event event, IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) Validates the group content
abstract com.sapportals.htmlb.Component	render(IMetaContext metaContext) Renders the structured group.
void	save(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) Saves the content of the structured group.
void	set508Required(boolean active) Sets true if the 508 mode is enabled false otherwise
void	setConfigParameters(String[] configParameters) Sets the group renderer configuration parameters.
void	setGroup(IStructuredGroup structuredGroup) Set the structured group for that the renderer is configured.
String[]	validate(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) Validates the group content

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGroupRenderer

public AbstractGroupRenderer()

Method Detail

render

public abstract com.sapportals.htmlb.Component render(IMetaContext metaContext)
                                               throws PropertyStructureServiceException

Renders the structured group.

Specified by:

render in interface IStructuredGroupRenderer

Parameters:

metaContext - context information for the renderer

Returns:

htmlb component as result of the rendering process

Throws:

PropertyStructureServiceException

getProperties

public IPropertyMap getProperties(IMetaContext metaContext,
                                  com.sapportals.htmlb.page.DynPage dynPage)
                           throws PropertyStructureServiceException

Gets the properties with their entered values after the response has been returned.

Specified by:

getProperties in interface IStructuredGroupRenderer

Parameters:

metaContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Returns:

map of properties with their entered values

Throws:

PropertyStructureServiceException

validate

public String[] validate(IMetaContext metaContext,
                         com.sapportals.htmlb.page.DynPage dynPage)
                  throws PropertyStructureServiceException

Validates the group content

Specified by:

validate in interface IStructuredGroupRenderer

Parameters:

metaContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Returns:

localized error messages or null

Throws:

PropertyStructureServiceException

save

public void save(IMetaContext metaContext,
                 com.sapportals.htmlb.page.DynPage dynPage)
          throws PropertyStructureServiceException

Saves the content of the structured group.

Specified by:

save in interface IStructuredGroupRenderer

Parameters:

metaContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Throws:

PropertyStructureServiceException

setGroup

public void setGroup(IStructuredGroup structuredGroup)

Set the structured group for that the renderer is configured.

Specified by:

setGroup in interface IStructuredGroupRenderer

Parameters:

structuredGroup - group information

getGroup

public IStructuredGroup getGroup()

Returns the group object.

Returns:

IStructuredGroup object

processEvent

public String[] processEvent(com.sapportals.htmlb.event.Event event,
                             IMetaContext metaContext,
                             com.sapportals.htmlb.page.DynPage dynPage)
                      throws PropertyStructureServiceException

Validates the group content

Specified by:

processEvent in interface IStructuredGroupRenderer

Parameters:

event -

metaContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Returns:

localized error messages or null

Throws:

PropertyStructureServiceException

getConfigParameters

public String[] getConfigParameters()

Returns configuration parameters of the group renderer. The parameters are configured as a comma separated list at the attribute "Parameters" of the group renderer configuration.

Specified by:

getConfigParameters in interface IExtendedGroupRenderer

Returns:

String[] of a comma separated list of parameters or null if no parameters are available

setConfigParameters

public void setConfigParameters(String[] configParameters)

Sets the group renderer configuration parameters. The parameters are set by the property structure service.

Specified by:

setConfigParameters in interface IExtendedGroupRenderer

Parameters:

configParameters - String[] of configuration paramters

is508Required

public boolean is508Required()

Returns a boolean value according to 508 required mode

Specified by:

is508Required in interface IAccessibilityGroupRenderer

Returns:

true if 508 mode is required or false otherwise

set508Required

public void set508Required(boolean active)

Sets true if the 508 mode is enabled false otherwise

Specified by:

set508Required in interface IAccessibilityGroupRenderer

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM