Class PropertiesTransfer


public class PropertiesTransfer extends ByteArrayTransfer
The transfer class for properties in clip board or for drag-drop. The PropertiesTransfer class is used to transfer an array of GProp from one part to another in a drag and drop operation or a cut, copy, paste action.

This class can be used for a Viewer or an SWT component directly. A singleton is provided which may be serially reused (see getInstance). It is not intended to be sub classed.

Author:
Christopher Mindus
  • Field Details

  • Method Details

    • getInstance

      public static PropertiesTransfer getInstance()
      Gets the instance.
      Returns:
      The instance for properties transfer.
    • getTypeNames

      protected String[] getTypeNames()
      Returns the platform specific names of the data types that can be converted using this transfer agent.
      Specified by:
      getTypeNames in class Transfer
    • getTypeIds

      protected int[] getTypeIds()
      Returns the platform specific Ids of the data types that can be converted using this transfer agent.
      Specified by:
      getTypeIds in class Transfer
    • createDndTransferData

      public TransferData createDndTransferData(ArrayList<DesignerProp> list)
      Creates a TransferData from a list of selected properties, where TransferData is typically used in drag-drop operations.
      Parameters:
      list - The list of properties.
      Returns:
      The TransferData instance, or null if list is empty.
    • validate

      protected boolean validate(Object object)
      Test that the object is of the correct format for this Transfer class.
      Overrides:
      validate in class Transfer
      Parameters:
      object - a Java representation of the data to be converted.
      Returns:
      true if object is of the correct form for this transfer type.
    • javaToNative

      public void javaToNative(Object object, TransferData transferData)
      Converts the properties into a platform specific representation.
      Overrides:
      javaToNative in class ByteArrayTransfer
      Parameters:
      object - A Java byte[] containing the data to be converted.
      transferData - An empty TransferData object that will be filled in on return with the platform specific format of the data.
    • nativeToJava

      public Object nativeToJava(TransferData transferData)
      Converts a platform specific representation of a byte array to a GProp[].
      Overrides:
      nativeToJava in class ByteArrayTransfer
      Parameters:
      transferData - The platform specific representation of the data to be converted.
      Returns:
      A Java byte[] containing the converted data if the conversion was successful; otherwise null.