Files
alfresco-community-repo/source/java/org/alfresco/web/bean/clipboard/ClipboardItem.java
Kevin Roast 88512cf711 . Added cm:name based path support to the UITemplate component
- this component is generally used to render FreeMarker templates directly to the page - particularly useful for Dashlet pages
 - now supports an additional attribute 'templatePath' which should be set to a cm:name based path to a template for rendering
 - For example the simplest portable dashlet JSP page to render a template would look like this:

<%@ taglib uri="/WEB-INF/repo.tld" prefix="r" %>
<r:template templatePath="/Company Home/Data Dictionary/Presentation Templates/my_docs.ftl" />

 - Fixes http://issues.alfresco.com/browse/AWC-1091
. Additional helper override for resolving cm:name based webdav style paths to a NodeRef
. ClipboardItem interface javadoc and removal of obsolete methods from implementing classes

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4963 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2007-01-30 12:06:19 +00:00

79 lines
2.2 KiB
Java

/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.web.bean.clipboard;
import javax.faces.context.FacesContext;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName;
/**
* Simple class representing a single item added to the clipboard.
*
* @author Kevin Roast
*/
public interface ClipboardItem
{
/**
* @return the mode status of the clipboard item, the enum can be either Cut or Copy
*/
public ClipboardStatus getMode();
/**
* @return display label (cm:name) of the clipboard item
*/
public String getName();
/**
* @return QName type of the clipboard item
*/
public QName getType();
/**
* @return the app:icon property of the clipboard item
*/
public String getIcon();
/**
* @return the NodeRef of the clipboard item
*/
public NodeRef getNodeRef();
/**
* @return true if the item on the clipboard supports linking (.url) as a link type
*/
public boolean supportsLink();
/**
* @param viewId JSF View Id to check against
*
* @return true if the clipboard item can be pasted to the specified JSF view
*/
public boolean canPasteToViewId(String viewId);
/**
* @param fc FacesContext
* @param viewId JSF View Id to paste into
* @param action Clipboard action constant (@see org.alfresco.web.ui.repo.component.shelf.UIClipboardShelfItem)
*
* @return true on successful paste, false otherwise
*
* @throws Throwable on fatal error during paste
*/
public boolean paste(FacesContext fc, String viewId, int action) throws Throwable;
}