com.sapportals.wcm.rendering.collection
Class AbstractCollectionRenderer

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.collection_api.jar]

com.sapportals.wcm.rendering.collection.AbstractCollectionRenderer

All Implemented Interfaces:

ICollectionRenderer, IDelegatedReceiver, ILayoutObject, IResourceListProvider

public abstract class AbstractCollectionRenderer

implements ICollectionRenderer, IResourceListProvider

This abstract class can be used when implementing new CollectionRenderer-Classes It provides persistence of selections (when mass actions are enabled), takes care of ResourceProperties, offers method to create sorting box in Control Persistence is realized by using IUMPrincipal.setTransientAttribute . This can lead to errounous behavior when the user hasn't worked for some time in the browser and the cache has expired.

Inner Class Summary

static class

AbstractCollectionRenderer.Persistence

Field Summary

static java.lang.String	BASE_BUNDLE
static java.lang.String	BLANK
static java.lang.String	CM_RND_ACTION
static java.lang.String	CM_RND_CHILDCOUNT
static java.lang.String	CM_RND_CHILDCOUNT_BOTH
static java.lang.String	CM_RND_CHILDCOUNT_FILES
static java.lang.String	CM_RND_CHILDCOUNT_FOLDERS
static java.lang.String	CM_RND_CHILDCOUNT_PROPERTY_NAME
static java.lang.String	CM_RND_CHILDCOUNT_SUM
static java.lang.String	CM_RND_CHILDCOUNT_WITH_BRACKETS
static java.lang.String	CM_RND_CHILDCOUNT_WITH_BRACKETS_PROPERTY_NAME
static java.lang.String	CM_RND_DESCRIPTION
static java.lang.String	CM_RND_DISPLAYNAME
static java.lang.String	CM_RND_ICON
static java.lang.String	CM_RND_IMAGE
static java.lang.String	CM_RND_LOCK
static java.lang.String	COMMA
static java.lang.String	DEFAULT_PROPERTY_COLUMNS
static java.lang.String	DEFAULT_SORT_ORDER
static java.lang.String	DEFAULT_SORT_PROPERTY
static int	MANUAL_SORT_ORDER
static java.lang.String	NBSP
static java.lang.String	NO_SORT_PROPERTY
static java.lang.String	ON_NAVIGATE
static java.lang.String	ON_SELECT_FILTER
static java.lang.String	ON_SELECT_SORT
static java.lang.String	ON_TOGGLE_FILTER
static java.lang.String	ON_TOGGLE_SORT
static java.lang.String	PIXEL
static java.lang.String	RES_CONTENTSOF
static java.lang.String	RES_EDIT
static java.lang.String	RES_FILESOF
static java.lang.String	RES_FOLDERSOF
static java.lang.String	RES_SELECTIONLOST
static java.lang.String	RES_SELECTRESOURCE
static java.lang.String	RES_SORT_ASCENDING
static java.lang.String	RES_SORT_DESCENDING
static java.lang.String	RES_SORTASCENDING
static java.lang.String	RES_SORTBY
static java.lang.String	RES_SORTDESCENDING

Fields inherited from interface com.sapportals.wcm.rendering.collection.ICollectionRenderer

ORDERED_COLLECTION, SORTED, UNSORTED

Fields inherited from interface com.sapportals.wcm.rendering.base.ILayoutObject

DEF_VALUE, KEY, LINE_BREAK

Constructor Summary

AbstractCollectionRenderer()
Constructor for the AbstractCollectionRenderer object

Method Summary

protected void	checkReadPermission()
protected void	filterResourceList()
java.lang.Object	get(java.lang.String key) Description of the Method
java.lang.String	getAlias() implementation of the ILayoutObject-interface ************
com.sapportals.wcm.control.util.property.IPropertyColumn[]	getColumnsList() Gets the columnsList attribute of the AbstractCollectionRenderer object
java.lang.String	getColumnsListID()
java.lang.String	getColumnSpacing() Gets the columnSpacing attribute of the AbstractCollectionRenderer object
java.lang.String	getConfiguration(java.lang.String format) Gets the configuration attribute of the AbstractCollectionRenderer object
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor	getFlavor() Gets the flavor attribute of the AbstractCollectionRenderer object
protected int	getIntValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, int defValue)
protected int	getIntValue(java.lang.String key, int defValue)
protected LayoutObject	getLayoutObject()
protected int	getMaxLength(java.lang.String[] defaultModifiers)
java.util.List	getMultiValueParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key) Gets the multiValueParameter attribute of the AbstractCollectionRenderer object
java.lang.String	getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key) Gets the parameter attribute of the AbstractCollectionRenderer object
boolean	getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, boolean defaultValue) Gets the parameter attribute of the AbstractCollectionRenderer object
int	getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, int defaultValue) Gets the parameter attribute of the AbstractCollectionRenderer object
java.lang.String	getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.String defaultValue) Gets the parameter attribute of the AbstractCollectionRenderer object
com.sapportals.htmlb.enum.TextViewDesign	getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, com.sapportals.htmlb.enum.TextViewDesign defaultValue) Gets the parameter attribute of the AbstractCollectionRenderer object
com.sapportals.wcm.repository.service.layout.customizing.IParameters	getParameters() Gets the parameters attribute of the AbstractCollectionRenderer object
com.sapportals.wcm.repository.service.layout.customizing.IParameters	getParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] keys) Gets the parameters attribute of the AbstractCollectionRenderer object
ICollection	getParentCollection() Gets the parentCollection attribute of the AbstractCollectionRenderer object
IPropertyConfigurationService	getPropertyConfigurationService() Gets the propertyConfigurationService attribute of the AbstractCollectionRenderer object
protected java.util.HashMap	getPropertyMap()
IPropertyNameList	getPropertyNames() Gets the propertyNames attribute of the AbstractCollectionRenderer object
protected IProxy	getProxy()
protected IResourceRenderer	getRenderer(IResource res)
IResourceList	getResourceList() Gets the resourceList attribute of the AbstractCollectionRenderer object
java.lang.String	getResourceListID()
java.lang.String	getRowSpacing() Gets the rowSpacing attribute of the AbstractCollectionRenderer object
boolean	getSelectedElementsExist() Gets the selectedElementsExist attribute of the AbstractCollectionRenderer object
IResourceList	getSelectedResources() Gets the selectedResources attribute of the AbstractCollectionRenderer object
java.lang.String	getSelectedResourcesMapID()
java.lang.String	getSortField() Gets the sortField attribute of the AbstractCollectionRenderer object
int	getSortOrder() Gets the sortOrder attribute of the AbstractCollectionRenderer object
protected IPropertyName	getSortPropertyName()
int	getStartRow() Gets the startRow attribute of the AbstractCollectionRenderer object
com.sapportals.wcm.repository.service.layout.customizing.IParameterName[]	getSupportedParameters() Gets the supportedParameters attribute of the AbstractCollectionRenderer object
java.lang.String	getUserDefinedFilterID() Gets the userDefinedFilterID attribute of the AbstractCollectionRenderer object
protected void	initialize()
protected ICollectionRenderer	initNewInstance(ICollectionRenderer cr) end of implementation of the ILayoutObject-interface **********
boolean	is508enabled() Description of the Method
boolean	isExactlyValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.Object checkValue) Gets the exactlyValue attribute of the AbstractCollectionRenderer object
boolean	isNoOtherValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.Object checkValue) Gets the noOtherValue attribute of the AbstractCollectionRenderer object
boolean	modifierListContains(com.sapportals.wcm.control.util.property.IPropertyColumn propertyColumn, java.lang.String propertyModifierName) Description of the Method
com.sapportals.wdf.event.WdfEvent	onNavigate(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onSelectFilter(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onSelectSort(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onSort(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onToggleFilter(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wdf.event.WdfEvent	onToggleSort(com.sapportals.htmlb.event.Event event) Description of the Method
com.sapportals.wcm.repository.service.layout.customizing.IParameterNameSet	parameterNames() Description of the Method
java.util.Set	parameters() Description of the Method
void	persistSelectedResourcesMap() Description of the Method
void	readCheckBoxes() Description of the Method
protected void	readInputData()
void	receive(com.sapportals.wdf.event.WdfEvent cflEvent) CflEventReceiver
void	refresh() asks the implementing class to refresh its list of IResource objects.
void	removeParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key) Description of the Method
com.sapportals.htmlb.Component	render() Description of the Method
com.sapportals.htmlb.Component	renderAction(IResource res, com.sapportals.wcm.repository.service.layout.customizing.IParameterName parameterName) Description of the Method
com.sapportals.htmlb.Component	renderAll()
com.sapportals.htmlb.Component	renderBreadcrumb() Description of the Method
com.sapportals.htmlb.Checkbox	renderCheckbox(IResource res) Description of the Method
com.sapportals.htmlb.Checkbox	renderCheckbox(IResource res, java.lang.String selectionmode) Description of the Method
static com.sapportals.htmlb.Component	renderEmptyTextView() Description of the Method
com.sapportals.htmlb.Component	renderFilter() Description of the Method
com.sapportals.htmlb.Component	renderFolderTitle() Description of the Method
protected com.sapportals.htmlb.Component	renderInfoNoResourcesAvailable()
com.sapportals.htmlb.Component	renderItemSelectionMode(IResource res) Description of the Method
com.sapportals.htmlb.Component	renderMetaProperty(IResourceRenderer renderer, IMetaName metaName, boolean hasContentLink, boolean useSecondaryStyle) Description of the Method
com.sapportals.htmlb.Component	renderPager(boolean hasMore, int pageInterval, int linkCount) Description of the Method
com.sapportals.htmlb.Component	renderPropertyColumn(IResource resource, com.sapportals.wcm.control.util.property.IPropertyColumn propertyColumn, boolean useSecondaryStyle) Description of the Method
com.sapportals.htmlb.Component	renderPropertyColumn(IResourceRenderer renderer, IResource resource, com.sapportals.wcm.control.util.property.IPropertyColumn propertyColumn, boolean useSecondaryStyle) Description of the Method
com.sapportals.htmlb.Component	renderSorter() Description of the Method
abstract com.sapportals.htmlb.Component	renderUI() Description of the Method
void	resetSelection() Description of the Method
protected void	set508enabled(boolean imp508)
void	setAlias(java.lang.String alias) Sets the alias attribute of the AbstractCollectionRenderer object
void	setColumnsList(com.sapportals.wcm.control.util.property.IPropertyColumn[] list) Sets the columnsList attribute of the AbstractCollectionRenderer object
void	setColumnsListID(java.lang.String value)
void	setFlavor(com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor impFlavor) Sets the flavor attribute of the AbstractCollectionRenderer object
java.lang.Boolean	setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, boolean value) Sets the parameter attribute of the AbstractCollectionRenderer object
java.lang.Integer	setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, int value) Sets the parameter attribute of the AbstractCollectionRenderer object
java.lang.Object	setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.Object value) Sets the parameter attribute of the AbstractCollectionRenderer object
java.lang.String	setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, java.lang.String value) Sets the parameter attribute of the AbstractCollectionRenderer object
com.sapportals.htmlb.enum.TextViewDesign	setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key, com.sapportals.htmlb.enum.TextViewDesign value) Sets the parameter attribute of the AbstractCollectionRenderer object
void	setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters parameters) Sets the parameters attribute of the AbstractCollectionRenderer object
void	setParentCollection(ICollection parent) Sets the parentCollection attribute of the AbstractCollectionRenderer object
void	setPropertyNames(IPropertyNameList nameList) Sets the propertyNames attribute of the AbstractCollectionRenderer object
void	setProxy(IProxy proxy) Sets the proxy attribute of the AbstractCollectionRenderer object
void	setResourceList(IResourceList list) Sets the resourceList attribute of the AbstractCollectionRenderer object
void	setResourceListID(java.lang.String value)
void	setSelectedElementsExist(boolean flag) Sets the selectedElementsExist attribute of the AbstractCollectionRenderer object
void	setSelectedResourcesMapID(java.lang.String id)
void	setSortField(java.lang.String sortField) Sets the sortField attribute of the AbstractCollectionRenderer object
void	setSortOrder(int sortOrder) Sets the sortOrder attribute of the AbstractCollectionRenderer object
void	setStartRow(int value) Sets the startRow attribute of the AbstractCollectionRenderer object
void	setSupportedParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] impKeys) Sets the supportedParameters attribute of the AbstractCollectionRenderer object
void	setTypedResourceList(ITypedResourceList typedresourcelist) Sets the typedResourceList attribute of the AbstractCollectionRenderer object
void	setUserDefinedFilterID(java.lang.String value) Sets the userDefinedFilterID attribute of the AbstractCollectionRenderer object
protected void	sortResourceList()
protected void	writeDebugInformation()

Methods inherited from interface com.sapportals.wcm.rendering.collection.ICollectionRenderer

getID, getResourceContext, readInputData, setResourceContext, setSortDefinition

Methods inherited from interface com.sapportals.wcm.rendering.base.ILayoutObject

getNewInstance

Methods inherited from interface com.sapportals.wcm.rendering.base.IDelegatedReceiver

onEvent

Methods inherited from interface com.sapportals.wcm.rendering.base.IResourceListProvider

getID

Field Detail

RES_SORT_ASCENDING

public static final java.lang.String RES_SORT_ASCENDING

RES_SORT_DESCENDING

public static final java.lang.String RES_SORT_DESCENDING

RES_CONTENTSOF

public static final java.lang.String RES_CONTENTSOF

RES_FILESOF

public static final java.lang.String RES_FILESOF

RES_FOLDERSOF

public static final java.lang.String RES_FOLDERSOF

RES_SORTBY

public static final java.lang.String RES_SORTBY

RES_SORTDESCENDING

public static final java.lang.String RES_SORTDESCENDING

RES_SORTASCENDING

public static final java.lang.String RES_SORTASCENDING

RES_SELECTRESOURCE

public static final java.lang.String RES_SELECTRESOURCE

RES_SELECTIONLOST

public static final java.lang.String RES_SELECTIONLOST

RES_EDIT

public static final java.lang.String RES_EDIT

BASE_BUNDLE

public static final java.lang.String BASE_BUNDLE

ON_SELECT_SORT

public static final java.lang.String ON_SELECT_SORT

ON_TOGGLE_SORT

public static final java.lang.String ON_TOGGLE_SORT

ON_SELECT_FILTER

public static final java.lang.String ON_SELECT_FILTER

ON_TOGGLE_FILTER

public static final java.lang.String ON_TOGGLE_FILTER

ON_NAVIGATE

public static final java.lang.String ON_NAVIGATE

COMMA

public static final java.lang.String COMMA

PIXEL

public static final java.lang.String PIXEL

NBSP

public static final java.lang.String NBSP

BLANK

public static final java.lang.String BLANK

CM_RND_ACTION

public static final java.lang.String CM_RND_ACTION

CM_RND_DISPLAYNAME

public static final java.lang.String CM_RND_DISPLAYNAME

CM_RND_ICON

public static final java.lang.String CM_RND_ICON

CM_RND_IMAGE

public static final java.lang.String CM_RND_IMAGE

CM_RND_DESCRIPTION

public static final java.lang.String CM_RND_DESCRIPTION

CM_RND_LOCK

public static final java.lang.String CM_RND_LOCK

CM_RND_CHILDCOUNT

public static final java.lang.String CM_RND_CHILDCOUNT

CM_RND_CHILDCOUNT_WITH_BRACKETS

public static final java.lang.String CM_RND_CHILDCOUNT_WITH_BRACKETS

CM_RND_CHILDCOUNT_BOTH

public static final java.lang.String CM_RND_CHILDCOUNT_BOTH

CM_RND_CHILDCOUNT_SUM

public static final java.lang.String CM_RND_CHILDCOUNT_SUM

CM_RND_CHILDCOUNT_FOLDERS

public static final java.lang.String CM_RND_CHILDCOUNT_FOLDERS

CM_RND_CHILDCOUNT_FILES

public static final java.lang.String CM_RND_CHILDCOUNT_FILES

CM_RND_CHILDCOUNT_PROPERTY_NAME

public static final java.lang.String CM_RND_CHILDCOUNT_PROPERTY_NAME

CM_RND_CHILDCOUNT_WITH_BRACKETS_PROPERTY_NAME

public static final java.lang.String CM_RND_CHILDCOUNT_WITH_BRACKETS_PROPERTY_NAME

DEFAULT_PROPERTY_COLUMNS

public static final java.lang.String DEFAULT_PROPERTY_COLUMNS

DEFAULT_SORT_PROPERTY

public static final java.lang.String DEFAULT_SORT_PROPERTY

NO_SORT_PROPERTY

public static final java.lang.String NO_SORT_PROPERTY

DEFAULT_SORT_ORDER

public static final java.lang.String DEFAULT_SORT_ORDER

MANUAL_SORT_ORDER

public static final int MANUAL_SORT_ORDER

Constructor Detail

AbstractCollectionRenderer

public AbstractCollectionRenderer()

Constructor for the AbstractCollectionRenderer object

Method Detail

getLayoutObject

protected LayoutObject getLayoutObject()

setProxy

public final void setProxy(IProxy proxy)

Sets the proxy attribute of the AbstractCollectionRenderer object

Specified by:

setProxy in interface ILayoutObject

Parameters:

proxy - The new proxy value

getProxy

protected final IProxy getProxy()

setFlavor

public final void setFlavor(com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor impFlavor)

Sets the flavor attribute of the AbstractCollectionRenderer object

Specified by:

setFlavor in interface ILayoutObject

Parameters:

impFlavor - The new flavor value

getFlavor

public final com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor getFlavor()

Gets the flavor attribute of the AbstractCollectionRenderer object

Specified by:

getFlavor in interface ILayoutObject

Returns:

The flavor value

setSortOrder

public final void setSortOrder(int sortOrder)

Sets the sortOrder attribute of the AbstractCollectionRenderer object

Parameters:

sortOrder - The new sortOrder value

getSortOrder

public final int getSortOrder()

Gets the sortOrder attribute of the AbstractCollectionRenderer object

Returns:

The sortOrder value

is508enabled

public final boolean is508enabled()

Description of the Method

Specified by:

is508enabled in interface ILayoutObject

Returns:

Description of the Return Value

set508enabled

protected final void set508enabled(boolean imp508)

getSelectedElementsExist

public final boolean getSelectedElementsExist()

Gets the selectedElementsExist attribute of the AbstractCollectionRenderer object

Returns:

The selectedElementsExist value

setSelectedElementsExist

public final void setSelectedElementsExist(boolean flag)

Sets the selectedElementsExist attribute of the AbstractCollectionRenderer object

Parameters:

flag - The new selectedElementsExist value

getConfiguration

public final java.lang.String getConfiguration(java.lang.String format)

Gets the configuration attribute of the AbstractCollectionRenderer object

Specified by:

getConfiguration in interface ILayoutObject

Parameters:

format - Description of the param

Returns:

The configuration value

setParentCollection

public void setParentCollection(ICollection parent)

Sets the parentCollection attribute of the AbstractCollectionRenderer object

Specified by:

setParentCollection in interface ICollectionRenderer

Parameters:

parent - The new parentCollection value

getParentCollection

public final ICollection getParentCollection()

Gets the parentCollection attribute of the AbstractCollectionRenderer object

Returns:

The parentCollection value

setTypedResourceList

public final void setTypedResourceList(ITypedResourceList typedresourcelist)

Sets the typedResourceList attribute of the AbstractCollectionRenderer object

Specified by:

setTypedResourceList in interface ICollectionRenderer

Parameters:

typedresourcelist - The new typedResourceList value

getSupportedParameters

public final com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] getSupportedParameters()

Gets the supportedParameters attribute of the AbstractCollectionRenderer object

Specified by:

getSupportedParameters in interface ILayoutObject

Returns:

The supportedParameters value

setSupportedParameters

public final void setSupportedParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] impKeys)

Sets the supportedParameters attribute of the AbstractCollectionRenderer object

Parameters:

impKeys - The new supportedParameters value

setStartRow

public final void setStartRow(int value)

Sets the startRow attribute of the AbstractCollectionRenderer object

Parameters:

value - The new startRow value

getStartRow

public final int getStartRow()

Gets the startRow attribute of the AbstractCollectionRenderer object

Returns:

The startRow value

setSortField

public final void setSortField(java.lang.String sortField)

Sets the sortField attribute of the AbstractCollectionRenderer object

Parameters:

sortField - The new sortField value

getSortField

public final java.lang.String getSortField()

Gets the sortField attribute of the AbstractCollectionRenderer object

Returns:

The sortField value

getParameters

public final com.sapportals.wcm.repository.service.layout.customizing.IParameters getParameters()

Gets the parameters attribute of the AbstractCollectionRenderer object

Specified by:

getParameters in interface ILayoutObject

Returns:

The parameters value

getParameters

public com.sapportals.wcm.repository.service.layout.customizing.IParameters getParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] keys)

Gets the parameters attribute of the AbstractCollectionRenderer object

Parameters:

keys - Description of the param

Returns:

The parameters value

resetSelection

public final void resetSelection()

Description of the Method

Specified by:

resetSelection in interface IResourceListProvider

setParameters

public final void setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters parameters)

Sets the parameters attribute of the AbstractCollectionRenderer object

Specified by:

setParameters in interface ILayoutObject

Parameters:

parameters - The new parameters value

setColumnsList

public final void setColumnsList(com.sapportals.wcm.control.util.property.IPropertyColumn[] list)

Sets the columnsList attribute of the AbstractCollectionRenderer object

Parameters:

list - The new columnsList value

getColumnsList

public com.sapportals.wcm.control.util.property.IPropertyColumn[] getColumnsList()

Gets the columnsList attribute of the AbstractCollectionRenderer object

Returns:

The columnsList value

renderEmptyTextView

public static com.sapportals.htmlb.Component renderEmptyTextView()

Description of the Method

Returns:

Description of the Return Value

renderInfoNoResourcesAvailable

protected com.sapportals.htmlb.Component renderInfoNoResourcesAvailable()
                                                                 throws com.sapportals.wdf.WdfException

renderBreadcrumb

public final com.sapportals.htmlb.Component renderBreadcrumb()
                                                      throws com.sapportals.wdf.WdfException

Description of the Method

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderSorter

public final com.sapportals.htmlb.Component renderSorter()
                                                  throws com.sapportals.wdf.WdfException

Description of the Method

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderFilter

public com.sapportals.htmlb.Component renderFilter()
                                            throws com.sapportals.wdf.WdfException

Description of the Method

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderPager

public final com.sapportals.htmlb.Component renderPager(boolean hasMore,
                                                        int pageInterval,
                                                        int linkCount)
                                                 throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

hasMore - Description of the param

pageInterval - Description of the param

linkCount - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

onSelectSort

public final com.sapportals.wdf.event.WdfEvent onSelectSort(com.sapportals.htmlb.event.Event event)

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onSort

public final com.sapportals.wdf.event.WdfEvent onSort(com.sapportals.htmlb.event.Event event)

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onToggleSort

public final com.sapportals.wdf.event.WdfEvent onToggleSort(com.sapportals.htmlb.event.Event event)

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onSelectFilter

public com.sapportals.wdf.event.WdfEvent onSelectFilter(com.sapportals.htmlb.event.Event event)

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onToggleFilter

public com.sapportals.wdf.event.WdfEvent onToggleFilter(com.sapportals.htmlb.event.Event event)

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

onNavigate

public final com.sapportals.wdf.event.WdfEvent onNavigate(com.sapportals.htmlb.event.Event event)

Description of the Method

Parameters:

event - Description of the param

Returns:

Description of the Return Value

getPropertyMap

protected java.util.HashMap getPropertyMap()

initialize

protected final void initialize()

persistSelectedResourcesMap

public final void persistSelectedResourcesMap()

Description of the Method

renderCheckbox

public final com.sapportals.htmlb.Checkbox renderCheckbox(IResource res)
                                                   throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

res - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderCheckbox

public final com.sapportals.htmlb.Checkbox renderCheckbox(IResource res,
                                                          java.lang.String selectionmode)
                                                   throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

res - Description of the param

selectionmode - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderItemSelectionMode

public final com.sapportals.htmlb.Component renderItemSelectionMode(IResource res)
                                                             throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

res - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderFolderTitle

public com.sapportals.htmlb.Component renderFolderTitle()
                                                 throws WcmException,
                                                        com.sapportals.wdf.WdfException

Description of the Method

Returns:

Description of the Return Value

Throws:

WcmException - Exception raised in failure situation

WdfException - Exception raised in failure situation

getSelectedResources

public final IResourceList getSelectedResources()

Gets the selectedResources attribute of the AbstractCollectionRenderer object

Specified by:

getSelectedResources in interface IResourceListProvider

Returns:

The selectedResources value

readInputData

protected void readInputData()
                      throws com.sapportals.wdf.WdfException

setUserDefinedFilterID

public void setUserDefinedFilterID(java.lang.String value)

Sets the userDefinedFilterID attribute of the AbstractCollectionRenderer object

Parameters:

value - The new userDefinedFilterID value

getUserDefinedFilterID

public java.lang.String getUserDefinedFilterID()

Gets the userDefinedFilterID attribute of the AbstractCollectionRenderer object

Returns:

The userDefinedFilterID value

setResourceList

public final void setResourceList(IResourceList list)

Sets the resourceList attribute of the AbstractCollectionRenderer object

Parameters:

list - The new resourceList value

getResourceList

public final IResourceList getResourceList()

Gets the resourceList attribute of the AbstractCollectionRenderer object

Returns:

The resourceList value

render

public final com.sapportals.htmlb.Component render()
                                            throws com.sapportals.wdf.WdfException

Description of the Method

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderAll

public com.sapportals.htmlb.Component renderAll()
                                         throws WcmException

Specified by:

renderAll in interface ICollectionRenderer

Following copied from interface: com.sapportals.wcm.rendering.collection.ICollectionRenderer

Returns:

Component an htmlb-Component that will be displayed. The calling class can include this component in another htmlb-Component.

renderAction

public com.sapportals.htmlb.Component renderAction(IResource res,
                                                   com.sapportals.wcm.repository.service.layout.customizing.IParameterName parameterName)
                                            throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

res - Description of the param

parameterName - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderUI

public abstract com.sapportals.htmlb.Component renderUI()
                                                 throws com.sapportals.wdf.WdfException

Description of the Method

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

getPropertyNames

public final IPropertyNameList getPropertyNames()

Gets the propertyNames attribute of the AbstractCollectionRenderer object

Returns:

The propertyNames value

setPropertyNames

public void setPropertyNames(IPropertyNameList nameList)

Sets the propertyNames attribute of the AbstractCollectionRenderer object

Parameters:

nameList - The new propertyNames value

readCheckBoxes

public final void readCheckBoxes()
                          throws com.sapportals.wdf.WdfException,
                                 WcmException

Description of the Method

Throws:

WdfException - Exception raised in failure situation

WcmException - Exception raised in failure situation

filterResourceList

protected final void filterResourceList()
                                 throws WcmException

getSortPropertyName

protected IPropertyName getSortPropertyName()

sortResourceList

protected final void sortResourceList()
                               throws WcmException

getRenderer

protected final IResourceRenderer getRenderer(IResource res)
                                       throws WcmException

getIntValue

protected final int getIntValue(java.lang.String key,
                                int defValue)

getIntValue

protected final int getIntValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                int defValue)

writeDebugInformation

protected final void writeDebugInformation()

setParameter

public final java.lang.String setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                           java.lang.String value)

Sets the parameter attribute of the AbstractCollectionRenderer object

Specified by:

setParameter in interface ILayoutObject

Parameters:

key - The new parameter value

value - The new parameter value

Returns:

Description of the Return Value

setParameter

public final java.lang.Integer setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                            int value)

Sets the parameter attribute of the AbstractCollectionRenderer object

Parameters:

key - The new parameter value

value - The new parameter value

Returns:

Description of the Return Value

setParameter

public final com.sapportals.htmlb.enum.TextViewDesign setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                                                   com.sapportals.htmlb.enum.TextViewDesign value)

Sets the parameter attribute of the AbstractCollectionRenderer object

Parameters:

key - The new parameter value

value - The new parameter value

Returns:

Description of the Return Value

setParameter

public final java.lang.Boolean setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                            boolean value)

Sets the parameter attribute of the AbstractCollectionRenderer object

Parameters:

key - The new parameter value

value - The new parameter value

Returns:

Description of the Return Value

get

public final java.lang.Object get(java.lang.String key)

Description of the Method

Parameters:

key - Description of the param

Returns:

Description of the Return Value

parameterNames

public final com.sapportals.wcm.repository.service.layout.customizing.IParameterNameSet parameterNames()

Description of the Method

Returns:

Description of the Return Value

parameters

public final java.util.Set parameters()

Description of the Method

Returns:

Description of the Return Value

setParameter

public final java.lang.Object setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                           java.lang.Object value)

Sets the parameter attribute of the AbstractCollectionRenderer object

Parameters:

key - The new parameter value

value - The new parameter value

Returns:

Description of the Return Value

getMultiValueParameter

public final java.util.List getMultiValueParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)

Gets the multiValueParameter attribute of the AbstractCollectionRenderer object

Parameters:

key - Description of the param

Returns:

The multiValueParameter value

getParameter

public final java.lang.String getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)

Gets the parameter attribute of the AbstractCollectionRenderer object

Specified by:

getParameter in interface ILayoutObject

Parameters:

key - Description of the param

Returns:

The parameter value

getParameter

public final java.lang.String getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                           java.lang.String defaultValue)

Gets the parameter attribute of the AbstractCollectionRenderer object

Parameters:

key - Description of the param

defaultValue - Description of the param

Returns:

The parameter value

getParameter

public final int getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                              int defaultValue)

Gets the parameter attribute of the AbstractCollectionRenderer object

Parameters:

key - Description of the param

defaultValue - Description of the param

Returns:

The parameter value

getParameter

public final boolean getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                  boolean defaultValue)

Gets the parameter attribute of the AbstractCollectionRenderer object

Parameters:

key - Description of the param

defaultValue - Description of the param

Returns:

The parameter value

getParameter

public final com.sapportals.htmlb.enum.TextViewDesign getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                                                   com.sapportals.htmlb.enum.TextViewDesign defaultValue)

Gets the parameter attribute of the AbstractCollectionRenderer object

Parameters:

key - Description of the param

defaultValue - Description of the param

Returns:

The parameter value

isNoOtherValue

public final boolean isNoOtherValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                    java.lang.Object checkValue)

Gets the noOtherValue attribute of the AbstractCollectionRenderer object

Parameters:

key - Description of the param

checkValue - Description of the param

Returns:

The noOtherValue value

isExactlyValue

public final boolean isExactlyValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
                                    java.lang.Object checkValue)

Gets the exactlyValue attribute of the AbstractCollectionRenderer object

Parameters:

key - Description of the param

checkValue - Description of the param

Returns:

The exactlyValue value

removeParameter

public void removeParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)

Description of the Method

Parameters:

key - Description of the param

receive

public void receive(com.sapportals.wdf.event.WdfEvent cflEvent)
             throws com.sapportals.wdf.WdfException

CflEventReceiver

Parameters:

cflEvent - Description of the param

Throws:

WdfException - Exception raised in failure situation

getMaxLength

protected int getMaxLength(java.lang.String[] defaultModifiers)

renderPropertyColumn

public com.sapportals.htmlb.Component renderPropertyColumn(IResource resource,
                                                           com.sapportals.wcm.control.util.property.IPropertyColumn propertyColumn,
                                                           boolean useSecondaryStyle)
                                                    throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

resource - Description of the param

propertyColumn - Description of the param

useSecondaryStyle - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderPropertyColumn

public com.sapportals.htmlb.Component renderPropertyColumn(IResourceRenderer renderer,
                                                           IResource resource,
                                                           com.sapportals.wcm.control.util.property.IPropertyColumn propertyColumn,
                                                           boolean useSecondaryStyle)
                                                    throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

resource - Description of the param

propertyColumn - Description of the param

useSecondaryStyle - Description of the Parameter

renderer - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

renderMetaProperty

public com.sapportals.htmlb.Component renderMetaProperty(IResourceRenderer renderer,
                                                         IMetaName metaName,
                                                         boolean hasContentLink,
                                                         boolean useSecondaryStyle)
                                                  throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

metaName - Description of the param

hasContentLink - Description of the param

useSecondaryStyle - Description of the Parameter

renderer - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

getColumnSpacing

public java.lang.String getColumnSpacing()

Gets the columnSpacing attribute of the AbstractCollectionRenderer object

Returns:

The columnSpacing value

modifierListContains

public boolean modifierListContains(com.sapportals.wcm.control.util.property.IPropertyColumn propertyColumn,
                                    java.lang.String propertyModifierName)
                             throws com.sapportals.wdf.WdfException

Description of the Method

Parameters:

propertyColumn - Description of the param

propertyModifierName - Description of the param

Returns:

Description of the Return Value

Throws:

WdfException - Exception raised in failure situation

getRowSpacing

public java.lang.String getRowSpacing()

Gets the rowSpacing attribute of the AbstractCollectionRenderer object

Returns:

The rowSpacing value

getPropertyConfigurationService

public IPropertyConfigurationService getPropertyConfigurationService()

Gets the propertyConfigurationService attribute of the AbstractCollectionRenderer object

Returns:

The propertyConfigurationService value

getAlias

public final java.lang.String getAlias()

implementation of the ILayoutObject-interface ************

Specified by:

getAlias in interface ILayoutObject

Returns:

The alias value

setAlias

public final void setAlias(java.lang.String alias)

Sets the alias attribute of the AbstractCollectionRenderer object

Specified by:

setAlias in interface ILayoutObject

Parameters:

alias - The new alias value

initNewInstance

protected final ICollectionRenderer initNewInstance(ICollectionRenderer cr)

end of implementation of the ILayoutObject-interface **********

Parameters:

cr - Description of the Parameter

Returns:

Description of the Return Value

checkReadPermission

protected void checkReadPermission()

refresh

public void refresh()

Description copied from interface: ICollectionRenderer

asks the implementing class to refresh its list of IResource objects. This is needed, if a list that is displayed by this is modified after this has created its internal representation of these resources. This call is only useful, if the setParentCollection or setTypedResourceList method has been invoked in advance. This method can be very expensive, depending on the size of the resource list and the ordering and filtering calls that have to be carried out. In a standard scenario, this call is not needed, as the IProxyControl will refresh automatically all resource-list representations that use the proxy as persistence-layer. Implementations such as the AbstractCollectionRenderer may not react on this method at all, as they do not persist their resource list representations and therefore always have an up-to-date representation.

Specified by:

refresh in interface ICollectionRenderer

getSelectedResourcesMapID

public final java.lang.String getSelectedResourcesMapID()

setSelectedResourcesMapID

public final void setSelectedResourcesMapID(java.lang.String id)

setColumnsListID

public final void setColumnsListID(java.lang.String value)

getColumnsListID

public final java.lang.String getColumnsListID()

setResourceListID

public final void setResourceListID(java.lang.String value)

getResourceListID

public final java.lang.String getResourceListID()