com.sapportals.wcm.control.edit

Class MultipleUploadControl

java.lang.Object
  com.sapportals.wdf.stack.Control
      com.sapportals.wcm.control.base.WcmBaseControl
          com.sapportals.wcm.control.base.WcmResourceControl
              com.sapportals.wcm.control.edit.MultipleUploadControl

All Implemented Interfaces:

com.sapportals.wdf.event.WdfEventReceiver

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

Copyright 2009 SAP AG

Nested Class Summary

protected class

MultipleUploadControl.UploadStatus

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

MultipleUploadControl()
Constructor

MultipleUploadControl(String controlID)
Constructor

Method Summary

boolean	checkExistingName(String theName) Check if already the input name exists as Resource name
protected void	createNestedControls() Register composite parts
String	getArchivedFilesString()
String	getExistingFilesString()
String	getExpandedIndexesString()
String	getLastUploadedFileNames()
String	getlockedFilesString()
int	getMaxNumberOfFiles()
String	getPropertyStructureName()
String	getReadonlyFilesString()
String	getSelectedFilesPaths()
boolean	getSendBackEvent() Gets the sendBackEvent attribute of the ResourceUploadControl object
String	getStartUri() Retrieve the startURI
String	getUploadStatus()
protected void	initialize() Initialize control by making a copy of data from resource.
com.sapportals.wdf.event.WdfEvent	onCancel(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onDelete(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onDone(com.sapportals.htmlb.event.Event event) Called when upload is completed and user returns to initial screen
com.sapportals.wdf.event.WdfEvent	onGetUploadStatus(com.sapportals.htmlb.event.Event e) Gets sting parameter from the applet containing status of uploaded files
com.sapportals.wdf.event.WdfEvent	onSelectFiles(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onSetFilesPaths(com.sapportals.htmlb.event.Event e) Gets sting parameter from the applet and sets it to the paths list
com.sapportals.wdf.event.WdfEvent	onShowDetails(com.sapportals.htmlb.event.Event event)
com.sapportals.wdf.event.WdfEvent	onUpload(com.sapportals.htmlb.event.Event event)
protected void	readInputData()
void	receive(com.sapportals.wdf.event.WdfEvent cflEvent) reacts on CflResourceEvents and resets the present resource of the control.
com.sapportals.htmlb.Component	render()
com.sapportals.htmlb.Component	renderPersistentProperties() Renders local properties map as hidden InputField.
void	restorePersistentProperties(com.sapportals.htmlb.page.DynPage page) Restores single properties map as hidden InputField.
void	setArchivedFilesString(String archivedFilesString)
void	setExistingFilesString(List<Integer> files)
void	setExistingFilesString(String existingFilesString)
void	setExpandedIndexesString(String expandedIndexesString)
void	setLastUploadedFileNames(String lastUploadedFileNames)
void	setlockedFilesString(String lockedFilesString)
void	setMaxNumberOfFiles(int maxNumberOfFiles)
void	setPropertyStructureName(String propertyStructureName)
void	setReadonlyFilesString(String readonlyFilesString)
void	setSelectedFilesPaths(String selectedFilesPaths)
void	setSendBackEvent(boolean flag) Sets the sendBackEvent attribute of the ResourceUploadControl object
void	setUploadStatus(String uploadStatus)

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, 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, initializeImpl, isInitialized, register, resetNestedControls, 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

MultipleUploadControl

public MultipleUploadControl(String controlID)

Constructor

Parameters:

controlID -

MultipleUploadControl

public MultipleUploadControl()

Constructor

Parameters:

controlID -

Method Detail

getStartUri

public String getStartUri()

Retrieve the startURI

Returns:

- the value of startUri as String

getPropertyStructureName

public String getPropertyStructureName()

setPropertyStructureName

public void setPropertyStructureName(String propertyStructureName)

getUploadStatus

public String getUploadStatus()

setUploadStatus

public void setUploadStatus(String uploadStatus)

getSelectedFilesPaths

public String getSelectedFilesPaths()

setSelectedFilesPaths

public void setSelectedFilesPaths(String selectedFilesPaths)

setSendBackEvent

public void setSendBackEvent(boolean flag)

Sets the sendBackEvent attribute of the ResourceUploadControl object

Parameters:

flag - The new sendBackEvent value

getSendBackEvent

public boolean getSendBackEvent()

Gets the sendBackEvent attribute of the ResourceUploadControl object

Returns:

The sendBackEvent value

getMaxNumberOfFiles

public int getMaxNumberOfFiles()

setMaxNumberOfFiles

public void setMaxNumberOfFiles(int maxNumberOfFiles)

getExistingFilesString

public String getExistingFilesString()

getArchivedFilesString

public String getArchivedFilesString()

setExistingFilesString

public void setExistingFilesString(String existingFilesString)

setArchivedFilesString

public void setArchivedFilesString(String archivedFilesString)

getlockedFilesString

public String getlockedFilesString()

setlockedFilesString

public void setlockedFilesString(String lockedFilesString)

getReadonlyFilesString

public String getReadonlyFilesString()

setReadonlyFilesString

public void setReadonlyFilesString(String readonlyFilesString)

setExistingFilesString

public void setExistingFilesString(List<Integer> files)

getExpandedIndexesString

public String getExpandedIndexesString()

setExpandedIndexesString

public void setExpandedIndexesString(String expandedIndexesString)

receive

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

Description copied from class: WcmResourceControl

reacts on CflResourceEvents and resets the present resource of the control. If controls want to implement a special treatment of these events they can implement this method themselves.

Specified by:

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

Overrides:

receive in class WcmResourceControl

Throws:

com.sapportals.wdf.WdfException

readInputData

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

Overrides:

readInputData in class WcmBaseControl

Throws:

com.sapportals.wdf.WdfException

createNestedControls

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

Register composite parts

Overrides:

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

Throws:

com.sapportals.wdf.WdfException - Exception raised in failure situation

restorePersistentProperties

public void restorePersistentProperties(com.sapportals.htmlb.page.DynPage page)
                                 throws com.sapportals.wdf.WdfException

Restores single properties map as hidden InputField.

Overrides:

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

Parameters:

page - The DynPage to read out components

Throws:

com.sapportals.wdf.WdfException

renderPersistentProperties

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

Renders local properties map as hidden InputField.

Overrides:

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

Returns:

A sub control tree containing hidden fields.

Throws:

com.sapportals.wdf.WdfException

render

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

Specified by:

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

Throws:

com.sapportals.wdf.WdfException

onCancel

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

Parameters:

event -

Returns:

Throws:

com.sapportals.wcm.WcmException

onDone

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

Called when upload is completed and user returns to initial screen

Parameters:

event - Description of the param

Returns:

Description of the Return Value

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

onSelectFiles

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

Throws:

com.sapportals.wcm.WcmException

onUpload

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

Throws:

com.sapportals.wcm.WcmException

onSetFilesPaths

public com.sapportals.wdf.event.WdfEvent onSetFilesPaths(com.sapportals.htmlb.event.Event e)

Gets sting parameter from the applet and sets it to the paths list

Parameters:

e -

Returns:

onGetUploadStatus

public com.sapportals.wdf.event.WdfEvent onGetUploadStatus(com.sapportals.htmlb.event.Event e)
                                                    throws com.sapportals.wcm.WcmException

Gets sting parameter from the applet containing status of uploaded files

Parameters:

e -

Returns:

Throws:

com.sapportals.wcm.WcmException

onShowDetails

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

Throws:

com.sapportals.wcm.WcmException

onDelete

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

Throws:

com.sapportals.wcm.WcmException

initialize

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

Initialize control by making a copy of data from resource.

Overrides:

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

Throws:

com.sapportals.wdf.WdfException

checkExistingName

public boolean checkExistingName(String theName)

Check if already the input name exists as Resource name

Parameters:

theName - - the resource name

Returns:

- a resource name which is unique

getLastUploadedFileNames

public String getLastUploadedFileNames()

setLastUploadedFileNames

public void setLastUploadedFileNames(String lastUploadedFileNames)

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