org.alfresco.web.bean.clipboard

Interface ClipboardItem

All Superinterfaces:

Serializable

All Known Implementing Classes:

WorkspaceClipboardItem

public interface ClipboardItem
extends Serializable

Simple class representing a single item added to the clipboard.

Author:

Kevin Roast

Method Summary

Modifier and Type	Method and Description
boolean	canCopyToViewId(String viewId)
boolean	canMoveToViewId(String viewId)
String	getIcon()
ClipboardStatus	getMode()
String	getName()
org.alfresco.service.cmr.repository.NodeRef	getNodeRef()
org.alfresco.service.namespace.QName	getType()
boolean	paste(FacesContext fc, String viewId, int action)
boolean	supportsLink()

Method Detail

getMode

ClipboardStatus getMode()

Returns:

the mode status of the clipboard item, the enum can be either Cut or Copy

getName

String getName()

Returns:

display label (cm:name) of the clipboard item

getType

org.alfresco.service.namespace.QName getType()

Returns:

QName type of the clipboard item

getIcon

String getIcon()

Returns:

the app:icon property of the clipboard item

getNodeRef

org.alfresco.service.cmr.repository.NodeRef getNodeRef()

Returns:

the NodeRef of the clipboard item

supportsLink

boolean supportsLink()

Returns:

true if the item on the clipboard supports linking (.url) as a link type

canCopyToViewId

boolean canCopyToViewId(String viewId)

Parameters:

viewId - JSF View Id to check against

Returns:

true if the clipboard item can be Copy pasted to the specified JSF view

canMoveToViewId

boolean canMoveToViewId(String viewId)

Parameters:

viewId - JSF View Id to check against

Returns:

true if the clipboard item can be Move pasted to the specified JSF view

paste

boolean paste(FacesContext fc,
              String viewId,
              int action)
       throws Throwable

Parameters:

fc - FacesContext

viewId - JSF View Id to paste into

action - Clipboard action constant (@see org.alfresco.web.ui.repo.component.shelf.UIClipboardShelfItem)

Returns:

true on successful paste, false otherwise

Throws:

Throwable - on fatal error during paste