public class ResourceListControl extends WcmResourceControl implements com.sapportals.wdf.event.WdfEventReceiver
Modifier and Type | Class and Description |
---|---|
static class |
ResourceListControl.Mode |
static class |
ResourceListControl.Style |
WcmResourceControl.ResourceNotFoundException
START_PAGE_BROWSE, START_PAGE_DETAILS, uri
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
Constructor and Description |
---|
ResourceListControl()
Default constructor for dynamic class instantiation
|
ResourceListControl(String controlID)
Constructor
|
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
|
checkArchivingStauts, getAOStates, getDetailsPageUri, getResource, getResourceLink, getResourceList, getSafeResource, getUri, setResource, setUri
getBaseBundleString, getBaseBundleString, getBaseBundleString, getBaseBundleString, getBundleString, getBundleString, getBundleString, getBundleString, getBusinessCardLink, getImage, getParameterConfiguration, getResourceContext, getServicePageUri, handleException, isSection508Rendering, isTestMode, isVisible, readInputData, setControlContext, setResourceContext, setTestMode, setVisible
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
public ResourceListControl()
public ResourceListControl(String controlID)
public String getStartUri()
public void setStartUri(String startUri)
public void setDetailsLinkTarget(boolean displayLinkTarget)
public boolean getDetailsLinkTarget()
public void setEnableNumberOfHits(boolean status)
public boolean isEnableNumberOfHits()
public boolean isEnableActionLinks()
public void setEnableActionLinks(boolean value)
public void setEnableBrowseFromHere(boolean value)
public boolean isEnableBrowseFromHere()
public void setShowCancel(boolean input)
public boolean getShowCancel()
public void setOnResourceSelected(String handlerName)
public ICollection getCollection() throws WcmException
WcmException
public void setList(IResourceList list) throws Exception
Exception
public IResourceList getList() throws Exception
Exception
public void setRoot(String root) throws Exception
Exception
public void setMode(int mode) throws Exception
Exception
public void setProperties(IPropertyNameList properties)
public void setActions(List actions)
public void setStartRow(int startRow)
public int getStartRow()
public void setMultipleSelection(boolean multiple)
public boolean getMultipleSelection()
public void setSingleSelection(boolean singleSelection)
public void setFileSelection(boolean fileSelection)
public void setFolderSelection(boolean folderSelection)
public boolean getSingleSelection()
public boolean getFileSelection()
public boolean getFolderSelection()
public boolean getUseExternalLinks()
public void setUseExternalLinks(boolean useExternalLinks)
public IControlLinkHandler getLinkHandler()
public void setLinkHandler(IControlLinkHandler linkHandler)
public void setSortField(String sortField)
public void setSortOrder(String sortOrder)
public String getSortField()
public String getSortOrder()
public void setStyle(int style)
public int getStyle()
public void setFilesOnly(boolean filesOnly)
public boolean getFilesOnly()
public void setMaxNumberOfRows(int row)
public int getMaxNumberOfRows()
public void setFoldersOnly(boolean foldersOnly)
public boolean getFoldersOnly()
public void setSelectedUri(String selectedUri)
public String getSelectedUri()
public void setNavigateMode(boolean navigateMode)
public void setNoBreadCrumb(boolean noBreadCrumb)
public boolean getNoBreadCrumb()
public boolean getNavigateMode()
public void setBackGroundStyle(String backGroundStyle)
public String getBackGroundStyle()
public com.sapportals.htmlb.Component render() throws com.sapportals.wdf.WdfException
render
in class com.sapportals.wdf.stack.Control
com.sapportals.wdf.WdfException
public static String getSelectedResourceURI(com.sapportals.htmlb.event.Event event)
public static String[] getResourceURISelection(com.sapportals.htmlb.event.Event event)
public void receive(com.sapportals.wdf.event.WdfEvent cflEvent) throws com.sapportals.wdf.WdfException
receive
in interface com.sapportals.wdf.event.WdfEventReceiver
receive
in class WcmResourceControl
cflEvent
- the eventcom.sapportals.wdf.WdfException
- if an error occurspublic com.sapportals.wdf.event.WdfEvent onDetails(com.sapportals.htmlb.event.Event event) throws WcmException
WcmException
public com.sapportals.wdf.event.WdfEvent onDelete(com.sapportals.htmlb.event.Event event) throws WcmException
WcmException
public com.sapportals.wdf.event.WdfEvent onNewFolder(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onNewFile(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onNewText(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onNewLink(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onOthEvent(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onResourceSelected(com.sapportals.htmlb.event.Event event) throws WcmException
WcmException
public com.sapportals.wdf.event.WdfEvent onPathClick(com.sapportals.htmlb.event.Event event) throws WcmException
WcmException
public com.sapportals.wdf.event.WdfEvent onSortSelect(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onToggleSort(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onStyle(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onPageFlip(com.sapportals.htmlb.event.Event event) throws ResourceException
ResourceException
public com.sapportals.wdf.event.WdfEvent onSeeAlso(com.sapportals.htmlb.event.Event event) throws WcmException
WcmException
public com.sapportals.wdf.event.WdfEvent onSingleSelect(com.sapportals.htmlb.event.Event event) throws WcmException
WcmException
public com.sapportals.wdf.event.WdfEvent onCancel(com.sapportals.htmlb.event.Event event) throws WcmException
WcmException
protected void createNestedControls() throws com.sapportals.wdf.WdfException
createNestedControls
in class com.sapportals.wdf.stack.Control
com.sapportals.wdf.WdfException
public IResourceList getSelectedResources() throws ResourceException
ResourceException
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice