com.sapportals.wcm.control.navigation

Class ResourceListControl

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.ResourceListControl

All Implemented Interfaces:

com.sapportals.wdf.event.WdfEventReceiver

public class ResourceListControl
extends WcmResourceControl
implements com.sapportals.wdf.event.WdfEventReceiver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceListControl.Mode
static class	ResourceListControl.Style

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

WcmResourceControl.ResourceNotFoundException

Field Summary

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

Constructors

Constructor and Description
ResourceListControl() Default constructor for dynamic class instantiation
ResourceListControl(String controlID) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	createNestedControls() Create, parameterize and register nested controls.
String	getBackGroundStyle()
ICollection	getCollection()
boolean	getDetailsLinkTarget()
boolean	getFileSelection()
boolean	getFilesOnly()
boolean	getFolderSelection()
boolean	getFoldersOnly()
IControlLinkHandler	getLinkHandler() LinkHandler
IResourceList	getList()
int	getMaxNumberOfRows()
int	getMode()
boolean	getMultipleSelection()
boolean	getNavigateMode()
boolean	getNoBreadCrumb()
static String[]	getResourceURISelection(com.sapportals.htmlb.event.Event event) Returns an array of URIs that where selected with the table view selection feature (check box for each row)
String	getRoot()
IResourceList	getSelectedResources()
static String	getSelectedResourceURI(com.sapportals.htmlb.event.Event event) Decodes the event value
String	getSelectedUri()
boolean	getShowCancel()
boolean	getSingleSelection()
String	getSortField()
String	getSortOrder()
int	getStartRow()
String	getStartUri()
int	getStyle()
boolean	getUseExternalLinks() link gerneration handled external
boolean	isEnableActionLinks() enable action links in see also result list
boolean	isEnableBrowseFromHere()
boolean	isEnableNumberOfHits()
com.sapportals.wdf.event.WdfEvent	onCancel(com.sapportals.htmlb.event.Event event) Internal event handler for cancel.
com.sapportals.wdf.event.WdfEvent	onDelete(com.sapportals.htmlb.event.Event event) Internal event handler for delete.
com.sapportals.wdf.event.WdfEvent	onDetails(com.sapportals.htmlb.event.Event event) Internal event handler for Details select.
com.sapportals.wdf.event.WdfEvent	onNewFile(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onNewFolder(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onNewLink(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onNewText(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onOthEvent(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onPageFlip(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onPathClick(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onResourceSelected(com.sapportals.htmlb.event.Event event) Internal event handler for resource select.
com.sapportals.wdf.event.WdfEvent	onSeeAlso(com.sapportals.htmlb.event.Event event) Internal event handler for See Also select.
com.sapportals.wdf.event.WdfEvent	onSingleSelect(com.sapportals.htmlb.event.Event event) Internal event handler for single selection.
com.sapportals.wdf.event.WdfEvent	onSortSelect(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onStyle(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onToggleSort(com.sapportals.htmlb.event.Event event)
void	receive(com.sapportals.wdf.event.WdfEvent cflEvent) CFL Event reception routine
com.sapportals.htmlb.Component	render() Build the UI for this control
void	setActions(List actions)
void	setBackGroundStyle(String backGroundStyle)
void	setDetailsLinkTarget(boolean displayLinkTarget)
void	setEnableActionLinks(boolean value)
void	setEnableBrowseFromHere(boolean value) enable browse from here in see also result list
void	setEnableNumberOfHits(boolean status) enable display number of hits in see also result lits
void	setFileSelection(boolean fileSelection)
void	setFilesOnly(boolean filesOnly)
void	setFolderSelection(boolean folderSelection)
void	setFoldersOnly(boolean foldersOnly)
void	setLinkHandler(IControlLinkHandler linkHandler) LinkHandler
void	setList(IResourceList list) The list that will be displayed
void	setMaxNumberOfRows(int row)
void	setMode(int mode) The mode of the list (?
void	setMultipleSelection(boolean multiple)
void	setNavigateMode(boolean navigateMode)
void	setNoBreadCrumb(boolean noBreadCrumb)
void	setOnResourceSelected(String handlerName) Register an event handler for this event handlerName is the Method of the pagelet that will be called after this event has been fired.
void	setProperties(IPropertyNameList properties)
void	setRoot(String root) The url to the root resource that can not be crossed on back navigation
void	setSelectedUri(String selectedUri)
void	setShowCancel(boolean input)
void	setSingleSelection(boolean singleSelection)
void	setSortField(String sortField)
void	setSortOrder(String sortOrder)
void	setStartRow(int startRow)
void	setStartUri(String startUri)
void	setStyle(int style)
void	setUseExternalLinks(boolean useExternalLinks) link gerneration handled external

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

checkArchivingStauts, getAOStates, getDetailsPageUri, getResource, getResourceLink, getResourceList, 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, readInputData, setControlContext, setResourceContext, setTestMode, setVisible

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

create, create, 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

Constructor Detail

ResourceListControl

public ResourceListControl()

Default constructor for dynamic class instantiation

ResourceListControl

public ResourceListControl(String controlID)

Constructor

Method Detail

getStartUri

public String getStartUri()

setStartUri

public void setStartUri(String startUri)

setDetailsLinkTarget

public void setDetailsLinkTarget(boolean displayLinkTarget)

getDetailsLinkTarget

public boolean getDetailsLinkTarget()

setEnableNumberOfHits

public void setEnableNumberOfHits(boolean status)

enable display number of hits in see also result lits

isEnableNumberOfHits

public boolean isEnableNumberOfHits()

isEnableActionLinks

public boolean isEnableActionLinks()

enable action links in see also result list

setEnableActionLinks

public void setEnableActionLinks(boolean value)

setEnableBrowseFromHere

public void setEnableBrowseFromHere(boolean value)

enable browse from here in see also result list

isEnableBrowseFromHere

public boolean isEnableBrowseFromHere()

setShowCancel

public void setShowCancel(boolean input)

getShowCancel

public boolean getShowCancel()

setOnResourceSelected

public void setOnResourceSelected(String handlerName)

Register an event handler for this event handlerName is the Method of the pagelet that will be called after this event has been fired. Example public void onMyResourceSelected(ControlEvent event) {}

getCollection

public ICollection getCollection()
                          throws WcmException

Throws:

WcmException

setList

public void setList(IResourceList list)
             throws Exception

The list that will be displayed

Throws:

Exception

getList

public IResourceList getList()
                      throws Exception

Throws:

Exception

setRoot

public void setRoot(String root)
             throws Exception

The url to the root resource that can not be crossed on back navigation

Throws:

Exception

getRoot

public String getRoot()
               throws Exception

Throws:

Exception

setMode

public void setMode(int mode)
             throws Exception

The mode of the list (?to naming[navigate,display,edit,...)

Throws:

Exception

getMode

public int getMode()
            throws Exception

Throws:

Exception

setProperties

public void setProperties(IPropertyNameList properties)

setActions

public void setActions(List actions)

setStartRow

public void setStartRow(int startRow)

getStartRow

public int getStartRow()

setMultipleSelection

public void setMultipleSelection(boolean multiple)

getMultipleSelection

public boolean getMultipleSelection()

setSingleSelection

public void setSingleSelection(boolean singleSelection)

setFileSelection

public void setFileSelection(boolean fileSelection)

setFolderSelection

public void setFolderSelection(boolean folderSelection)

getSingleSelection

public boolean getSingleSelection()

getFileSelection

public boolean getFileSelection()

getFolderSelection

public boolean getFolderSelection()

getUseExternalLinks

public boolean getUseExternalLinks()

link gerneration handled external

setUseExternalLinks

public void setUseExternalLinks(boolean useExternalLinks)

link gerneration handled external

getLinkHandler

public IControlLinkHandler getLinkHandler()

LinkHandler

setLinkHandler

public void setLinkHandler(IControlLinkHandler linkHandler)

LinkHandler

setSortField

public void setSortField(String sortField)

setSortOrder

public void setSortOrder(String sortOrder)

getSortField

public String getSortField()

getSortOrder

public String getSortOrder()

setStyle

public void setStyle(int style)

getStyle

public int getStyle()

setFilesOnly

public void setFilesOnly(boolean filesOnly)

getFilesOnly

public boolean getFilesOnly()

setMaxNumberOfRows

public void setMaxNumberOfRows(int row)

getMaxNumberOfRows

public int getMaxNumberOfRows()

setFoldersOnly

public void setFoldersOnly(boolean foldersOnly)

getFoldersOnly

public boolean getFoldersOnly()

setSelectedUri

public void setSelectedUri(String selectedUri)

getSelectedUri

public String getSelectedUri()

setNavigateMode

public void setNavigateMode(boolean navigateMode)

setNoBreadCrumb

public void setNoBreadCrumb(boolean noBreadCrumb)

getNoBreadCrumb

public boolean getNoBreadCrumb()

getNavigateMode

public boolean getNavigateMode()

setBackGroundStyle

public void setBackGroundStyle(String backGroundStyle)

getBackGroundStyle

public String getBackGroundStyle()

render

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

Build the UI for this control

Specified by:

render in class com.sapportals.wdf.stack.Control

Throws:

com.sapportals.wdf.WdfException

getSelectedResourceURI

public static String getSelectedResourceURI(com.sapportals.htmlb.event.Event event)

Decodes the event value

getResourceURISelection

public static String[] getResourceURISelection(com.sapportals.htmlb.event.Event event)

Returns an array of URIs that where selected with the table view selection feature (check box for each row)

receive

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

CFL Event reception routine

Specified by:

receive in interface com.sapportals.wdf.event.WdfEventReceiver

Overrides:

receive in class WcmResourceControl

Parameters:

cflEvent - the event

Throws:

com.sapportals.wdf.WdfException - if an error occurs

onDetails

public com.sapportals.wdf.event.WdfEvent onDetails(com.sapportals.htmlb.event.Event event)
                                            throws WcmException

Internal event handler for Details select.

Throws:

WcmException

onDelete

public com.sapportals.wdf.event.WdfEvent onDelete(com.sapportals.htmlb.event.Event event)
                                           throws WcmException

Internal event handler for delete.

Throws:

WcmException

onNewFolder

public com.sapportals.wdf.event.WdfEvent onNewFolder(com.sapportals.htmlb.event.Event event)
                                              throws ResourceException

Throws:

ResourceException

onNewFile

public com.sapportals.wdf.event.WdfEvent onNewFile(com.sapportals.htmlb.event.Event event)
                                            throws ResourceException

Throws:

ResourceException

onNewText

public com.sapportals.wdf.event.WdfEvent onNewText(com.sapportals.htmlb.event.Event event)
                                            throws ResourceException

Throws:

ResourceException

onNewLink

public com.sapportals.wdf.event.WdfEvent onNewLink(com.sapportals.htmlb.event.Event event)
                                            throws ResourceException

Throws:

ResourceException

onOthEvent

public com.sapportals.wdf.event.WdfEvent onOthEvent(com.sapportals.htmlb.event.Event event)
                                             throws ResourceException

Throws:

ResourceException

onResourceSelected

public com.sapportals.wdf.event.WdfEvent onResourceSelected(com.sapportals.htmlb.event.Event event)
                                                     throws WcmException

Internal event handler for resource select.

Throws:

WcmException

onPathClick

public com.sapportals.wdf.event.WdfEvent onPathClick(com.sapportals.htmlb.event.Event event)
                                              throws WcmException

Throws:

WcmException

onSortSelect

public com.sapportals.wdf.event.WdfEvent onSortSelect(com.sapportals.htmlb.event.Event event)
                                               throws ResourceException

Throws:

ResourceException

onToggleSort

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

Throws:

ResourceException

onStyle

public com.sapportals.wdf.event.WdfEvent onStyle(com.sapportals.htmlb.event.Event event)
                                          throws ResourceException

Throws:

ResourceException

onPageFlip

public com.sapportals.wdf.event.WdfEvent onPageFlip(com.sapportals.htmlb.event.Event event)
                                             throws ResourceException

Throws:

ResourceException

onSeeAlso

public com.sapportals.wdf.event.WdfEvent onSeeAlso(com.sapportals.htmlb.event.Event event)
                                            throws WcmException

Internal event handler for See Also select.

Throws:

WcmException

onSingleSelect

public com.sapportals.wdf.event.WdfEvent onSingleSelect(com.sapportals.htmlb.event.Event event)
                                                 throws WcmException

Internal event handler for single selection.

Throws:

WcmException

onCancel

public com.sapportals.wdf.event.WdfEvent onCancel(com.sapportals.htmlb.event.Event event)
                                           throws WcmException

Internal event handler for cancel.

Throws:

WcmException

createNestedControls

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

Create, parameterize and register nested controls.

Overrides:

createNestedControls in class com.sapportals.wdf.stack.Control

Throws:

com.sapportals.wdf.WdfException

getSelectedResources

public IResourceList getSelectedResources()
                                   throws ResourceException

Throws:

ResourceException