org.nuxeo.ecm.webapp.clipboard
Interface ClipboardActions

All Known Implementing Classes:

ClipboardActionsBean

public interface ClipboardActions

Interface for clipboard template page action listener. Exposes methods for handling user actions related to the copy/paste buttons from clipboard.xhtml template.

Author:

Razvan Caraghin

Method Summary

java.lang.String	clearWorkingList() Called when the "delete all" button is clicked on the clipboard.
void	copySelection(java.util.List<DocumentModel> docCopied) Called when the drag and drop is launched in the clipboard fragment.
void	destroy() Removes the component.
java.lang.String	exportAllBlobsFromWorkingListAsZip()
java.lang.String	exportMainBlobFromWorkingListAsZip()
java.lang.String	exportWorklistAsZip()
java.lang.String	exportWorklistAsZip(java.util.List<DocumentModel> documents)
java.lang.String	exportWorklistAsZip(java.util.List<DocumentModel> documents, boolean exportAllBlobs)
boolean	factoryForIsCurrentWorkListEmpty()
java.util.List<Action>	getActionsForCurrentList() Returns the list of available web actions for the currently selected DocumentList.
java.util.List<Action>	getActionsForSelection() Returns the list of available web actions for the currently selected Documents.
java.util.List<java.lang.String>	getAvailableLists() Returns the list of available lists (ie: the lists from the CLIPBOARD Category).
java.lang.String	getCacheKey()
boolean	getCanCopy() Checks if there are selected items that can be copied into the current worklist.
boolean	getCanEditListDocs(java.lang.String listName) Checks if documents in the specified list are editable so the bulk editing action can be invoked later.
boolean	getCanEditSelectedDocs() Checks for documents bulk editing action.
boolean	getCanMoveFromClipboardInside(DocumentModel document) Checks if the documents from the clipboard can be moved into the given document
boolean	getCanMoveInside(java.lang.String listName, DocumentModel document) Checks if the documents in a given worklist can be moved into the given document
boolean	getCanMoveWorkingList() Checks if there are documents in current worklist can be moved into the current folder.
boolean	getCanPaste(java.lang.String listName) Checks if the content of a given workList can be pasted.
boolean	getCanPasteFromClipboard() Shortcut for getCanPaste on the clipboard.
boolean	getCanPasteFromClipboardInside(DocumentModel document)
boolean	getCanPasteInside(java.lang.String listName, DocumentModel document)
boolean	getCanPasteWorkList() Shortcut for getCanPaste on the currently selected workList.
java.util.List<DocumentModel>	getCurrentSelectedList() Retries contents of current WorkList.
java.lang.String	getCurrentSelectedListName() Returns the name of the current selected WorkList.
java.lang.String	getCurrentSelectedListTitle()
java.util.List<DocumentsListDescriptor>	getDescriptorsForAvailableLists() Returns the list of Descriptors for available lists.
boolean	isCacheEnabled()
boolean	isCacheEnabledForSelection()
boolean	isInitialized()
boolean	isWorkListEmpty() Checks if the currently selected WorkList is empty.
java.lang.String	moveClipboardInside(java.lang.String docId)
java.lang.String	moveWorkingList() Called when the "move all" button is clicked on the clipboard/selection
java.lang.String	pasteClipboard()
java.lang.String	pasteClipboardInside(java.lang.String docId)
java.lang.String	pasteDocumentList(java.util.List<DocumentModel> docPaste) Called when the drag and drop is launched in the body fragment.
java.lang.String	pasteDocumentList(java.lang.String listName) Pastes the content of the list listName into the current context document.
java.lang.String	pasteDocumentListInside(java.util.List<DocumentModel> docPaste, java.lang.String docId)
java.lang.String	pasteDocumentListInside(java.lang.String listName, java.lang.String docId)
java.lang.String	pasteWorkingList() Called when the "paste all" button is clicked on the clipboard.
void	putInClipboard(java.lang.String docId)
void	putSelectionInClipboard()
void	putSelectionInDefaultWorkList()
void	putSelectionInWorkList() Copies the lists of selected documents into the current WorkList.
void	putSelectionInWorkList(java.lang.Boolean forceAppend)
void	putSelectionInWorkList(java.util.List<DocumentModel> docsList) Copies docsList into the current WorkList.
void	putSelectionInWorkList(java.util.List<DocumentModel> docsList, java.lang.Boolean forceAppend)
void	releaseClipboardableDocuments()
java.lang.String	removeWorkListItem(DocumentRef ref) Called when the delete button is clicked on the clipboard.
void	selectList()
void	setCurrentSelectedList(java.lang.String listId) Sets the current selected WorkList.

Method Detail

copySelection

void copySelection(java.util.List<DocumentModel> docCopied)

Called when the drag and drop is launched in the clipboard fragment. Copies the documents passed to the clipboard.

The selection is added to the clipboard and to the WorkingList.

Parameters:

docCopied - the list of documents we want to copy

removeWorkListItem

java.lang.String removeWorkListItem(DocumentRef ref)
                                    throws ClientException

Called when the delete button is clicked on the clipboard.

Throws:

ClientException

clearWorkingList

java.lang.String clearWorkingList()

Called when the "delete all" button is clicked on the clipboard.

pasteWorkingList

java.lang.String pasteWorkingList()
                                  throws ClientException

Called when the "paste all" button is clicked on the clipboard.

Throws:

ClientException

moveWorkingList

java.lang.String moveWorkingList()
                                 throws ClientException

Called when the "move all" button is clicked on the clipboard/selection

Throws:

ClientException

pasteDocumentList

java.lang.String pasteDocumentList(java.util.List<DocumentModel> docPaste)
                                   throws ClientException

Called when the drag and drop is launched in the body fragment. Pastes the documents passed to the clipboard.

Parameters:

docPaste - the list of doc we want to paste

Throws:

ClientException

pasteDocumentListInside

java.lang.String pasteDocumentListInside(java.util.List<DocumentModel> docPaste,
                                         java.lang.String docId)
                                         throws ClientException

Throws:

ClientException

pasteDocumentList

java.lang.String pasteDocumentList(java.lang.String listName)
                                   throws ClientException

Pastes the content of the list listName into the current context document.

Parameters:

listName -

Throws:

ClientException

pasteDocumentListInside

java.lang.String pasteDocumentListInside(java.lang.String listName,
                                         java.lang.String docId)
                                         throws ClientException

Throws:

ClientException

pasteClipboard

java.lang.String pasteClipboard()
                                throws ClientException

Throws:

ClientException

pasteClipboardInside

java.lang.String pasteClipboardInside(java.lang.String docId)
                                      throws ClientException

Throws:

ClientException

moveClipboardInside

java.lang.String moveClipboardInside(java.lang.String docId)
                                     throws ClientException

Throws:

ClientException

destroy

@Destroy
void destroy()

Removes the component.

exportWorklistAsZip

java.lang.String exportWorklistAsZip()
                                     throws ClientException

Throws:

ClientException

exportAllBlobsFromWorkingListAsZip

java.lang.String exportAllBlobsFromWorkingListAsZip()
                                                    throws ClientException

Throws:

ClientException

exportMainBlobFromWorkingListAsZip

java.lang.String exportMainBlobFromWorkingListAsZip()
                                                    throws ClientException

Throws:

ClientException

exportWorklistAsZip

java.lang.String exportWorklistAsZip(java.util.List<DocumentModel> documents)
                                     throws ClientException

Throws:

ClientException

exportWorklistAsZip

java.lang.String exportWorklistAsZip(java.util.List<DocumentModel> documents,
                                     boolean exportAllBlobs)
                                     throws ClientException

Throws:

ClientException

releaseClipboardableDocuments

void releaseClipboardableDocuments()

isInitialized

boolean isInitialized()

isWorkListEmpty

boolean isWorkListEmpty()

Checks if the currently selected WorkList is empty.

Returns:

getCanPasteWorkList

boolean getCanPasteWorkList()
                            throws ClientException

Shortcut for getCanPaste on the currently selected workList.

Returns:

Throws:

ClientException

getCanPasteFromClipboard

boolean getCanPasteFromClipboard()
                                 throws ClientException

Shortcut for getCanPaste on the clipboard.

Returns:

Throws:

ClientException

getCanPasteFromClipboardInside

boolean getCanPasteFromClipboardInside(DocumentModel document)
                                       throws ClientException

Throws:

ClientException

getCanMoveFromClipboardInside

boolean getCanMoveFromClipboardInside(DocumentModel document)
                                      throws ClientException

Checks if the documents from the clipboard can be moved into the given document

Throws:

ClientException

getCanPaste

boolean getCanPaste(java.lang.String listName)
                    throws ClientException

Checks if the content of a given workList can be pasted.

- checks if the list is empty
- checks if the user has the needed rights in the current context

Parameters:

listName -

Returns:

Throws:

ClientException

getCanPasteInside

boolean getCanPasteInside(java.lang.String listName,
                          DocumentModel document)
                          throws ClientException

Throws:

ClientException

getCanCopy

boolean getCanCopy()

Checks if there are selected items that can be copied into the current worklist.

Returns:

getCanMoveWorkingList

boolean getCanMoveWorkingList()
                              throws ClientException

Checks if there are documents in current worklist can be moved into the current folder.

Throws:

ClientException

getCanMoveInside

boolean getCanMoveInside(java.lang.String listName,
                         DocumentModel document)
                         throws ClientException

Checks if the documents in a given worklist can be moved into the given document

Throws:

ClientException

putSelectionInWorkList

void putSelectionInWorkList(java.util.List<DocumentModel> docsList)

Copies docsList into the current WorkList.

Parameters:

docsList -

putSelectionInWorkList

void putSelectionInWorkList(java.util.List<DocumentModel> docsList,
                            java.lang.Boolean forceAppend)

putSelectionInWorkList

void putSelectionInWorkList()

Copies the lists of selected documents into the current WorkList.

putSelectionInWorkList

void putSelectionInWorkList(java.lang.Boolean forceAppend)

putSelectionInClipboard

void putSelectionInClipboard()

putSelectionInDefaultWorkList

void putSelectionInDefaultWorkList()

putInClipboard

void putInClipboard(java.lang.String docId)
                    throws ClientException

Throws:

ClientException

getCurrentSelectedList

java.util.List<DocumentModel> getCurrentSelectedList()

Retries contents of current WorkList.

getCurrentSelectedListName

java.lang.String getCurrentSelectedListName()

Returns the name of the current selected WorkList.

getCurrentSelectedListTitle

java.lang.String getCurrentSelectedListTitle()

setCurrentSelectedList

void setCurrentSelectedList(java.lang.String listId)

Sets the current selected WorkList.

getAvailableLists

java.util.List<java.lang.String> getAvailableLists()

Returns the list of available lists (ie: the lists from the CLIPBOARD Category).

getDescriptorsForAvailableLists

java.util.List<DocumentsListDescriptor> getDescriptorsForAvailableLists()

Returns the list of Descriptors for available lists.

getActionsForCurrentList

java.util.List<Action> getActionsForCurrentList()

Returns the list of available web actions for the currently selected DocumentList.

Returns:

the WebAction list

getActionsForSelection

java.util.List<Action> getActionsForSelection()

Returns the list of available web actions for the currently selected Documents.

Returns:

the WebAction list

selectList

void selectList()

getCanEditSelectedDocs

boolean getCanEditSelectedDocs()
                               throws ClientException

Checks for documents bulk editing action.

Returns:

true if the current selected docs (from clipboard) are editable by the current user

Throws:

ClientException

getCanEditListDocs

boolean getCanEditListDocs(java.lang.String listName)
                           throws ClientException

Checks if documents in the specified list are editable so the bulk editing action can be invoked later.

Returns:

true if the docs from the specified working list are editable by the current user

Throws:

ClientException

factoryForIsCurrentWorkListEmpty

boolean factoryForIsCurrentWorkListEmpty()

isCacheEnabled

boolean isCacheEnabled()

getCacheKey

java.lang.String getCacheKey()

isCacheEnabledForSelection

boolean isCacheEnabledForSelection()