Class com.symantec.itools.vcafe.openapi.datatransfer.VisualCafeClipboard 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.datatransfer.VisualCafeClipboard 

Object
   |
   +----Clipboard
           |
           +----com.symantec.itools.vcafe.openapi.datatransfer.VisualCafeClipboard
public abstract class VisualCafeClipboard
extends Clipboard
Implements the mechanism used to hold and transfer data via cut/copy/paste operations.

The implementation of this class forces the native clipboard to be up to date with the java clipboard, and is extended for support of VisualObjects.

When placing a Transferable onto the clipboard, if it doesn't extend from StringSelection a new TransferableProxy object is created that wraps the Transferable. This ensures that the System Clipboard contents reflect the transferable data, even if it doesn't actually understand the 'real' contents.

When VisualObject[s] are placed onto the clipboard, a TransferableVisualObjects is created that wraps the VisualObject[s].

Version:
1.0
Author:
Symantec Internet Tools Division
Since:
VCafe 3.0
See Also:
TransferableVisualObjects, TransferableProxy, getClipboard

Constructor Index

o com.symantec.itools.vcafe.openapi.datatransfer.VisualCafeClipboard()
Constructs the VisualCafeClipboard.

Method Index

o canPasteInto(VisualObject)
Determines if the contents of Visual Cafe's native clipboard can be pasted onto/into the given VisualObject.
o containsVisualObjects()
Determines if Visual Cafe's clipboard currently contains VisualObjects.
o getContents()
Gets the VisualObjects on Visual Cafe's native clipboard.
o setContents(VisualObject[], String)
Copies the array of VisualObjects onto Visual Cafe's native clipboard.
o setContents(VisualObject, String)
Copies the VisualObject onto Visual Cafe's native clipboard.

Constructors

o VisualCafeClipboard 
public VisualCafeClipboard()
Constructs the VisualCafeClipboard.

Methods

o canPasteInto 
public abstract boolean canPasteInto(VisualObject visualObject)
Determines if the contents of Visual Cafe's native clipboard can be pasted onto/into the given VisualObject.

Parameters:
the - given VisualObject.
Returns:
false if the clipboard doesn't contain VisualObjects, or the given VisualObject cannot accept the VisualObjects on the clipboard.
o containsVisualObjects 
public abstract boolean containsVisualObjects()
Determines if Visual Cafe's clipboard currently contains VisualObjects.

Returns:
true if the clipboard contains VisualObjects, false otherwise.
o getContents 
public abstract com.symantec.itools.vcafe.openapi.VisualObject[] getContents()
Gets the VisualObjects on Visual Cafe's native clipboard. If the clipboard doesn't contain VisualObjects, null is returned.

Returns:
the clipboard's VisualObjects, or null if none.
o setContents 
public abstract void setContents(VisualObject[] visualObjects,
                                 String textValue)
Copies the array of VisualObjects onto Visual Cafe's native clipboard.

This function is provided to simplify the common task of putting a set of VisualObjects onto the clipboard.

Parameters:
visualObjects - the array of VisualObjects to copy onto the native clipboard.
textValue - the value to provide for the StringSelection flavors of the TransferableVisualObjects that is created.
See Also:
TransferableVisualObjects
o setContents 
public abstract void setContents(VisualObject visualObject,
                                 String textValue)
Copies the VisualObject onto Visual Cafe's native clipboard. This function is provided to simplify the common task of putting a VisualObject onto the clipboard.

Parameters:
visualObject - the VisualObject to copy onto the native clipboard.
textValue - the value to provide for the StringSelection flavors of the TransferableVisualObjects that is created.
See Also:
TransferableVisualObjects 
All Packages  Class Hierarchy  This Package  Previous  Next  Index