com.sapportals.wcm.control.navigation

Class ResourceTreeControl

java.lang.Object
  com.sapportals.wdf.stack.Control
      com.sapportals.wcm.control.base.WcmBaseControl
          com.sapportals.wcm.control.base.WcmResourceControl
              com.sapportals.wcm.control.navigation.ResourceTreeControlInternal
                  com.sapportals.wcm.control.navigation.ResourceTreeControl

All Implemented Interfaces:

IPersistenceProvider, com.sapportals.wdf.event.WdfEventReceiver

public class ResourceTreeControl
extends ResourceTreeControlInternal
implements com.sapportals.wdf.event.WdfEventReceiver, IPersistenceProvider

A TreeControl displays the subfolders of a resource collection up to a certain depth in a treeview like manner.

Nested Class Summary

Nested classes/interfaces inherited from class com.sapportals.wcm.control.base.WcmResourceControl

WcmResourceControl.ResourceNotFoundException

Field Summary

static String	VALUE_STATUS_ABORT
static String	VALUE_STATUS_ERROR
static String	VALUE_STATUS_OK
static String	VALUE_STATUS_WARNING

Fields inherited from class com.sapportals.wcm.control.navigation.ResourceTreeControlInternal

DEFAULT_DISPLAY_HIDDEN_COLLECTIONS, DEFAULT_INITIAL_DISPLAYED_LEVELS, DEFAULT_RESOURCE_DISPLAYNAME_LENGTH, PARAM_ALWAYS_DISPLAY_NODE_EXPANDER, PARAM_COLLECTION_INFO_CLASS, PARAM_DISPLAY_CHILDREN_COUNT_COLLECTIONS, PARAM_DISPLAY_CHILDREN_COUNT_DOCUMENTS, PARAM_DISPLAY_HIDDEN_COLLECTIONS, PARAM_DISPLAY_ONLY_COLLECTIONS, PARAM_DISPLAY_RESOURCE_EXTENSION, PARAM_DISPLAY_RESOURCE_IN_NEW_WINDOW, PARAM_DISPLAY_RESOURCE_TYPE, PARAM_DISPLAY_SCROLLCONTAINER, PARAM_ENABLE_DRAG_AND_DROP, PARAM_FROZEN_URI, PARAM_GROUP_DESIGN, PARAM_HIGHLIGHTED_RESOURCE, PARAM_INITIAL_DISPLAYED_LEVELS, PARAM_MULTIPLE_SELECTION_MODE, PARAM_NEW_ROOT_NODE_ON_RESOURCE_EVENT, PARAM_NODE_COMPONENT_RENDER_CLASS, PARAM_NODE_COMPONENT_RENDER_SUFFIX_CLASS, PARAM_NODE_SELECT_PERMISSION_CLASS, PARAM_NODE_TOOLTIP_CLASS, PARAM_ON_NODE_CLICK_EVENT_CLASS, PARAM_OPEN_COLLECTIONS, PARAM_RESOURCE_DISPLAYNAME_LENGTH, PARAM_RESOURCE_LIST, PARAM_SCROLLCONTAINER_HORIZONTAL_POSITION, PARAM_SCROLLCONTAINER_VERTICAL_POSITION, PARAM_SELECTED_RESOURCES, PARAM_SORT_ORDER_ASCENDING, PARAM_SORT_PROPERTY, PARAM_TITLE, PARAM_TOOLTIPSTYLE, PARAM_VISIBLE_SUBTREE, persistenceProvider, SC_HEIGHT, SC_WIDTH, VALUE_OFF

Fields inherited from class com.sapportals.wcm.control.base.WcmResourceControl

START_PAGE_BROWSE, START_PAGE_DETAILS, uri

Fields inherited from class com.sapportals.wcm.control.base.WcmBaseControl

BLANK_LINK_TARGET, CELL_PADDING_STANDARD, CELL_SPACING_STANDARD, CONTROL_HEADER_STANDARD, DETAILS_CONFIG_FILE, NONE, RES_BUTTON_ADD, RES_BUTTON_APPLY, RES_BUTTON_BACK, RES_BUTTON_CANCEL, RES_BUTTON_CLOSE, RES_BUTTON_LOAD, RES_BUTTON_MORE, RES_BUTTON_OK, RES_BUTTON_REMOVE, RES_BUTTON_SAVE, RES_BUTTON_SELECT, RES_BUTTON_UPDATE, resourceContext, SUMMARY

Fields inherited from class com.sapportals.wdf.stack.Control

id

Constructor Summary

ResourceTreeControl()
Default constructor for dynamic class instantiation.

Method Summary

boolean	addObjectToCache(Object key, Object value, boolean overwrite)
String	getCacheIDPrefix()
String	getCollectionInfoClass()
String	getFrozenURI()
com.sapportals.htmlb.enums.GroupDesign	getGroupDesign()
String	getGroupDesignString()
String	getHighlightedResource()
int	getInitialDisplayedLevels() Get the initial depth of the tree.
Set	getKeySet()
String	getNodeComponentRenderClass()
String	getNodeComponentRenderSuffixClass()
String	getNodeGetToolTipClass()
String	getNodeSelectPermissionClass()
Object	getObjectFromCache(Object key) Elements inside the WdfProxy, e.g.
String	getOnNodeClickEventClass()
IResourceList	getOpenCollections()
protected IPersistenceProvider	getPersistenceProvider()
int	getResourceDisplayNameLength()
IResourceList	getResourceList()
int	getScrollContainerHorizontalPosition()
int	getScrollContainerVerticalPosition()
IResourceList	getSelectedResources()
String	GetSortProperty()
String	getTitle()
String	getTooltipStyle()
String	getUriList()
String	getVisibleSubtree()
boolean	isAlwaysDisplayNodeExpander()
boolean	isDisplayChildrenCountCollections()
boolean	isDisplayChildrenCountDocuments()
boolean	isDisplayHiddenCollections()
boolean	isDisplayOnlyCollections() Check if non-collections are displayed in the tree view.
boolean	isDisplayResourceExtension()
boolean	isDisplayResourceInNewWindow()
boolean	isDisplayResourceType()
boolean	isDisplayScrollContainer()
boolean	isEnableDragAndDrop()
boolean	isMultipleSelectionMode()
boolean	isNewRootNodeOnResourceEvent()
boolean	isSortOrderAscending()
boolean	removeObjectFromCache(Object key) this method is not needed for this kind of caching (html-page-persistence).
void	setAlwaysDisplayNodeExpander(boolean flag)
void	setCollectionInfoClass(String className)
void	setDisplayChildrenCountCollections(boolean flag)
void	setDisplayChildrenCountDocuments(boolean flag)
void	setDisplayHiddenCollections(boolean flag)
void	setDisplayOnlyCollections(boolean flag) Check if non-collections are displayed in the tree view.
void	setDisplayResourceExtension(boolean flag)
void	setDisplayResourceInNewWindow(boolean flag)
void	setDisplayResourceType(boolean flag)
void	setDisplayScrollContainer(boolean flag)
void	setEnableDragAndDrop(boolean flag)
void	setFrozenURI(String uri)
void	setGroupDesign(com.sapportals.htmlb.enums.GroupDesign design)
void	setGroupDesignString(String design)
void	setHighlightedResource(String uri)
void	setInitialDisplayedLevels(int initialDisplayedLevels) Set the initial depth of the tree.
void	setMultipleSelectionMode(boolean flag)
void	setNewRootNodeOnResourceEvent(boolean flag)
void	setNodeComponentRenderClass(String className)
void	setNodeComponentRenderSuffixClass(String className)
void	setNodeGetToolTipClass(String className)
void	setNodeSelectPermissionClass(String className)
void	setOnNodeClickEventClass(String className)
void	setOpenCollections(ResourceList value)
protected void	setPersistenceProvider(IPersistenceProvider provider)
void	setResourceDisplayNameLength(int length)
void	setResourceList(ResourceList resourceList)
void	setScrollContainerHorizontalPosition(int flag)
void	setScrollContainerVerticalPosition(int flag)
void	setSelectedResources(ResourceList value)
void	setSortOrderAscending(boolean flag)
void	setSortProperty(String value)
void	setTitle(String title)
void	setTooltipStyle(String value)
void	setUriList(String data)
void	setVisibleSubtree(String uri)

Methods inherited from class com.sapportals.wcm.control.navigation.ResourceTreeControlInternal

internalGetCollectionInfoClass, internalGetFrozenURI, internalGetGroupDesign, internalGetHighlightedResource, internalGetInitialDisplayedLevels, internalGetNodeComponentRenderClass, internalGetNodeComponentRenderSuffixClass, internalGetNodeGetToolTipClass, internalGetNodeSelectPermissionClass, internalGetOnNodeClickEventClass, internalGetOpenCollections, internalGetResourceContext, internalGetResourceDisplayNameLength, internalGetResourceList, internalGetScrollContainerHorizontalPosition, internalGetScrollContainerVerticalPosition, internalGetSelectedResources, internalGetSortProperty, internalGetTitle, internalGetTooltipStyle, internalGetVisibleSubtree, internalIsAlwaysDisplayNodeExpander, internalIsDisplayChildrenCountCollections, internalIsDisplayChildrenCountDocuments, internalIsDisplayHiddenCollections, internalIsDisplayOnlyCollections, internalIsDisplayResourceExtension, internalIsDisplayResourceInNewWindow, internalIsDisplayResourceType, internalIsDisplayScrollContainer, internalIsEnableDragAndDrop, internalIsMultipleSelectionMode, internalIsNewRootNodeOnResourceEvent, internalIsSortOrderAscending, internalSetAlwaysDisplayNodeExpander, internalSetCollectionInfoClass, internalSetCollectionInfoClass, internalSetDisplayChildrenCountCollections, internalSetDisplayChildrenCountDocuments, internalSetDisplayHiddenCollections, internalSetDisplayOnlyCollections, internalSetDisplayResourceExtension, internalSetDisplayResourceInNewWindow, internalSetDisplayResourceType, internalSetDisplayScrollContainer, internalSetEnableDragAndDrop, internalSetFrozenURI, internalSetGroupDesign, internalSetHighlightedResource, internalSetInitialDisplayedLevels, internalSetMultipleSelectionMode, internalSetNewRootNodeOnResourceEvent, internalSetNodeComponentRenderClass, internalSetNodeComponentRenderSuffixClass, internalSetNodeGetToolTipClass, internalSetNodeSelectPermissionClass, internalSetOnNodeClickEventClass, internalSetOpenCollections, internalSetResourceDisplayNameLength, internalSetResourceList, internalSetScrollContainerHorizontalPosition, internalSetScrollContainerVerticalPosition, internalSetSelectedResources, internalSetSortOrderAscending, internalSetSortProperty, internalSetTitle, internalSetTooltipStyle, internalSetVisibleSubtree, onDropTarget, onNodeClick, onNodeExpand, onRefresh, readInputData, receive, render, renderNodeComponent

Methods inherited from class com.sapportals.wcm.control.base.WcmResourceControl

checkArchivingStauts, getAOStates, getDetailsPageUri, getResource, getResourceLink, getSafeResource, getUri, setResource, setUri

Methods inherited from class com.sapportals.wcm.control.base.WcmBaseControl

getBaseBundleString, getBaseBundleString, getBaseBundleString, getBaseBundleString, getBundleString, getBundleString, getBundleString, getBundleString, getBusinessCardLink, getImage, getParameterConfiguration, getResourceContext, getServicePageUri, handleException, isSection508Rendering, isTestMode, isVisible, setControlContext, setResourceContext, setTestMode, setVisible

Methods inherited from class com.sapportals.wdf.stack.Control

create, create, createNestedControls, createUnequivocallyComponentId, dispatchHtmlbEvent, dispatchWdfEvent, getControlContext, getDynPage, getID, getParent, getPersistenceComponentManager, getRootControl, getStackId, initialize, initializeImpl, isInitialized, register, renderPersistentProperties, resetNestedControls, restorePersistentProperties, restoreProperties, setID, setInitialized, setParent, setStackId, triggerInput

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sapportals.wdf.event.WdfEventReceiver

receive

Field Detail

VALUE_STATUS_OK

public static final String VALUE_STATUS_OK

See Also:

Constant Field Values

VALUE_STATUS_WARNING

public static final String VALUE_STATUS_WARNING

See Also:

Constant Field Values

VALUE_STATUS_ERROR

public static final String VALUE_STATUS_ERROR

See Also:

Constant Field Values

VALUE_STATUS_ABORT

public static final String VALUE_STATUS_ABORT

See Also:

Constant Field Values

Constructor Detail

ResourceTreeControl

public ResourceTreeControl()

Default constructor for dynamic class instantiation. You should not use this contructor inside your application.

Method Detail

getObjectFromCache

public Object getObjectFromCache(Object key)

Elements inside the WdfProxy, e.g. IResourceRenderer that cannot use the WDF persistence service, can use this method and addObjectToCache to store elements in the cache and to persist them through the http-request cycle. Please note, that it's the calling object's responsibility to ensure the uniqueness of its keys.

Specified by:

getObjectFromCache in interface IPersistenceProvider

Parameters:

key - the key to the object in the Cache

Returns:

the object that belongs to this key or null, if this key is not known in the cache.

removeObjectFromCache

public boolean removeObjectFromCache(Object key)

this method is not needed for this kind of caching (html-page-persistence). It is only implemented to adhere to the interface.

Specified by:

removeObjectFromCache in interface IPersistenceProvider

Returns:

true, if an entry was found and removed

addObjectToCache

public boolean addObjectToCache(Object key,
                                Object value,
                                boolean overwrite)

Specified by:

addObjectToCache in interface IPersistenceProvider

Parameters:

key - the key to store and retrieve the stored object with

value - the value to store

overwrite - flag, to decide, if an existing key-value pair should be replaced with the given set. Please see getObjectFromCache for further information about this method

Returns:

false, if the entry already exists and the parameter overwrite was set to false

setInitialDisplayedLevels

public void setInitialDisplayedLevels(int initialDisplayedLevels)

Set the initial depth of the tree.

Parameters:

initialDisplayedLevels - The initial depth

getInitialDisplayedLevels

public int getInitialDisplayedLevels()

Get the initial depth of the tree.

Returns:

The initial depth

setResourceDisplayNameLength

public void setResourceDisplayNameLength(int length)

getResourceDisplayNameLength

public int getResourceDisplayNameLength()

setNewRootNodeOnResourceEvent

public void setNewRootNodeOnResourceEvent(boolean flag)

isNewRootNodeOnResourceEvent

public boolean isNewRootNodeOnResourceEvent()

setAlwaysDisplayNodeExpander

public void setAlwaysDisplayNodeExpander(boolean flag)

isAlwaysDisplayNodeExpander

public boolean isAlwaysDisplayNodeExpander()

setEnableDragAndDrop

public void setEnableDragAndDrop(boolean flag)

isEnableDragAndDrop

public boolean isEnableDragAndDrop()

isDisplayOnlyCollections

public boolean isDisplayOnlyCollections()

Check if non-collections are displayed in the tree view.

Returns:

true if documents are displayed in the tree.

setDisplayOnlyCollections

public void setDisplayOnlyCollections(boolean flag)

Check if non-collections are displayed in the tree view.

isMultipleSelectionMode

public boolean isMultipleSelectionMode()

setMultipleSelectionMode

public void setMultipleSelectionMode(boolean flag)

isDisplayHiddenCollections

public boolean isDisplayHiddenCollections()

setDisplayHiddenCollections

public void setDisplayHiddenCollections(boolean flag)

isDisplayResourceType

public boolean isDisplayResourceType()

setDisplayResourceType

public void setDisplayResourceType(boolean flag)

isDisplayResourceExtension

public boolean isDisplayResourceExtension()

setDisplayResourceExtension

public void setDisplayResourceExtension(boolean flag)

setDisplayChildrenCountDocuments

public void setDisplayChildrenCountDocuments(boolean flag)

isDisplayChildrenCountDocuments

public boolean isDisplayChildrenCountDocuments()

setDisplayChildrenCountCollections

public void setDisplayChildrenCountCollections(boolean flag)

isDisplayChildrenCountCollections

public boolean isDisplayChildrenCountCollections()

isDisplayResourceInNewWindow

public boolean isDisplayResourceInNewWindow()

setDisplayResourceInNewWindow

public void setDisplayResourceInNewWindow(boolean flag)

setResourceList

public void setResourceList(ResourceList resourceList)

getResourceList

public IResourceList getResourceList()

Overrides:

getResourceList in class WcmResourceControl

setHighlightedResource

public void setHighlightedResource(String uri)

getHighlightedResource

public String getHighlightedResource()

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

setOnNodeClickEventClass

public void setOnNodeClickEventClass(String className)

getOnNodeClickEventClass

public String getOnNodeClickEventClass()

setNodeComponentRenderClass

public void setNodeComponentRenderClass(String className)

getNodeComponentRenderClass

public String getNodeComponentRenderClass()

setNodeGetToolTipClass

public void setNodeGetToolTipClass(String className)

getNodeGetToolTipClass

public String getNodeGetToolTipClass()

setNodeSelectPermissionClass

public void setNodeSelectPermissionClass(String className)

getNodeSelectPermissionClass

public String getNodeSelectPermissionClass()

setNodeComponentRenderSuffixClass

public void setNodeComponentRenderSuffixClass(String className)

getNodeComponentRenderSuffixClass

public String getNodeComponentRenderSuffixClass()

setCollectionInfoClass

public void setCollectionInfoClass(String className)

getCollectionInfoClass

public String getCollectionInfoClass()

setFrozenURI

public void setFrozenURI(String uri)

getFrozenURI

public String getFrozenURI()

setVisibleSubtree

public void setVisibleSubtree(String uri)

getVisibleSubtree

public String getVisibleSubtree()

setTooltipStyle

public void setTooltipStyle(String value)

getTooltipStyle

public String getTooltipStyle()

setSortProperty

public void setSortProperty(String value)

GetSortProperty

public String GetSortProperty()

isSortOrderAscending

public boolean isSortOrderAscending()

setSortOrderAscending

public void setSortOrderAscending(boolean flag)

isDisplayScrollContainer

public boolean isDisplayScrollContainer()

setDisplayScrollContainer

public void setDisplayScrollContainer(boolean flag)

getScrollContainerHorizontalPosition

public int getScrollContainerHorizontalPosition()

setScrollContainerHorizontalPosition

public void setScrollContainerHorizontalPosition(int flag)

getScrollContainerVerticalPosition

public int getScrollContainerVerticalPosition()

setScrollContainerVerticalPosition

public void setScrollContainerVerticalPosition(int flag)

setUriList

public void setUriList(String data)

getUriList

public String getUriList()

setGroupDesign

public void setGroupDesign(com.sapportals.htmlb.enums.GroupDesign design)

getGroupDesign

public com.sapportals.htmlb.enums.GroupDesign getGroupDesign()

setGroupDesignString

public void setGroupDesignString(String design)

getGroupDesignString

public String getGroupDesignString()

setPersistenceProvider

protected void setPersistenceProvider(IPersistenceProvider provider)

Overrides:

setPersistenceProvider in class ResourceTreeControlInternal

getPersistenceProvider

protected IPersistenceProvider getPersistenceProvider()

Overrides:

getPersistenceProvider in class ResourceTreeControlInternal

setSelectedResources

public void setSelectedResources(ResourceList value)

getSelectedResources

public IResourceList getSelectedResources()

setOpenCollections

public void setOpenCollections(ResourceList value)

getOpenCollections

public IResourceList getOpenCollections()

getCacheIDPrefix

public String getCacheIDPrefix()

getKeySet

public Set getKeySet()

Specified by:

getKeySet in interface IPersistenceProvider

Returns:

a Set with all keys or an empty Set, never null

Access Rights

This class can be accessed from:

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