public interface IStructuredPropertyRenderer
IMetaName
into Properties dialogModifier and Type | Method and Description |
---|---|
IPropertyMap |
getProperties(IMetaName metaName,
IMetaContext rendererContext,
com.sapportals.htmlb.page.DynPage dynPage)
Gets the properties with their entered values after the response has been returned.
|
String[] |
processEvent(IMetaName metaName,
com.sapportals.htmlb.event.Event event,
IMetaContext rendererContext,
com.sapportals.htmlb.page.DynPage dynPage)
The property renderer can react to events.
|
com.sapportals.htmlb.Component |
renderMetaNameLabel(IMetaName metaName,
IMetaContext rendererContext)
Renders a htmlb
Component for the label for a given IMetaName and a given IMetaContext
null as returned component is accepted, if no label is whished. |
com.sapportals.htmlb.Component |
renderMetaProperty(IMetaName metaName,
IMetaContext rendererContext)
Renders a htmlb
Component for a given IMetaName and a given IMetaContext
null as returned component is accepted, if the renderer context does not allowed that the IMetaName to be rendered (The permission should be check). |
com.sapportals.htmlb.Component renderMetaProperty(IMetaName metaName, IMetaContext rendererContext) throws WcmException
Component
for a given IMetaName
and a given IMetaContext
null as returned component is accepted, if the renderer context does not allowed that the IMetaName to be rendered (The permission should be check).
The returned Component
can be different according with PropertyDisplyMode
from IMetaContext
.
From IMetaContext
can be taken the current value of the property, the IResourceConext
, the current IResource
,
the IPropertyRendererProxy
which generates unique Ids for Components and the invalid metaNames as a Hashmap.
As key in the Hashmap is IMetaName.getId()
. If the IMetaName
has an input into invalid Hashmap than
the Component will be rendered as invalid.
For setting a unique rendering id for the component it should be used
rendererContext.getRendererProxy().getUniqueComponentId(IMetaName metaName, String key)
If in the rendering Components there are components which need a server round trip (ex Buttons ) then as unique Id
should be call rendererContext.getRendererProxy().dispatchableControlIDWithValues(ArrayList values) or
rendererContext.getRendererProxy().dispatchableControlID(String action).
In ArrayList the first value should be the action of the button. Normally this string will be encode into a htmlb
Event
and it will be sent for processing in processEvent
methodmetaName
- the given IMetaName
for which the component will be renderedrendererContext
- the given IMetaContext
for which the component will be renderedComponent
which will rendered in in UI dialogWcmException
- if an error occurredString[] processEvent(IMetaName metaName, com.sapportals.htmlb.event.Event event, IMetaContext rendererContext, com.sapportals.htmlb.page.DynPage dynPage) throws WcmException
Event
should be decode using rendererContext.getRendererProxy().decodeValues(event);
If the ArrayList is not empty then the first value from it is the action as String
.
If the action is known by the renderer then the logic should be implemented
If something fails then one or more error messages should be returns as String arrayrendererContext
- context information for the rendererdynPage
- htmlb dynpage that contains the response documentmetaName
- the given IMetaName
for which the renderer is calledevent
- the Event
which has encoded the action and other value which will
be process by the renderernull
WcmException
- if an error occurredIPropertyMap getProperties(IMetaName metaName, IMetaContext rendererContext, com.sapportals.htmlb.page.DynPage dynPage) throws WcmException
Component
from the DynPage
, the the input value, and validate and create a IProperty
for this
IMetaName
. If the input value is invalid then it will created a IProperty
with empty value
like it follows : IPropertyMap
and it will be shown as invalid input.
The returned IPropertyMap
could have one or more IProperty
according
with the property renderer logic.dynPage
- htmlb dynpage that contains the response documentmetaName
- the given IMetaName
for which the property will be createdrendererContext
- - contains the rendering information: which IResourceContext
,
IResource
or PropertyDisplayMode
null
is acceptedWcmException
- if an error occurredcom.sapportals.htmlb.Component renderMetaNameLabel(IMetaName metaName, IMetaContext rendererContext)
Component
for the label for a given IMetaName
and a given IMetaContext
null as returned component is accepted, if no label is whished.metaName
- the given IMetaName
for which the component will be renderedrendererContext
- the given IMetaContext
for which the component will be renderedComponent
which will rendered in in UI dialogAccess 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