IClipboard

All Known Implementing Classes:

clipboard
```
public interface IClipboard
```
An IClipboard is used to access the system clipboard. You would usually get an IClipboard by calling Vm.openClipboard(). Call closeClipboard() on the clipboard when done otherwise the clipboard may remain locked.
The basic implementation only allows for the setting of Text, File Names and ImageData objects. Mechanisms for adding new types may be added externally to this interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TYPE_FILE_NAME_LIST` This is a Clipboard type that represents a list of file names.
`static String`	`TYPE_IMAGE` This is a Clipboard type that represents an eve.sys.ImageData type.
`static String`	`TYPE_TEXT` This is a Clipboard type that represents Unicode text.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`closeClipboard()` Close the clipboard.
`void`	`emptyClipboardData(String dataType)` Empty the clipboard of a particular data type if possible.
`String[]`	`getAvailableInClipboard()` Returns an array of available data types.
`Object`	`getClipboardData(String dataType)` Returns the data in the clipboard of a particular type.
`String[]`	`getClipboardFileNameList()`
`ImageData`	`getClipboardImage()`
`String`	`getClipboardText()`
`boolean`	`isAvailableInClipboard(String dataType)` Returns if a particular data type is available for retrieval from the Clipboard.
`boolean`	`isOpenClipboard()` Returns if this IClipboard is actually connected to an open clipboard.
`boolean`	`setClipboardData(String dataType, Object data)` Place the data in the clipboard.
`boolean`	`setClipboardFileNameList(String[] fileNames)`
`boolean`	`setClipboardImage(ImageData image)`
`boolean`	`setClipboardText(String text)`

- Field Detail
  - TYPE_TEXT
```
static final String TYPE_TEXT
```
    This is a Clipboard type that represents Unicode text. getClipboardData() will return a String for this type.
    
    See Also:
    
    Constant Field Values
  - TYPE_IMAGE
```
static final String TYPE_IMAGE
```
    This is a Clipboard type that represents an eve.sys.ImageData type. getClipboardData() will return an eve.sys.ImageData for this type.
    
    See Also:
    
    Constant Field Values
  - TYPE_FILE_NAME_LIST
```
static final String TYPE_FILE_NAME_LIST
```
    This is a Clipboard type that represents a list of file names. getClipboardData() will return an array of Strings for this type.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isOpenClipboard
```
boolean isOpenClipboard()
```
    Returns if this IClipboard is actually connected to an open clipboard. If it is not connected to an open clipboard then all the methods will silently fail.
    
    Returns:
    
    true if this IClipboard is actually connected to an open clipboard, false if not.
  - isAvailableInClipboard
```
boolean isAvailableInClipboard(String dataType)
```
    Returns if a particular data type is available for retrieval from the Clipboard.
    
    Parameters:
    
    dataType - on of the TYPE_XXX values.
    
    Returns:
    
    true if it is availabe, false if not.
  - getAvailableInClipboard
```
String[] getAvailableInClipboard()
```
    Returns an array of available data types.
    
    Returns:
    
    an array of available data types.
  - getClipboardData
```
Object getClipboardData(String dataType)
```
    Returns the data in the clipboard of a particular type.
    
    Parameters:
    
    dataType - the data type to retrieve.
    
    Returns:
    
    the data in the clipboard, or null if none is available.
  - setClipboardData
```
boolean setClipboardData(String dataType,
                         Object data)
```
    Place the data in the clipboard.
    
    Parameters:
    
    dataType - the data type.
    
    data - the data to store in the clipboard.
    
    Returns:
    
    true if successful, false if not.
  - emptyClipboardData
```
void emptyClipboardData(String dataType)
```
    Empty the clipboard of a particular data type if possible. It may not be possible to empty the clipboard of selected data type so this call may empty the clipboard entirely.
    
    Parameters:
    
    dataType - the data type to empty or null to empty the clipboard entirely.
  - closeClipboard
```
void closeClipboard()
```
    Close the clipboard. All further operations on this Clipboard will silently fail.
  - getClipboardFileNameList
```
String[] getClipboardFileNameList()
```
  - getClipboardImage
```
ImageData getClipboardImage()
```
  - getClipboardText
```
String getClipboardText()
```
  - setClipboardText
```
boolean setClipboardText(String text)
```
  - setClipboardImage
```
boolean setClipboardImage(ImageData image)
```
  - setClipboardFileNameList
```
boolean setClipboardFileNameList(String[] fileNames)
```

Interface IClipboard

Field Summary

Method Summary

Field Detail

TYPE_TEXT

TYPE_IMAGE

TYPE_FILE_NAME_LIST

Method Detail

isOpenClipboard

isAvailableInClipboard

getAvailableInClipboard

getClipboardData

setClipboardData

emptyClipboardData

closeClipboard

getClipboardFileNameList

getClipboardImage

getClipboardText

setClipboardText

setClipboardImage

setClipboardFileNameList