public abstract class AbstractGroupRenderer extends Object implements IStructuredGroupRenderer, IAccessibilityGroupRenderer, IExtendedGroupRenderer
Constructor and Description |
---|
AbstractGroupRenderer() |
Modifier and Type | Method and Description |
---|---|
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
|
public abstract com.sapportals.htmlb.Component render(IMetaContext metaContext) throws PropertyStructureServiceException
render
in interface IStructuredGroupRenderer
metaContext
- context information for the rendererPropertyStructureServiceException
- if an error occuredpublic IPropertyMap getProperties(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) throws PropertyStructureServiceException
getProperties
in interface IStructuredGroupRenderer
metaContext
- context information for the rendererdynPage
- htmlb dynpage that contains the response documentPropertyStructureServiceException
- if an error occuredpublic String[] validate(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) throws PropertyStructureServiceException
validate
in interface IStructuredGroupRenderer
metaContext
- context information for the rendererdynPage
- htmlb dynpage that contains the response documentnull
PropertyStructureServiceException
- if an error occuredpublic void save(IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) throws PropertyStructureServiceException
save
in interface IStructuredGroupRenderer
metaContext
- context information for the rendererdynPage
- htmlb dynpage that contains the response documentPropertyStructureServiceException
- if an error occuredpublic void setGroup(IStructuredGroup structuredGroup)
setGroup
in interface IStructuredGroupRenderer
structuredGroup
- group informationpublic IStructuredGroup getGroup()
IStructuredGroup
objectpublic String[] processEvent(com.sapportals.htmlb.event.Event event, IMetaContext metaContext, com.sapportals.htmlb.page.DynPage dynPage) throws PropertyStructureServiceException
processEvent
in interface IStructuredGroupRenderer
event
- No DescriptionmetaContext
- context information for the rendererdynPage
- htmlb dynpage that contains the response documentnull
PropertyStructureServiceException
- if an error occuredpublic String[] getConfigParameters()
getConfigParameters
in interface IExtendedGroupRenderer
String[]
of a comma separated list of parameters
or null
if no parameters are availablepublic void setConfigParameters(String[] configParameters)
setConfigParameters
in interface IExtendedGroupRenderer
configParameters
- String[]
of configuration paramterspublic boolean is508Required()
is508Required
in interface IAccessibilityGroupRenderer
true
if 508 mode is required or false
otherwisepublic void set508Required(boolean active)
true
if the 508 mode is enabled
false
otherwiseset508Required
in interface IAccessibilityGroupRenderer
active
- a boolean valueAccess Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice