com.sapportals.wcm.rendering.collection

Class LightCollectionRenderer

java.lang.Object
  com.sapportals.wcm.rendering.collection.LightCollectionRenderer

All Implemented Interfaces:

ICollectionRenderer, ICollectionRendererParameterNameConst, IDelegatedReceiver, ILayoutObject, IParameters, IResourceListProvider, com.sapportals.wcm.control.base.IUniqueIDSupplier

public abstract class LightCollectionRenderer

extends Object

implements ICollectionRenderer, ICollectionRendererParameterNameConst, IResourceListProvider, IParameters, com.sapportals.wcm.control.base.IUniqueIDSupplier

Field Summary

static String	BASE_BUNDLE
static String	CM_RND_ACTION
static String	CM_RND_CHILDCOUNT
static String	CM_RND_CHILDCOUNT_BOTH
static String	CM_RND_CHILDCOUNT_FILES
static String	CM_RND_CHILDCOUNT_FOLDERS
static String	CM_RND_CHILDCOUNT_PROPERTY_NAME
static String	CM_RND_CHILDCOUNT_SUM
static String	CM_RND_CHILDCOUNT_WITH_BRACKETS
static String	CM_RND_CHILDCOUNT_WITH_BRACKETS_PROPERTY_NAME
static String	CM_RND_DESCRIPTION
static String	CM_RND_DISPLAYNAME
static String	CM_RND_ICON
static String	CM_RND_IMAGE
static String	CM_RND_LOCK
static String	DEFAULT_PROPERTY_COLUMNS
protected int	linksForPager
static String	NBSP
static String	RES_CONTENTSOF
static String	RES_SORT_ASCENDING
static String	RES_SORT_DESCENDING

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

Fields inherited from interface com.sapportals.wcm.repository.service.layout.customizing.ICollectionRendererParameterNameConst

BACKGROUNDIMAGEPATH, BACKGROUNDIMAGESTYLE, BACKGROUNDIMAGESTYLE_MULTIPLE, BACKGROUNDIMAGESTYLE_SINGLE, BREADCRUMBSTYLE, BREADCRUMBSTYLE_BACK, BREADCRUMBSTYLE_DRPODOWN, BREADCRUMBSTYLE_HORIZONTAL, BREADCRUMBSTYLE_OFF, BREADCRUMBSTYLE_VERTICAL, BREADCRUMBVISIBILITYSTYLE, BREADCRUMBVISIBILITYSTYLE_DISABLEROOT, BREADCRUMBVISIBILITYSTYLE_INVISIBLE, BREADCRUMBVISIBILITYSTYLE_INVISIBLEROOT, BREADCRUMBVISIBILITYSTYLE_NOICON, BREADCRUMBVISIBILITYSTYLE_STANDARD, COLLECTION_ACTIONSTYLE, COLLECTION_ACTIONSTYLE_BUTTON, COLLECTION_ACTIONSTYLE_HOVER, COLLECTION_ACTIONSTYLE_LINK, COLLECTION_ACTIONSTYLE_MENU, COLLECTION_ACTIONSTYLE_OFF, COLLECTION_ACTIONSTYLE_SMALLBUTTON, COLLECTION_ACTIONSTYLE_TOOLBAR_BUTTON, COLUMNS, COLUMNSPACING, COLUMNSPACINGSTYLE, COLUMNSPACINGSTYLE_FIXED, COLUMNSPACINGSTYLE_MINIMUM, COMPONENTS, EMPTY_COLLECTION_FILE, EMPTY_COLLECTION_KEY, EMPTY_COLLECTION_STYLE, EMPTY_COLLECTION_STYLE_MESSAGE, EMPTY_COLLECTION_STYLE_OFF, EMPTY_COLLECTION_STYLE_TEXT, FILESELECTIONMODE_MULTIPLE, FILESELECTIONMODE_SINGLE, FILTEREXTENSION, FILTERMIMETYPE, FILTERRESOURCETYPE, FOLDERSELECTIONMODE_MULTIPLE, FOLDERSELECTIONMODE_SINGLE, GRIDORDERSTYLE, GRIDORDERSTYLE_COLUMN_MAJOR, GRIDORDERSTYLE_ROW_MAJOR, GROUP_STYLE, GROUP_STYLE_OFF, GROUP_STYLE_PRIMARYCOLOR, GROUP_STYLE_SAPCOLOR, GROUP_STYLE_SECONDARYBOX, GROUP_STYLE_SECONDARYBOXCOLOR, GROUP_STYLE_SECONDARYCOLOR, HEADER_TEXT_STYLE, HTML_FILENAME, IMAGEMAP, ITEMSELECTIONMODE, ITEMSELECTIONMODE_MULTIPLE, ITEMSELECTIONMODE_OFF, ITEMSELECTIONMODE_SINGLE, LINKSSTYLE, LINKSSTYLE_ALL, LINKSSTYLE_EXTERNAL, LINKSSTYLE_INTERNAL, LINKSSTYLE_OFF, LINKSSTYLE_VISIBLE, MASSACTIONSTYLE, MASSACTIONSTYLE_BUTTON, MASSACTIONSTYLE_HOVER, MASSACTIONSTYLE_ICON, MASSACTIONSTYLE_LINK, MASSACTIONSTYLE_MENU, MASSACTIONSTYLE_OFF, MASSACTIONSTYLE_SMALLBUTTON, MASSACTIONSTYLE_TOOLBAR_BUTTON, MASSACTIONSTYLE_VERTICAL_LINK, MAX_NUM_OF_TABS, NO_OF_CHILD_FOR_NODE, NO_TAB_CONTENT, OPEN_NODES_STYLE, OPEN_NODES_STYLE_All, OPEN_NODES_STYLE_LAST_SELECTED, OPENTARGETTYPE, OPENTARGETTYPE_FIXED, OPENTARGETTYPE_NEW, OPENTARGETTYPE_OFF, OPENTARGETTYPE_SELF, PAGER_LINK_COUNT, PROPERTY_COLUMN_HEADER_STYLE, PROPERTY_COLUMN_HEADER_STYLE_LIST, PROPERTY_COLUMN_HEADER_STYLE_MENUE, PROPERTY_COLUMN_HEADER_STYLE_OFF, PROPERTY_COLUMN_HEADER_STYLE_TABLE, PROPERTY_COLUMN_HEADER_STYLE_TRANSPARENT, PROPERTYCOLUMNS, RESIZEHEIGHTSTYLE, RESIZEHEIGHTSTYLE_COMPACT, RESIZEHEIGHTSTYLE_OFF, RESIZEHEIGHTSTYLE_STRETCH, RESIZEWIDHTSTYLE, RESIZEWIDHTSTYLE_COMPACT, RESIZEWIDHTSTYLE_OFF, RESIZEWIDHTSTYLE_STRETCH, RESOURCE_LIST_FILTER, RESOURCE_LIST_FILTER_DEFAULT, ROWBACKGROUNDSTYLE, ROWS, ROWSPACING, ROWSPACINGSTYLE, ROWSPACINGSTYLE_ALTERNATING, ROWSPACINGSTYLE_BACKGROUND, ROWSPACINGSTYLE_COLUMNALTERNATING, ROWSPACINGSTYLE_COLUMNSEPARATED, ROWSPACINGSTYLE_FIXED, ROWSPACINGSTYLE_LINESEPARATED, ROWSPACINGSTYLE_MINIMUM, ROWSPACINGSTYLE_ROWALTERNATING, ROWSPACINGSTYLE_TRANSPARENT, SHOW_HIDDEN, SHOW_TREE_ROOT_NODE, SHOWFILESSTYLE, SHOWFILESSTYLE_ALL, SHOWFILESSTYLE_NOLINK, SHOWFILESSTYLE_OFF, SHOWFILESTYLE_ONLYLINK, SHOWFOLDERSSTYLE, SHOWFOLDERSSTYLE_ALL, SHOWFOLDERSSTYLE_NOLINK, SHOWFOLDERSSTYLE_OFF, SHOWFOLDERSSTYLE_ONLYLINK, SHOWFOLDERTITLE, SHOWUSERID, SHOWUSERNAME, SORT_ENABLED, SORT_ORDER, SORT_ORDER_ASCENDING, SORT_ORDER_DESCENDING, SORT_PROPERTY, TAB_BODY_FLAVOR, TAB_STYLE_SAFE, UI_COLL_RENDERER, UI_GROUP_COLLECTION, UI_GROUP_MASS, USE_SCROLL_CONTAINER, VERTICAL_ALIGNMENT, VERTICAL_ALIGNMENT_BASELINE, VERTICAL_ALIGNMENT_BOTTOM, VERTICAL_ALIGNMENT_MIDDLE, VERTICAL_ALIGNMENT_TOP

Constructor Summary

LightCollectionRenderer()

Method Summary

protected void	createComponentValueMap()
String	createUniqueID(String idpart)
protected void	filterResourceList()
Object	get(String key) Returns the value to which the specified key is mapped in this parameters set or in the default or in the default parameter set, when not found.
String	getAlias()
BundleHandler	getBundleHandler()
String	getColumnSpacing()
protected ComponentValueMap	getComponentValueMap()
String	getConfiguration(String format) returns the supported parameters and the default values the class uses
protected int	getElementsPerPage()
IFlavor	getFlavor()
String	getID()
protected int	getIntValue(IParameterName key, int defValue)
protected int	getIntValue(String key, int defValue)
protected IRendererStatus	getIRS()
protected LayoutObject	getLayoutObject()
List	getMultiValueParameter(IParameterName key) Searches for the parameter with the specified key.
String	getParameter(IParameterName key) Searches for the parameter with the specified key.
boolean	getParameter(IParameterName key, boolean defaultValue) Searches for the parameter with the specified key.
int	getParameter(IParameterName key, int defaultValue) Searches for the parameter with the specified key.
String	getParameter(IParameterName key, String defaultValue) Searches for the parameter with the specified key.
TextViewDesign	getParameter(IParameterName key, TextViewDesign defaultValue) Searches for the parameter with the specified key.
IParameters	getParameters() returns all parameters used in this layout object.
IParameters	getParameters(IParameterName[] keys)
ICollection	getParentCollection()
IPropertyNameList	getPropertyNames()
protected IProxy	getProxy()
protected IResourceRenderer	getRenderer(IResource res)
IResourceContext	getResourceContext()
protected IResourceList	getResourceList()
protected com.sapportals.wcm.rendering.collection.LightCollectionRenderer.RenderInformationCollector	getRIC()
String	getRowSpacing()
IResourceList	getSelectedResources()
int	getStartRow()
IParameterName[]	getSupportedParameters() returns all parameters which are used in this layout object.
protected ITypedResourceList	getTypedResourceList()
protected ICollectionRenderer	initNewInstance(ICollectionRenderer cr)
boolean	is508enabled()
boolean	isExactlyValue(IParameterName key, Object checkValue) Checks if an entry in the set exists for the specified key, which has the specified value.
boolean	isNoOtherValue(IParameterName key, Object checkValue) Checks for a key if no other value than the specified value is set.
boolean	isVisible()
IRenderingEvent	onEvent(Event event)
IParameterNameSet	parameterNames() Returns an enumeration of all the keys in this parameter set, including the keys in the default parameter set and all included paramters.
Set	parameters() Returns a Set view of the parameters contained in this parameters set.
void	readInputData(DynPage page) reads out the input of the modifiable Components rendered by the implementing class.
void	refresh() asks the implementing class to refresh its list of IResource objects.
void	removeParameter(IParameterName key) removes the parameter specified from the paramters map.
Component	renderAll()
protected Component	renderBreadcrumb()
protected Component	renderDecorations(Component comp)
Component	renderFolderTitle()
Component	renderItemSelectionMode(IResource res)
protected Component	renderPager(boolean hasMore, int pageInterval, int linkCount) creates a new instance of a Pager and returns its results of the render method.
protected Component	renderSearchHeader()
protected Component	renderUI()
void	resetSelection() clears the list of selected resources
void	set508enabled(boolean value)
void	setAlias(String alias)
void	setFlavor(IFlavor impFlavor) is called from the factory after instantiating a new layout object to set the flavor information coming from the Control or ILayoutController , asking for special instances of the IResourceRenderer used by the implementing class
Boolean	setParameter(IParameterName key, boolean value) Calls the map.put(key, value) method.
Integer	setParameter(IParameterName key, int value) Calls the map.put(key, value) method.
Object	setParameter(IParameterName key, Object value)
String	setParameter(IParameterName key, String value) Calls the map.put(key, value) method.
TextViewDesign	setParameter(IParameterName key, TextViewDesign value) Calls the map.put(key, value) method.
void	setParameters(IParameters parameters) is called from the factory after initializing this layout object.
void	setParentCollection(ICollection parent) is called from the factory after instantiating a new collection renderer to set the collection which has to be rendered.
void	setPropertyNames(IPropertyNameList nameList)
void	setProxy(IProxy proxy) it is the renderers responsibility to make itself known to the proxy.
void	setResourceContext(IResourceContext context) sets the context-attribute for the renderer.
void	setSortDefinition(SortDefinition sd) sets the sort-definition attribute for the implementing class.
void	setStartRow(int value)
void	setSupportedParameters(IParameterName[] impKeys)
void	setTypedResourceList(ITypedResourceList typedresourcelist) is called from the factory after instantiating a new collection renderer to set the resourceList which has to be rendered.
protected void	sortResourceList(IPropertyNameList list, SortDefinition sd)
protected void	writeDebugInformation()

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.base.ILayoutObject

getNewInstance

Field Detail

NBSP

public static final String NBSP

See Also:

Constant Field Values

RES_SORT_ASCENDING

public static final String RES_SORT_ASCENDING

See Also:

Constant Field Values

RES_SORT_DESCENDING

public static final String RES_SORT_DESCENDING

See Also:

Constant Field Values

RES_CONTENTSOF

public static final String RES_CONTENTSOF

See Also:

Constant Field Values

BASE_BUNDLE

public static final String BASE_BUNDLE

See Also:

Constant Field Values

CM_RND_ACTION

public static final String CM_RND_ACTION

See Also:

Constant Field Values

CM_RND_DISPLAYNAME

public static final String CM_RND_DISPLAYNAME

See Also:

Constant Field Values

CM_RND_ICON

public static final String CM_RND_ICON

See Also:

Constant Field Values

CM_RND_IMAGE

public static final String CM_RND_IMAGE

See Also:

Constant Field Values

CM_RND_DESCRIPTION

public static final String CM_RND_DESCRIPTION

See Also:

Constant Field Values

CM_RND_LOCK

public static final String CM_RND_LOCK

See Also:

Constant Field Values

CM_RND_CHILDCOUNT

public static final String CM_RND_CHILDCOUNT

See Also:

Constant Field Values

CM_RND_CHILDCOUNT_WITH_BRACKETS

public static final String CM_RND_CHILDCOUNT_WITH_BRACKETS

See Also:

Constant Field Values

CM_RND_CHILDCOUNT_BOTH

public static final String CM_RND_CHILDCOUNT_BOTH

See Also:

Constant Field Values

CM_RND_CHILDCOUNT_SUM

public static final String CM_RND_CHILDCOUNT_SUM

See Also:

Constant Field Values

CM_RND_CHILDCOUNT_FOLDERS

public static final String CM_RND_CHILDCOUNT_FOLDERS

See Also:

Constant Field Values

CM_RND_CHILDCOUNT_FILES

public static final String CM_RND_CHILDCOUNT_FILES

See Also:

Constant Field Values

CM_RND_CHILDCOUNT_PROPERTY_NAME

public static final String CM_RND_CHILDCOUNT_PROPERTY_NAME

See Also:

Constant Field Values

CM_RND_CHILDCOUNT_WITH_BRACKETS_PROPERTY_NAME

public static final String CM_RND_CHILDCOUNT_WITH_BRACKETS_PROPERTY_NAME

See Also:

Constant Field Values

DEFAULT_PROPERTY_COLUMNS

public static final String DEFAULT_PROPERTY_COLUMNS

See Also:

Constant Field Values

linksForPager

protected int linksForPager

Constructor Detail

LightCollectionRenderer

public LightCollectionRenderer()

Method Detail

getRIC

protected com.sapportals.wcm.rendering.collection.LightCollectionRenderer.RenderInformationCollector getRIC()

initNewInstance

protected final ICollectionRenderer initNewInstance(ICollectionRenderer cr)

getAlias

public final String getAlias()

Specified by:

getAlias in interface ILayoutObject

setAlias

public final void setAlias(String alias)

Specified by:

setAlias in interface ILayoutObject

setFlavor

public final void setFlavor(IFlavor impFlavor)

Description copied from interface: ILayoutObject

is called from the factory after instantiating a new layout object to set the flavor information coming from the Control or ILayoutController , asking for special instances of the IResourceRenderer used by the implementing class

Specified by:

setFlavor in interface ILayoutObject

getFlavor

public final IFlavor getFlavor()

Specified by:

getFlavor in interface ILayoutObject

Returns:

the flavor set for the implementing class

is508enabled

public boolean is508enabled()

Specified by:

is508enabled in interface ILayoutObject

Returns:

flag, if this class renders its output in a way that is suited for blind people of people with viewing disabilities

set508enabled

public void set508enabled(boolean value)

setSupportedParameters

public final void setSupportedParameters(IParameterName[] impKeys)

getSupportedParameters

public IParameterName[] getSupportedParameters()

Description copied from interface: ILayoutObject

returns all parameters which are used in this layout object. Only parameters listed here will be set from the factory.

Specified by:

getSupportedParameters in interface ILayoutObject

Returns:

a collection of all parameters that are used in the instance of the implementing class to modify the rendered output.

See Also:

ILayoutObject.setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters)

getConfiguration

public final String getConfiguration(String format)

Description copied from interface: ILayoutObject

returns the supported parameters and the default values the class uses

Specified by:

getConfiguration in interface ILayoutObject

getParameter

public String getParameter(IParameterName key)

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns null if the parameter is not found.

Specified by:

getParameter in interface ILayoutObject

Returns:

the current entry for the given key or null. Note: a returned null does not indicate, that the ILayoutObject does not support this parameter!

getParameters

public IParameters getParameters()

Description copied from interface: ILayoutObject

returns all parameters used in this layout object.

Specified by:

getParameters in interface ILayoutObject

Returns:

the hashtable of all parameters that are supported and set by the implementing class

setParameter

public String setParameter(IParameterName key,
                           String value)

Description copied from interface: IParameters

Calls the map.put(key, value) method. This method is parrallel to the String getParameter(IParameterName key) method.

Specified by:

setParameter in interface ILayoutObject

Parameters:

key - - the key of the parameter

value - - the value of the parameter Overwrites an existing entry of the parameters or adds it, if it is not set. Note: The Layout Object may not act on this parameter. To retrieve a list of supported parameters from an ILayoutObject instance

setParameters

public void setParameters(IParameters parameters)

Description copied from interface: ILayoutObject

is called from the factory after initializing this layout object. Only parameters listed in the IParameterName[] getSupportedParameters() are set by the factory. With this method the rendering of the implementing class can be influenced. Classes can - but do not have to - react on the parameters supplied in this method

Specified by:

setParameters in interface ILayoutObject

Parameters:

parameters - - the parameters retrieved from different sources (iView, OTH...) that influence the way the implementing class renders its output. If the parameter is not found in the class' getSupportedParameters, the value will not be set as parameter for this class. If for a certain key, no value is found in the given IParameters, the default value set in the class will not be overwritten. Example: The class returns as supported parameters the keys "A", "B". It has set the default parameters, so we find the key-value pairs: "A" -> a "B" -> b This method is called, with the following hashtable entries: "A" -> aa "C" -> cc After the method is called, the class holds following key-vlaue pairs: "A" -> aa (overwritten by passed hashtable values) "B" -> b (not overwritten, because the hashtable returned null for this key The key-value pair "C" -> cc is not used in the class, because the key was not found in its getSupportedParameters

setProxy

public final void setProxy(IProxy proxy)

it is the renderers responsibility to make itself known to the proxy. This method must be called only once per instantication of the renderer. The uniqueID set within this method will be used, when the renderer stores its IRendererStatus object within the proxy. When problems with persistence (lost selected resources or exception when reading out the user input) occur, this method and getIRS() should be closely evaluated.

Specified by:

setProxy in interface ILayoutObject

Parameters:

proxy - The new proxy value

getProxy

protected final IProxy getProxy()

isExactlyValue

public final boolean isExactlyValue(IParameterName key,
                                    Object checkValue)

Description copied from interface: IParameters

Checks if an entry in the set exists for the specified key, which has the specified value. The value for the specified key is searched via the Object get(Object key) method an true is returned when a value is found which equals the specified value.

Specified by:

isExactlyValue in interface IParameters

Parameters:

key - the paramters key to search

checkValue - the value to compare with

Returns:

true, if a value is found which equals the specified value

See Also:

get(Object key)

isNoOtherValue

public final boolean isNoOtherValue(IParameterName key,
                                    Object checkValue)

Description copied from interface: IParameters

Checks for a key if no other value than the specified value is set. The value for the specified key is searched via the Object get(Object key) method an true is returned when no value is not found or the found value equals the specified value.

Specified by:

isNoOtherValue in interface IParameters

Parameters:

key - the paramters key to search

checkValue - the value to compare with

Returns:

true, if no entry is found for the specified key or if the found value equals the specified value

See Also:

get(Object key)

getParameter

public final TextViewDesign getParameter(IParameterName key,
                                         TextViewDesign defaultValue)

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found. The value is returned as TextViewDesign . If the stored String can not be converted into a TextViewDesign null is returned.

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters key.

defaultValue - a default value.

Returns:

the value in this parameter set with the specified key value.

getParameter

public final String getParameter(IParameterName key,
                                 String defaultValue)

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found.

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters key.

defaultValue -

Returns:

the value in this parameter set with the specified key value.

getParameter

public final int getParameter(IParameterName key,
                              int defaultValue)

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found. The value is returned as int if possible.

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters key.

defaultValue - a default value.

Returns:

the value in this parameter set with the specified key value.

getParameter

public final boolean getParameter(IParameterName key,
                                  boolean defaultValue)

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns the default value argument if the parameter is not found. The value is returned as boolean . The boolean returned represents the value true if the parameters value is equal, ignoring case, to the string "true" .

Example: Boolean.valueOf("True") returns true .
Example: Boolean.valueOf("yes") returns false .

Specified by:

getParameter in interface IParameters

Parameters:

key - the parameters key.

defaultValue - a default value.

Returns:

the value in this parameter set with the specified key value.

getMultiValueParameter

public final List getMultiValueParameter(IParameterName key)

Description copied from interface: IParameters

Searches for the parameter with the specified key. If the key is not found in this parameter set, the default parameter set, and its defaults, recursively, are then checked. The method returns null if the parameter is not found. The parameter is returned as java.util.List , even if it is a single Value Parameter. The class of the returned objects in the list can be asked via key.getMetaDate().getParameterClass()

Specified by:

getMultiValueParameter in interface IParameters

Parameters:

key - the parameters key.

Returns:

the value in this parameter set with the specified key value.

getParameters

public IParameters getParameters(IParameterName[] keys)

Specified by:

getParameters in interface IParameters

parameters

public final Set parameters()

Description copied from interface: IParameters

Returns a Set view of the parameters contained in this parameters set. Each element in this collection is a Map.Entry. In contrast to method entrySet() this set is not backed up by the map, but it contains all paramters accessible via this Paramters map, this means, all paramters contained in the map, in the default map and in all included parameter sets.

Specified by:

parameters in interface IParameters

Returns:

a set view of the mappings contained in this parameters set.

parameterNames

public final IParameterNameSet parameterNames()

Description copied from interface: IParameters

Returns an enumeration of all the keys in this parameter set, including the keys in the default parameter set and all included paramters.

Specified by:

parameterNames in interface IParameters

Returns:

an enumeration of all the keys in this parameter set, including the keys in the default parameter set.

See Also:

Enumeration

get

public final Object get(String key)

Description copied from interface: IParameters

Returns the value to which the specified key is mapped in this parameters set or in the default or in the default parameter set, when not found.

Specified by:

get in interface IParameters

Parameters:

key - a key of the parameter.

Returns:

the value to which the key is mapped in this parameters set; null if the key is not mapped to any value in this parameters set or in the default.

See Also:

#put(Object, Object)

removeParameter

public void removeParameter(IParameterName key)

Description copied from interface: IParameters

removes the parameter specified from the paramters map. Only the first level map is considered. The paramter is not removed from any default map.

Specified by:

removeParameter in interface IParameters

setParameter

public final Boolean setParameter(IParameterName key,
                                  boolean value)

Description copied from interface: IParameters

Calls the map.put(key, value) method. This method is parrallel to the String getParameter(IParameterName key) method. Here an int can be provided. The value will be stored as String .

Specified by:

setParameter in interface IParameters

Parameters:

key - The key for the new Parameter

value - The value for the new Parameter

Returns:

previous value associated with specified key, or null if there was no mapping for key.

setParameter

public final Integer setParameter(IParameterName key,
                                  int value)

Description copied from interface: IParameters

Calls the map.put(key, value) method. This method is parrallel to the String getParameter(IParameterName key) method. Here an int can be provided. The value will be stored as String .

Specified by:

setParameter in interface IParameters

Parameters:

key - The key for the new Parameter

value - The value for the new Parameter

Returns:

previous value associated with specified key, or null if there was no mapping for key.

setParameter

public final TextViewDesign setParameter(IParameterName key,
                                         TextViewDesign value)

Description copied from interface: IParameters

Calls the map.put(key, value) method. This method is parrallel to the String getParameter(IParameterName key) method. Here an TextViewDesign can be provided. The value will be stored as String .

Specified by:

setParameter in interface IParameters

Parameters:

key - The key for the new Parameter

value - The value for the new Parameter

Returns:

previous value associated with specified key, or null if there was no mapping for key.

setParameter

public final Object setParameter(IParameterName key,
                                 Object value)

Specified by:

setParameter in interface IParameters

getIntValue

protected final int getIntValue(String key,
                                int defValue)

getIntValue

protected final int getIntValue(IParameterName key,
                                int defValue)

setStartRow

public final void setStartRow(int value)
                       throws WcmException

Throws:

WcmException

getStartRow

public final int getStartRow()
                      throws WcmException

Throws:

WcmException

getPropertyNames

public final IPropertyNameList getPropertyNames()

setPropertyNames

public void setPropertyNames(IPropertyNameList nameList)

getLayoutObject

protected LayoutObject getLayoutObject()

getColumnSpacing

public String getColumnSpacing()

Returns:

The columnSpacing value

getRowSpacing

public String getRowSpacing()

Returns:

The rowSpacing value

renderPager

protected final Component renderPager(boolean hasMore,
                                      int pageInterval,
                                      int linkCount)
                               throws WcmException

creates a new instance of a Pager and returns its results of the render method. The current IProxy object of the renderer is used as target for any Events created by the pager. The pager class is used again in the onEvent method of the renderer.

Parameters:

hasMore - Description of the Parameter

pageInterval - Description of the Parameter

linkCount - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WcmException - Description of the Exception

renderSearchHeader

protected final Component renderSearchHeader()
                                      throws WcmException

Throws:

WcmException

renderFolderTitle

public Component renderFolderTitle()
                            throws WcmException

Throws:

WcmException

renderBreadcrumb

protected final Component renderBreadcrumb()
                                    throws WcmException

Returns:

Description of the Return Value

Throws:

WcmException - Description of the Exception

renderItemSelectionMode

public final Component renderItemSelectionMode(IResource res)
                                        throws WcmException

Throws:

WcmException

writeDebugInformation

protected final void writeDebugInformation()

setParentCollection

public void setParentCollection(ICollection parent)

Description copied from interface: ICollectionRenderer

is called from the factory after instantiating a new collection renderer to set the collection which has to be rendered. Instead of this method, the setTypedResourceList(ITypedResourceList resourcelist) method is called, i.e. when a search result has to be rendered.

Specified by:

setParentCollection in interface ICollectionRenderer

Parameters:

parent - the collection to render (and whose chidren to render)

setTypedResourceList

public final void setTypedResourceList(ITypedResourceList typedresourcelist)

Description copied from interface: ICollectionRenderer

is called from the factory after instantiating a new collection renderer to set the resourceList which has to be rendered. Instead of this method, the setParentCollection(ICollection collection) method is called, i.e. when a folder has to be rendered

Specified by:

setTypedResourceList in interface ICollectionRenderer

Parameters:

typedresourcelist - the resourcelist to render (and whose members to render)

getRenderer

protected final IResourceRenderer getRenderer(IResource res)
                                       throws WcmException

Throws:

WcmException

getParentCollection

public ICollection getParentCollection()

getTypedResourceList

protected ITypedResourceList getTypedResourceList()

renderAll

public Component renderAll()
                    throws WcmException

Specified by:

renderAll in interface ICollectionRenderer

Returns:

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

Throws:

WcmException

renderDecorations

protected Component renderDecorations(Component comp)
                               throws WcmException

Throws:

WcmException

createComponentValueMap

protected void createComponentValueMap()
                                throws WcmException

Throws:

WcmException

getComponentValueMap

protected ComponentValueMap getComponentValueMap()
                                          throws WcmException

Throws:

WcmException

getElementsPerPage

protected int getElementsPerPage()

renderUI

protected Component renderUI()
                      throws WcmException

Throws:

WcmException

filterResourceList

protected final void filterResourceList()
                                 throws WcmException

Throws:

WcmException

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

getIRS

protected IRendererStatus getIRS()
                          throws WcmException

Throws:

WcmException

createUniqueID

public String createUniqueID(String idpart)

Specified by:

createUniqueID in interface com.sapportals.wcm.control.base.IUniqueIDSupplier

readInputData

public void readInputData(DynPage page)
                   throws WcmException

Description copied from interface: ICollectionRenderer

reads out the input of the modifiable Components rendered by the implementing class.

Specified by:

readInputData in interface ICollectionRenderer

Throws:

WcmException

getID

public String getID()

Specified by:

getID in interface ICollectionRenderer

Returns:

the ID of the renderer. The renderer can obtain an ID that will be unique within one browser window by using the return value of IProxy's method register. This ID will be stable over http-requests.

setResourceContext

public void setResourceContext(IResourceContext context)

Description copied from interface: ICollectionRenderer

sets the context-attribute for the renderer. Must not be null

Specified by:

setResourceContext in interface ICollectionRenderer

getResourceContext

public IResourceContext getResourceContext()

Specified by:

getResourceContext in interface ICollectionRenderer

Returns:

the context-attribute of the renderer. Does not return null

getBundleHandler

public BundleHandler getBundleHandler()

onEvent

public IRenderingEvent onEvent(Event event)
                        throws WcmException

Specified by:

onEvent in interface IDelegatedReceiver

Throws:

WcmException

setSortDefinition

public void setSortDefinition(SortDefinition sd)

Description copied from interface: ICollectionRenderer

sets the sort-definition attribute for the implementing class. This definition is used to specify the property the list is sorted by as well as the direction (top-down vs. bottom-up) of the sorting.

Specified by:

setSortDefinition in interface ICollectionRenderer

getSelectedResources

public final IResourceList getSelectedResources()

Specified by:

getSelectedResources in interface IResourceListProvider

Returns:

the list of resources that have been selected (e.g. by marking check boxes on a control) - must not return null

resetSelection

public void resetSelection()

Description copied from interface: IResourceListProvider

clears the list of selected resources

Specified by:

resetSelection in interface IResourceListProvider

getResourceList

protected IResourceList getResourceList()
                                 throws WcmException

Throws:

WcmException

sortResourceList

protected final void sortResourceList(IPropertyNameList list,
                                      SortDefinition sd)
                               throws WcmException

Throws:

WcmException

isVisible

public boolean isVisible()