public final class RenderObjectData extends Object
IField
interface which combines information about the actual value as well as label
and tooltip information that can be used for rendering this value.
The StandardDataField
constants define all information elements which can be
simply set by classes within the rendering process.Modifier and Type | Class and Description |
---|---|
static class |
RenderObjectData.InvalidConfiguration
a small, immutable container holding information about an invalid configuration.
|
Modifier and Type | Field and Description |
---|---|
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
ALIAS |
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
DEF_PARAM |
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
FLAVOR |
static FieldIdentifier[] |
IDENTIFIERS |
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
INSTANTIATER |
static int |
INVALID_508 |
static int |
INVALID_ALIAS |
static int |
INVALID_BUNDLE |
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
JAVA_CLASS |
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
LIST_TYPE |
static int |
NO_MAPPING |
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
RID |
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
STARTRID |
static com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField |
SUPPORT508 |
Constructor and Description |
---|
RenderObjectData(IResourceContext context) |
Modifier and Type | Method and Description |
---|---|
void |
addAdditionalParameters(String source,
IParameters parameters)
adds the parameterization for the render object that has been provided by
the specified source.
|
void |
addUnstructuredInfo(Field field)
adds a field to the list of unstructed information.
|
void |
addUnstructuredInfo(String label,
String value)
creates a standard
Field instance with an arbritary Identifier. |
List |
getAdditionalParameterFields(String source) |
List |
getAdditionalParameterSources() |
List |
getFields()
returns a new list instance that contains all fields that
- belong to the list of StandardDataField s and
- are not null
The list is ordered the same way the IDENTIFIERS-array is ordered. |
RenderObjectData.InvalidConfiguration |
getInvConfig() |
List |
getParameterFields() |
Status |
getStatus() |
List |
getUnstructuredInfo() |
void |
set(com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField id,
Object value)
sets the new value for the
StandardDataField of this object. |
void |
set(com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField id,
String value)
sets the new value for the
StandardDataField of this object. |
void |
setInvConfig(RenderObjectData.InvalidConfiguration configuration) |
void |
setParameters(IParameters parameters) |
void |
setStatus(Status status) |
public static final int INVALID_ALIAS
public static final int INVALID_508
public static final int NO_MAPPING
public static final int INVALID_BUNDLE
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField DEF_PARAM
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField ALIAS
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField JAVA_CLASS
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField RID
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField STARTRID
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField INSTANTIATER
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField LIST_TYPE
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField FLAVOR
public static final com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField SUPPORT508
public static final FieldIdentifier[] IDENTIFIERS
public RenderObjectData(IResourceContext context)
public void set(com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField id, String value)
StandardDataField
of this object.id
- the field for which the new value is to be added, must not be null
value
- the new value for this field. If the value is null
, or
"".equals(value) == true
, the value will be set to "-"
public void set(com.sapportals.wcm.repository.service.layout.info.RenderObjectData.StandardDataField id, Object value)
StandardDataField
of this object.id
- the field for which the new value is to be added, must not be null
value
- the new value for this field. If the value is null
, or
"".equals(value) == true
, the value will be set to "-"
public void addUnstructuredInfo(Field field)
ILayoutController
the list of registered Control
instances). These objects do not fit in one
of the other buckets of information and are therefore added to this list.field
- an entry for the renderer-specific information for this RenderObjectData
,
must not be null
public void addUnstructuredInfo(String label, String value)
Field
instance with an arbritary Identifier.
The label and tooltip of this field will be the value of the label-parameter
and not translated. The value-parameter is used as value of that Field
.
The field will be readonly, have no condition and use the Locale
of this classlabel
- the label to use, must not be null
value
- the value to display, must not be null
public List getUnstructuredInfo()
List
implementation that only contains objects that
implement the IField
interface. The list will not contain
null
elements. The ordering of the list might be changed between calls.public void setParameters(IParameters parameters)
parameters
- the parameters (which are usually defined by the
ICustomizingController
and used for the configuration of this rendering object
This method should normally be called by the rendering object itself to ensure that public List getFields()
StandardDataField
s and
- are not null
The list is ordered the same way the IDENTIFIERS-array is ordered.null
public List getParameterFields()
IField
interface and does not contain null
references. If no IParameters
have been defined via the
setParameters
method, it will return an empty list, but
never null
. The IField
instances each represent
a single parameter value.public void addAdditionalParameters(String source, IParameters parameters)
source
- the name of the parameter source, that also will be used to
render the information about this source. Must not be null
.parameters
- the parameters specified by the given source.
Must not be null
.public List getAdditionalParameterSources()
null
.public List getAdditionalParameterFields(String source)
source
- the source the paramters are needed for.IField
instances and
no null
references. It might be empty, but never null
.public RenderObjectData.InvalidConfiguration getInvConfig()
null
public void setInvConfig(RenderObjectData.InvalidConfiguration configuration)
configuration
- the invalid configuration data for the
render object, might be null
public Status getStatus()
Status
instancepublic void setStatus(Status status)
status
- 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