frameworkplugins/com.nokia.s60tools.ui/src/com/nokia/s60tools/ui/ICopyActionHandler.java
author dpodwall
Tue, 12 Jan 2010 13:17:53 -0600
changeset 0 61163b28edca
permissions -rw-r--r--
initial EPL conversion
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     1
/*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     2
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     3
* All rights reserved.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     4
* This component and the accompanying materials are made available
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     6
* which accompanies this distribution, and is available
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     8
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
     9
* Initial Contributors:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    11
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    12
* Contributors:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    13
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    14
* Description:
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    15
*
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    16
*/
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    17
 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    18
 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    19
package com.nokia.s60tools.ui;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    20
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    21
import java.util.List;
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    22
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    23
/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    24
 * Defines common interface used by copy handler
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    25
 * clients. Clients can have a set of possible 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    26
 * copy handler implementations, and this
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    27
 * interface helps to select correct implementation
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    28
 * for the object type at hand.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    29
 * 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    30
 * Copy handlers are implemented by subclassing
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    31
 * <code>AbstractTextClipboardCopyHandler</code> class .
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    32
 * 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    33
 * There should be only one copy handler defined per object 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    34
 * type.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    35
 * 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    36
 * @see com.nokia.s60tools.ui.AbstractTextClipboardCopyHandler
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    37
 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    38
public interface ICopyActionHandler {
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    39
	
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    40
	/**
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    41
	 * This methods tests if the given object type is supported, 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    42
	 * and copies object data to the clipboard if the object 
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    43
	 * type was supported.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    44
	 * @param objectsToCopyList List of objects to perform copy for.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    45
	 * @return Returns <code>true</code> if the object type was
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    46
	 *         recognized and copy was performed, otherwise returns
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    47
	 *         <code>false</code>.
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    48
	 */
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    49
	public boolean acceptAndCopy(List<Object> objectsToCopyList);
61163b28edca initial EPL conversion
dpodwall
parents:
diff changeset
    50
}