|
SAP NetWeaver 7.40 SP 06 KMC | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sapportals.wcm.rendering.base.LayoutObject
com.sapportals.wcm.rendering.resource.AbstractResourceRenderer
public abstract class AbstractResourceRenderer
| Field Summary | |
|---|---|
static String |
BLANK
Deprecated. |
static String |
CM_RND_ACTION
Deprecated. TODO should these constants declared in the IPropertyService??? |
static String |
CM_RND_CHILDCOUNT
Deprecated. |
static String |
CM_RND_CHILDCOUNT_WITH_BRACKETS
Deprecated. |
static String |
CM_RND_COLLABORATION_STATUS
Deprecated. |
static String |
CM_RND_CONTENT_LINK
Deprecated. |
static String |
CM_RND_DESCRIPTION
Deprecated. |
static String |
CM_RND_DISPLAYNAME
Deprecated. |
static String |
CM_RND_ICON
Deprecated. |
static String |
CM_RND_IMAGE
Deprecated. |
static String |
CM_RND_LOCK
Deprecated. |
static String |
CM_RND_SUBSCRIPTION
Deprecated. |
static String |
COMMA
Deprecated. |
static String |
DEFAULT_VISIBLE_PROPERTIES
Deprecated. |
static String |
NBSP
Deprecated. |
| Fields inherited from class com.sapportals.wcm.rendering.base.LayoutObject |
|---|
supportedParameterKeys |
| Fields inherited from interface com.sapportals.wcm.rendering.resource.IResourceRenderer |
|---|
LINK_CONTENT, LINK_CONTENT_ONLY_FOLDERS, LINK_DETAILS, LINK_OFF |
| Fields inherited from interface com.sapportals.wcm.rendering.base.ILayoutObject |
|---|
DEF_VALUE, KEY, LINE_BREAK |
| Fields inherited from interface com.sapportals.wcm.repository.service.layout.customizing.IParameterNameConst |
|---|
ACTIONSTYLE_BUTTON, ACTIONSTYLE_HOVER, ACTIONSTYLE_ICON, ACTIONSTYLE_LINK, ACTIONSTYLE_MENU, ACTIONSTYLE_OFF, ACTIONSTYLE_SMALLBUTTON, ACTIONSTYLE_TOOLBAR_BUTTON, ACTIONSTYLE_VERTICAL_LINK, BASE_SETTINGS, COLLECTION_RENDERER_SETTINGS, FLAVOR, RESOURCE_RENDERER_SETTINGS, SETNAME, UI_DISPLAY_READONLYMODE_INFO, UI_GROUP_DETAILS, UI_LAYOUT_CONTROLLER, VALUE_OFF |
| Constructor Summary | |
|---|---|
AbstractResourceRenderer()
Deprecated. As of NetWeaver 7.1 |
|
AbstractResourceRenderer(IProxy proxy,
IResource res)
Deprecated. As of NetWeaver 7.1 |
|
| Method Summary | |
|---|---|
String |
getAlias()
Deprecated. As of NetWeaver 7.1 |
protected String |
getCustomImage(IPropertyName propertyName)
Deprecated. As of NetWeaver 7.1 |
protected String |
getDefaultIcon()
Deprecated. As of NetWeaver 7.1 |
IProperty |
getProperty(IPropertyName name)
Deprecated. As of NetWeaver 7.1 |
Map |
getPropertyBag()
Deprecated. As of NetWeaver 7.1 |
List |
getPropertyListByMetaName(IMetaName metaName)
Deprecated. As of NetWeaver 7.1 |
protected IPropertyNameList |
getPropertyNameList()
Deprecated. As of NetWeaver 7.1 |
protected IResource |
getResource()
Deprecated. As of NetWeaver 7.1 |
ResourceStateType |
getResourceState()
Deprecated. As of NetWeaver 7.1 |
protected IPropertyColumn[] |
getVisibleProperties()
Deprecated. As of NetWeaver 7.1 |
protected void |
initialize()
Deprecated. As of NetWeaver 7.1 |
protected IResourceRenderer |
initNewInstance(IResourceRenderer rr)
Deprecated. As of NetWeaver 7.1 |
protected boolean |
isPreviewEnabled()
Deprecated. As of NetWeaver 7.1 |
protected boolean |
isVisible()
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
render()
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
render(IProperty property,
int linktype)
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
render(IProperty property,
String target)
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
render(String displayname,
int linktype)
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
renderAction()
Deprecated. As of NetWeaver 7.1 |
protected com.sapportals.htmlb.Component |
renderContentLink(com.sapportals.htmlb.Component comp)
Deprecated. As of NetWeaver 7.1 |
protected com.sapportals.htmlb.Component |
renderContentLink(IResource resource,
com.sapportals.htmlb.Component comp)
Deprecated. As of NetWeaver 7.1 |
protected com.sapportals.htmlb.Component |
renderDetailsLink(IResource resource,
com.sapportals.htmlb.Component comp)
Deprecated. As of NetWeaver 7.1 |
static com.sapportals.htmlb.Component |
renderEmptyTextView()
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
renderIcon()
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
renderIconContentlink()
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
renderImage()
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
renderImageContentlink()
Deprecated. As of NetWeaver 7.1 |
com.sapportals.htmlb.Component |
renderMetaProperty(IMetaName metaName,
boolean hasContentLink)
Deprecated. As of NetWeaver 7.1 |
void |
setAlias(String alias)
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 |
protected void |
writeDebugInformation()
Deprecated. As of NetWeaver 7.1 |
| Methods inherited from class com.sapportals.wcm.rendering.base.LayoutObject |
|---|
get, getBooleanValue, getBooleanValue, getConfiguration, getFlavor, getIntValue, getIntValue, getMultiValueParameter, getNewInstance, getParameter, getParameter, getParameter, getParameter, getParameter, getParameters, getParameters, getProxy, getSupportedParameters, is508enabled, isExactlyValue, isNoOtherValue, parameterNames, parameters, removeParameter, set508enabled, setFlavor, setParameter, setParameter, setParameter, setParameter, setParameter, setParameters, setProxy, setSupportedParameters |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.sapportals.wcm.rendering.resource.IResourceRenderer |
|---|
render |
| Methods inherited from interface com.sapportals.wcm.rendering.base.ILayoutObject |
|---|
getConfiguration, getFlavor, getNewInstance, getParameter, getParameters, getSupportedParameters, is508enabled, setFlavor, setParameter, setParameters, setProxy |
| Field Detail |
|---|
public static final String NBSP
public static final String BLANK
public static final String COMMA
public static final String CM_RND_ACTION
public static final String CM_RND_DISPLAYNAME
public static final String CM_RND_ICON
public static final String CM_RND_IMAGE
public static final String CM_RND_DESCRIPTION
public static final String CM_RND_LOCK
public static final String CM_RND_CHILDCOUNT
public static final String CM_RND_CHILDCOUNT_WITH_BRACKETS
public static final String CM_RND_COLLABORATION_STATUS
public static final String CM_RND_CONTENT_LINK
public static final String CM_RND_SUBSCRIPTION
public static final String DEFAULT_VISIBLE_PROPERTIES
| Constructor Detail |
|---|
public AbstractResourceRenderer(IProxy proxy,
IResource res)
proxy - Description of the paramres - Description of the parampublic AbstractResourceRenderer()
| Method Detail |
|---|
protected final IResourceRenderer initNewInstance(IResourceRenderer rr)
public final String getAlias()
getAlias in interface ILayoutObjectgetAlias in class LayoutObjectpublic final void setAlias(String alias)
setAlias in interface ILayoutObjectsetAlias in class LayoutObjectalias - The new alias valuepublic final void setResourceState(ResourceStateType type)
setResourceState in interface IResourceRenderertype - The new resourceState valuepublic final ResourceStateType getResourceState()
getResourceState in interface IResourceRendererpublic final void setResource(IResource resource)
setResource in interface IResourceRendererresource - The new resource value
public com.sapportals.htmlb.Component render()
throws WcmException
IResourceRendererIResource 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
.
render in interface IResourceRendererWcmException - Description of the Exception
TODO should all of these methods be removed?
public com.sapportals.htmlb.Component render(IProperty property,
int linktype)
throws WcmException
render in interface IResourceRendererproperty - Description of the paramlinktype - Description of the param
WcmException - Description of the Exception
public com.sapportals.htmlb.Component render(String displayname,
int linktype)
throws WcmException
render in interface IResourceRendererdisplayname - Description of the paramlinktype - Description of the param
WcmException - Description of the Exception
public com.sapportals.htmlb.Component render(IProperty property,
String target)
throws WcmException
render in interface IResourceRendererproperty - Description of the paramtarget - Description of the param
WcmException - Description of the Exception
public com.sapportals.htmlb.Component renderAction()
throws WcmException
renderAction in interface IResourceRendererWcmException - Description of the Exception
public com.sapportals.htmlb.Component renderIcon()
throws WcmException
renderIcon in interface IResourceRendererWcmException - Description of the Exception
public com.sapportals.htmlb.Component renderIconContentlink()
throws WcmException
renderIconContentlink in interface IResourceRendererWcmException - Description of the Exception
public com.sapportals.htmlb.Component renderImage()
throws WcmException
renderImage in interface IResourceRendererWcmException - Description of the Exception
public com.sapportals.htmlb.Component renderImageContentlink()
throws WcmException
renderImageContentlink in interface IResourceRendererWcmException - Description of the Exceptionpublic final void setPropertyNameList(IPropertyNameList propnamelist)
setPropertyNameList in interface IResourceRendererpropnamelist - The new propertyNameList valueprotected void initialize()
render methods. If this method is not overwritten by the extending
class, no parameters will be passed to this class and its behavior remains unchanged
regardless of settings done for this resource (e.g. in iView settings)
protected final IResource getResource()
protected final IPropertyNameList getPropertyNameList()
protected final String getDefaultIcon()
throws WcmException
WcmException - Description of the Exception
WdfException, - that holds the WcmException thrown in
the called framework methods.
protected com.sapportals.htmlb.Component renderContentLink(IResource resource,
com.sapportals.htmlb.Component comp)
throws WcmException
ICollection, the link will navigate into the contents of this
collection. If a preview control is available, the link will trigger an eent
to display the contents in this control. Otherwise, the resource will be displayed
in a new browser window. If a WcmException is thrown while execution,
the given Component will be returned without a link.
comp - Description of the paramresource - Description of the param
WcmException - Description of the Exception
protected com.sapportals.htmlb.Component renderContentLink(com.sapportals.htmlb.Component comp)
throws WcmException
ICollection, the link will navigate into the contents of this
collection. If a preview control is available, the link will trigger an eent
to display the contents in this control. Otherwise, the resource will be displayed
in a new browser window. If a WcmException is thrown while execution,
the given Component will be returned without a link.
comp - Description of the param
WcmException - Description of the Exception
protected com.sapportals.htmlb.Component renderDetailsLink(IResource resource,
com.sapportals.htmlb.Component comp)
throws WcmException
resource - Description of the paramcomp - Description of the param
IResource
. This link will open a new browser-window. It uses the RendererResourceLink
to calculate the link-reference
WcmException - Description of the Exceptionpublic static com.sapportals.htmlb.Component renderEmptyTextView()
null .
protected final boolean isVisible()
protected final String getCustomImage(IPropertyName propertyName)
throws WcmException
IResource of the renderer. If none is specified or if an
exception occurs, the method returns null. If an exception occurs,
the default-icon is returned. The caught exception WcmException
is self-logging, so no logging is needed. Please note, that a user with missing
permissions will not be able to retrieve the custom image and therefore the
default image is returned, although a custom image is defined for the resource.
propertyName - Description of the param
WcmException - Description of the Exception
WdfException - If also the default icon is not availableprotected final IPropertyColumn[] getVisibleProperties()
IPropertyColumn[] that is created out of the information
from the IParameters set for this renderer. Might return nullprotected boolean isPreviewEnabled()
ILayoutController
protected final void writeDebugInformation()
public com.sapportals.htmlb.Component renderMetaProperty(IMetaName metaName,
boolean hasContentLink)
throws WcmException
renderMetaProperty in interface IResourceRenderermetaName - Description of the paramhasContentLink - Description of the param
WcmException - Description of the Exception
public IProperty getProperty(IPropertyName name)
throws WcmException
name - Description of the param
WcmException - Exception raised in failure situation
public List getPropertyListByMetaName(IMetaName metaName)
throws WcmException
metaName - Description of the param
WcmException - Exception raised in failure situationpublic Map getPropertyBag()
getPropertyBag in interface IResourceRenderernull if the specified resource is not contained in the list
or no property bag is associated with the resource.
public void setPropertyBag(Map propertyBag)
throws WcmException
setPropertyBag in interface IResourceRendererpropertyBag - 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
|
|
SAP NetWeaver 7.40 SP 06 KMC | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||