public final class RenderObjectContainer extends Object
IRenderObjectInfo
instances.
If the info for the requested RenderObjectKey
does not exist, it
will be created, added to the map and returned to the calling class. If the
info for the requested key has already been created, the existing info will be
returned. The calling class is then free to modify the data of this info.
This ensures that throughout the rendering process all information suppliers for
a certain rendering object combine their information in a single
IRenderObjectInfo
.IRenderingContainer
which will
return this instance to calling classes via its getRenderObjectContainer
method.Constructor and Description |
---|
RenderObjectContainer(IResourceContext context)
creates a new, empty container.
|
Modifier and Type | Method and Description |
---|---|
RID |
getMainRID() |
IRenderObjectInfo |
getRenderObject(RenderObjectKey key)
returns the
IRenderObjectInfo that is mapped to the supplied key
parameter. |
RenderObjectInfoList |
getRenderObjects(IRenderObjectInfo.RenderObjectCategory category) |
Status |
getStatus() |
Set |
keys() |
void |
setMainRID(RID rid) |
int |
size() |
public RenderObjectContainer(IResourceContext context)
context
- must not be null
public void setMainRID(RID rid)
rid
- the accessrid of the current ICollection
that is viewed here.public RID getMainRID()
ICollection
that was viewed. Might be
null
, if e.g. a ITypedResourceList
is viewedpublic int size()
IRenderObjectInfo
elements that are stored
within this container.public Status getStatus()
public Set keys()
Set
of the internally hold set of
RenderObjectKey
instances. If no entries have been created within
this container, this method will return a set with Set.size() == 0
,
but never null
.public IRenderObjectInfo getRenderObject(RenderObjectKey key)
IRenderObjectInfo
that is mapped to the supplied key
parameter. If it is the first request for this key, a new IRenderObjectInfo
will be created by this container. The supplied key will be used as the
RenderObjectKey
attribute of this new object. Each following request will
receive the same instance of the IRenderObjectInfo
that was created for
the first call.key
- IRenderObjectInfo
that is mapped to the supplied key
parameter.public RenderObjectInfoList getRenderObjects(IRenderObjectInfo.RenderObjectCategory category)
category
- the category to retrieve objects for, must not be null
RenderObjectKey
. If no
IRenderObject
has been defined for this category, an empty
list will be returned, but never null
. For each call, a new
List
instance will be created.Access 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