com.sapportals.wcm.control.util

Class PropertyRendererBooleanRB

java.lang.Object
  com.sapportals.wcm.control.util.AbstractPropertyRenderer
      com.sapportals.wcm.control.util.PropertyRendererBooleanRB

All Implemented Interfaces:

IPropertyRenderer, IRenderMetaName, ISelectionSupported, IAccessibilityRenderer, IStructuredPropertyRenderer

public class PropertyRendererBooleanRB
extends AbstractPropertyRenderer
implements ISelectionSupported

The PropertyRendererBooleanRB is default rendering for Properties of type boolean

Copyright 2004 SAP AG

Field Summary

Fields inherited from class com.sapportals.wcm.control.util.AbstractPropertyRenderer

CID_PROPERTY_NAME, CID_PROPERTY_ROW, CID_PROPERTY_TIME_VALUE, CID_PROPERTY_VALUE, CM_DESCRIPTION, CM_RND_EXPLORER_URL, CM_RND_EXTERNAL_LINK, CM_RND_PATH, CM_RND_TARGET_URL, CM_RND_TARGET_URL_COPY, CM_RND_WEBDAV_URL, CM_RND_WEBDAV_URL_COPY, currentMetaName, DATE_FORMAT, DEFAULT_DATE_FORMAT, DEFAULT_DATE_TIME_FORMAT, DEFAULT_TIME_FORMAT, displayMode, EVENT_ADD_NEW_VALUE, EVENT_EDIT_HTML, labeledComponent, METATAG_NO_LABEL, RENDER_HTML, RES_ADD_NEW_VALUE, RES_EDIT_HTML

Constructor Summary

PropertyRendererBooleanRB()

Method Summary

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.
boolean	isSelectionSupported()
com.sapportals.htmlb.Component	renderMetaProperty(IMetaName metaName, IMetaContext rendererContext) Display only for read-only properties
com.sapportals.htmlb.Component	renderProperty(IProperty property, IResource res, int maxLength) renders a property returning an Component

Methods inherited from class com.sapportals.wcm.control.util.AbstractPropertyRenderer

getBundle, getCurrentMetaName, getLabeledComponent, getProperty, getPropertyTooltip, getPropertyType, getResourceContext, is508Required, isEditable, isEditable, processEvent, renderMetaNameLabel, renderProperty, renderSpacing, set508Required, setCurrentMetaName, setDisplayMode, setResourceContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyRendererBooleanRB

public PropertyRendererBooleanRB()

Method Detail

renderProperty

public com.sapportals.htmlb.Component renderProperty(IProperty property,
                                                     IResource res,
                                                     int maxLength)

Description copied from class: AbstractPropertyRenderer

renders a property returning an Component

Specified by:

renderProperty in interface IPropertyRenderer

Overrides:

renderProperty in class AbstractPropertyRenderer

Parameters:

property - to berendered

res - to which the property belongs

maxLength - Description of the Parameter

Returns:

Description of the Return Value

renderMetaProperty

public com.sapportals.htmlb.Component renderMetaProperty(IMetaName metaName,
                                                         IMetaContext rendererContext)
                                                  throws WcmException

Description copied from class: AbstractPropertyRenderer

Display only for read-only properties

Specified by:

renderMetaProperty in interface IStructuredPropertyRenderer

Overrides:

renderMetaProperty in class AbstractPropertyRenderer

Parameters:

metaName - Description of the Parameter

rendererContext - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WcmException - Description of the Exception

getProperties

public IPropertyMap getProperties(IMetaName metaName,
                                  IMetaContext rendererContext,
                                  com.sapportals.htmlb.page.DynPage dynPage)
                           throws WcmException

Description copied from interface: IStructuredPropertyRenderer

Gets the properties with their entered values after the response has been returned. The method will be call by every summit event and it should read the generated htmlb 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 :
Properties errorProperties = new Properties(); errorProperties.setProperty(metaName.getId(), value); currentProperty = new Property(new PropertyName(metaName.getNamespace(), metaName.getName()), "", errorProperties); This IProperty will be added into a IPropertyMap and it will be shown as invalid input. The returned IPropertyMap could have one or more IProperty according with the property renderer logic.

Specified by:

getProperties in interface IStructuredPropertyRenderer

Overrides:

getProperties in class AbstractPropertyRenderer

Parameters:

metaName - the given IMetaName for which the property will be created

rendererContext - - contains the rendering information: which IResourceContext, IResource or PropertyDisplayMode

dynPage - htmlb dynpage that contains the response document

Returns:

map of properties. null is accepted

Throws:

WcmException

isSelectionSupported

public boolean isSelectionSupported()

Specified by:

isSelectionSupported in interface ISelectionSupported

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM