public interface IResourceRenderer extends ILayoutObject
IResource
and its
Properties. It is usually instantiated by the ResourceRendererFactory
. The interface has two kind of methods: either set/get methods to access the
member variables of the classes or methods that return an htmlb Component
- the actual rendering. Check also the ILayoutObject
that
implements the functionality to communicate with the configuration of the
rendering framework.Modifier and Type | Field and Description |
---|---|
static int |
LINK_CONTENT
Deprecated.
|
static int |
LINK_CONTENT_ONLY_FOLDERS
Deprecated.
TODO separate enum-class to ensure supported values?
|
static int |
LINK_DETAILS
Deprecated.
|
static int |
LINK_OFF
Deprecated.
|
DEF_VALUE, KEY, LINE_BREAK
Modifier and Type | Method and Description |
---|---|
Map |
getPropertyBag()
Deprecated.
As of NetWeaver 7.1
|
ResourceStateType |
getResourceState()
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
render()
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
render(IProperty property)
Deprecated.
since EP6, SP2_CP
|
com.sapportals.htmlb.Component |
render(IProperty property,
int linktype)
Deprecated.
since EP6, SP2_CP
|
com.sapportals.htmlb.Component |
render(IProperty property,
String target)
Deprecated.
since EP6, SP2_CP
|
com.sapportals.htmlb.Component |
render(String displayname,
int linktype)
Deprecated.
since EP6, SP2_CP. Instead of this method, use
|
com.sapportals.htmlb.Component |
renderAction()
Deprecated.
since EP6, SP2_CP
|
com.sapportals.htmlb.Component |
renderIcon()
Deprecated.
since EP6, SP2_CP
|
com.sapportals.htmlb.Component |
renderIconContentlink()
Deprecated.
since EP6, SP2_CP
|
com.sapportals.htmlb.Component |
renderImage()
Deprecated.
since EP6, SP2_CP
|
com.sapportals.htmlb.Component |
renderImageContentlink()
Deprecated.
since EP6, SP2_CP
|
com.sapportals.htmlb.Component |
renderMetaProperty(IMetaName metaName,
boolean hasContentLink)
Deprecated.
As of NetWeaver 7.1
|
void |
setPropertyBag(Map propertyBag)
Deprecated.
As of NetWeaver 7.1
|
void |
setPropertyNameList(IPropertyNameList propnamelist)
Deprecated.
As of NetWeaver 7.1
|
void |
setResource(IResource resource)
Deprecated.
As of NetWeaver 7.1
|
void |
setResourceState(ResourceStateType type)
Deprecated.
As of NetWeaver 7.1
|
getAlias, getConfiguration, getFlavor, getNewInstance, getParameter, getParameters, getSupportedParameters, is508enabled, setAlias, setFlavor, setParameter, setParameters, setProxy
static final int LINK_CONTENT_ONLY_FOLDERS
static final int LINK_CONTENT
static final int LINK_DETAILS
static final int LINK_OFF
void setPropertyNameList(IPropertyNameList propnamelist)
propnamelist
- The new propertyNameList valuevoid setResource(IResource resource)
null
resource
- The new resource valuecom.sapportals.htmlb.Component render() throws WcmException
IResource
depending on the configuration
available for this resource and on the implementation of the rendering
class. This might lead to very different layouts and available
functionality. If a calling class (e.g. an ICollectionRenderer
requires a more uniform rendering, it can call the different render-methods
that allow the rendering of single attributes of the current IResource
.null
WcmException
- Description of the Exceptioncom.sapportals.htmlb.Component render(IProperty property) throws WcmException
property
- Description of the ParameterWcmException
- Description of the Exceptioncom.sapportals.htmlb.Component render(IProperty property, int linktype) throws WcmException
IResource
.property
- the property to renderlinktype
- Description of the ParameterIResource
as
clickable link. Must not return null
.WcmException
- Description of the Exceptioncom.sapportals.htmlb.Component render(String displayname, int linktype) throws WcmException
displayname
- the name to render. If the value is null
or "".equals(displayname)
or " ".equals(displayname
, the link will be rendered, but is not accessible, as html cannot
render empty Strings or Strings containing only " ".linktype
- Description of the ParameterComponent
. Must not
return null
WcmException
- Description of the Exceptioncom.sapportals.htmlb.Component render(IProperty property, String target) throws WcmException
IResource
as a link
to the given target.property
- the property to rendertarget
- Description of the ParameterWcmException
- Description of the Exceptioncom.sapportals.htmlb.Component renderMetaProperty(IMetaName metaName, boolean hasContentLink) throws WcmException
IResource
metaName
- Description of the ParameterhasContentLink
- Description of the ParameterComponent
. Must not
return null
WcmException
- Description of the Exceptioncom.sapportals.htmlb.Component renderIcon() throws WcmException
WcmException
- Description of the Exceptioncom.sapportals.htmlb.Component renderAction() throws WcmException
IResource
WcmException
- Description of the Exceptioncom.sapportals.htmlb.Component renderIconContentlink() throws WcmException
IResource
. Link behaviour can vary for resources, links and foldersWcmException
- Description of the Exceptioncom.sapportals.htmlb.Component renderImage() throws WcmException
WcmException
- Description of the Exceptioncom.sapportals.htmlb.Component renderImageContentlink() throws WcmException
IResource
. Link behaviour can vary for resources, links and foldersWcmException
- Description of the Exceptionvoid setResourceState(ResourceStateType type)
IResource
is in a
certain state. The renderer can decide, if the resource is displayed
differently, depending on parameters given and the paramters that are
supported by this renderertype
- The new resourceState valueResourceStateType getResourceState()
IResource
member variable of the
renderer.Map getPropertyBag()
null
if the specified resource is not contained in the list or no
property bag is associated with the resource.void setPropertyBag(Map propertyBag) throws WcmException
propertyBag
- Properties to store.WcmException
- If the specified resource is not contained in the list.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