public abstract class AbstractPropertyRenderer extends Object implements IPropertyRenderer, IStructuredPropertyRenderer, IAccessibilityRenderer, IRenderMetaName
Modifier and Type | Field and Description |
---|---|
static String |
CID_PROPERTY_NAME
Deprecated.
|
static String |
CID_PROPERTY_ROW
Deprecated.
|
static String |
CID_PROPERTY_TIME_VALUE
Deprecated.
|
static String |
CID_PROPERTY_VALUE
Deprecated.
|
static String |
CM_DESCRIPTION
Deprecated.
|
static String |
CM_RND_EXPLORER_URL
Deprecated.
|
static String |
CM_RND_EXTERNAL_LINK
Deprecated.
|
static String |
CM_RND_PATH
Deprecated.
|
static String |
CM_RND_TARGET_URL
Deprecated.
|
static String |
CM_RND_TARGET_URL_COPY
Deprecated.
|
static String |
CM_RND_WEBDAV_URL
Deprecated.
|
static String |
CM_RND_WEBDAV_URL_COPY
Deprecated.
|
protected IMetaName |
currentMetaName
Deprecated.
|
static String |
DATE_FORMAT
Deprecated.
|
static String |
DEFAULT_DATE_FORMAT
Deprecated.
|
static String |
DEFAULT_DATE_TIME_FORMAT
Deprecated.
|
static String |
DEFAULT_TIME_FORMAT
Deprecated.
|
protected PropertyDisplayMode |
displayMode
Deprecated.
If no display mode is set, the default display mode is undefined.
|
static String |
EVENT_ADD_NEW_VALUE
Deprecated.
|
static String |
EVENT_EDIT_HTML
Deprecated.
|
protected com.sapportals.htmlb.LabeledComponent |
labeledComponent
Deprecated.
|
static String |
METATAG_NO_LABEL
Deprecated.
|
static String |
RENDER_HTML
Deprecated.
|
static String |
RES_ADD_NEW_VALUE
Deprecated.
|
static String |
RES_EDIT_HTML
Deprecated.
|
Constructor and Description |
---|
AbstractPropertyRenderer()
Deprecated.
As of NetWeaver 7.1
|
Modifier and Type | Method and Description |
---|---|
static ResourceBundles |
getBundle(String fileName)
Deprecated.
As of NetWeaver 7.1
|
IMetaName |
getCurrentMetaName()
Deprecated.
Retrieve the current
IMetaName |
com.sapportals.htmlb.LabeledComponent |
getLabeledComponent()
Deprecated.
As of NetWeaver 7.1
|
IPropertyMap |
getProperties(IMetaName metaName,
IMetaContext rendererContext,
com.sapportals.htmlb.page.DynPage dynPage)
Deprecated.
As of NetWeaver 7.1
|
IProperty |
getProperty(com.sapportals.htmlb.page.DynPage dynPage)
Deprecated.
As of NetWeaver 7.1
|
String |
getPropertyTooltip(IMetaName metaName)
Deprecated.
As of NetWeaver 7.1
|
protected PropertyType |
getPropertyType(IMetaName metaName)
Deprecated.
As of NetWeaver 7.1
|
IResourceContext |
getResourceContext()
Deprecated.
As of NetWeaver 7.1
|
boolean |
is508Required()
Deprecated.
As of NetWeaver 7.1
|
protected Boolean |
isEditable(IMetaName metaName,
IMetaContext rendererContext)
Deprecated.
As of NetWeaver 7.1
|
protected Boolean |
isEditable(IMetaName metaName,
IMetaContext rendererContext,
boolean ignoreVirtual)
Deprecated.
As of NetWeaver 7.1
|
String[] |
processEvent(IMetaName metaName,
com.sapportals.htmlb.event.Event event,
IMetaContext rendererContext,
com.sapportals.htmlb.page.DynPage dynPage)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderMetaNameLabel(IMetaName metaName,
IMetaContext rendererContext)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderMetaProperty(IMetaName metaName,
IMetaContext rendererContext)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderProperty(IProperty property,
IResource resource,
int maxLength)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderProperty(IProperty property,
IResource resource,
int maxLength,
com.sapportals.wdf.stack.Control ctrl)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderSpacing()
Deprecated.
As of NetWeaver 7.1
|
void |
set508Required(boolean active)
Deprecated.
As of NetWeaver 7.1
|
void |
setCurrentMetaName(IMetaName metaName)
Deprecated.
Set the
IMetaName |
void |
setDisplayMode(PropertyDisplayMode displayMode)
Deprecated.
As of NetWeaver 7.1
|
void |
setResourceContext(IResourceContext context)
Deprecated.
As of NetWeaver 7.1
|
public static final String EVENT_ADD_NEW_VALUE
public static final String EVENT_EDIT_HTML
public static final String RES_ADD_NEW_VALUE
public static final String RES_EDIT_HTML
public static final String RENDER_HTML
public static final String CM_RND_PATH
public static final String CM_RND_TARGET_URL
public static final String CM_RND_EXPLORER_URL
public static final String CM_RND_WEBDAV_URL
public static final String CM_RND_WEBDAV_URL_COPY
public static final String CM_RND_TARGET_URL_COPY
public static final String CM_RND_EXTERNAL_LINK
public static final String CM_DESCRIPTION
public static final String DATE_FORMAT
public static final String DEFAULT_DATE_TIME_FORMAT
public static final String DEFAULT_TIME_FORMAT
public static final String DEFAULT_DATE_FORMAT
public static final String CID_PROPERTY_VALUE
public static final String CID_PROPERTY_TIME_VALUE
public static final String CID_PROPERTY_NAME
public static final String CID_PROPERTY_ROW
public static final String METATAG_NO_LABEL
protected com.sapportals.htmlb.LabeledComponent labeledComponent
protected IMetaName currentMetaName
protected PropertyDisplayMode displayMode
public AbstractPropertyRenderer()
public com.sapportals.htmlb.Component renderProperty(IProperty property, IResource resource, int maxLength) throws WcmException
renderProperty
in interface IPropertyRenderer
property
- to berenderedresource
- to which the property belongsmaxLength
- Description of the ParameterWcmException
- Description of the Exceptionpublic com.sapportals.htmlb.Component renderProperty(IProperty property, IResource resource, int maxLength, com.sapportals.wdf.stack.Control ctrl) throws WcmException
renderProperty
in interface IPropertyRenderer
property
- to berenderedresource
- to which the property belongsctrl
- can be used for callback actionsmaxLength
- Description of the ParameterWcmException
- Description of the Exceptionpublic void setDisplayMode(PropertyDisplayMode displayMode)
setDisplayMode
in interface IPropertyRenderer
displayMode
- current display modepublic IProperty getProperty(com.sapportals.htmlb.page.DynPage dynPage) throws WcmException
getProperty
in interface IPropertyRenderer
dynPage
- response pageWcmException
- Description of the Exceptionpublic com.sapportals.htmlb.Component renderMetaNameLabel(IMetaName metaName, IMetaContext rendererContext)
IStructuredPropertyRenderer
Component
for the label for a given IMetaName
and a given IMetaContext
null as returned component is accepted, if no label is whished.renderMetaNameLabel
in interface IStructuredPropertyRenderer
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 dialogpublic String getPropertyTooltip(IMetaName metaName)
public com.sapportals.htmlb.Component renderSpacing()
public com.sapportals.htmlb.Component renderMetaProperty(IMetaName metaName, IMetaContext rendererContext) throws WcmException
renderMetaProperty
in interface IStructuredPropertyRenderer
rendererContext
- Description of the ParametermetaName
- Description of the ParameterWcmException
- Description of the Exceptionprotected Boolean isEditable(IMetaName metaName, IMetaContext rendererContext) throws WcmException
metaName
- rendererContext
- WcmException
protected Boolean isEditable(IMetaName metaName, IMetaContext rendererContext, boolean ignoreVirtual) throws WcmException
metaName
- rendererContext
- ignoreVirtual
- - if the metaName.isVistual() method is ignored or notWcmException
public IResourceContext getResourceContext()
null
public void setResourceContext(IResourceContext context)
public String[] processEvent(IMetaName metaName, com.sapportals.htmlb.event.Event event, IMetaContext rendererContext, com.sapportals.htmlb.page.DynPage dynPage) throws WcmException
IStructuredPropertyRenderer
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 arrayprocessEvent
in interface IStructuredPropertyRenderer
metaName
- 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 rendererrendererContext
- context information for the rendererdynPage
- htmlb dynpage that contains the response documentnull
WcmException
- if an error occurredpublic IPropertyMap getProperties(IMetaName metaName, IMetaContext rendererContext, com.sapportals.htmlb.page.DynPage dynPage) throws WcmException
IStructuredPropertyRenderer
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.getProperties
in interface IStructuredPropertyRenderer
metaName
- the given IMetaName
for which the property will be createdrendererContext
- - contains the rendering information: which IResourceContext
,
IResource
or PropertyDisplayMode
dynPage
- htmlb dynpage that contains the response documentnull
is acceptedWcmException
- if an error occurredprotected PropertyType getPropertyType(IMetaName metaName)
metaName
- Description of the parampublic static ResourceBundles getBundle(String fileName) throws MissingResourceException
fileName
- Description of the ParameterMissingResourceException
- The default resource bundle must be available!public com.sapportals.htmlb.LabeledComponent getLabeledComponent()
IAccessibilityRenderer
LabeledComponent
which it'll be attached to the
property Label
component in 508 mode by rendering
the Property StructuregetLabeledComponent
in interface IAccessibilityRenderer
public boolean is508Required()
IAccessibilityRenderer
is508Required
in interface IAccessibilityRenderer
public void set508Required(boolean active)
true
if the 508 mode is enabled
false
otherwiseset508Required
in interface IAccessibilityRenderer
public IMetaName getCurrentMetaName()
IRenderMetaName
IMetaName
getCurrentMetaName
in interface IRenderMetaName
public void setCurrentMetaName(IMetaName metaName)
IRenderMetaName
IMetaName
setCurrentMetaName
in interface IRenderMetaName
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
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