# DataObject.java

    /*
    ** Module   : DataObject.java
    ** Abstract : an implementation of IVBDataObject COM interface
    **
    ** Copyright (c) 2019-2020, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 MAG 20191021 Created initial version.
    ** 002 MAG 20200114 Added SetData for character values.
    **     EVL 20200223 Minor Javadoc fix.
    */

    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program is distributed in the hope that it will be useful,
    ** but WITHOUT ANY WARRANTY; without even the implied warranty of
    ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.ui.ocx;

    import com.goldencode.p2j.comauto.*;
    import com.goldencode.p2j.ui.*;
    import com.goldencode.p2j.util.*;

    /**
     * A server side implementation of IVBDataObject COM interface used to implement OLE Drag &amp; Drop.
     * The interface is implemented as a COM object and wrapped into a comhandle type.
     * Calls on this interface are delegated to client side {@link com.goldencode.p2j.ui.client.gui.OleDragDrop}
     * interface except files which return a comhandle of type IVBDataObjectFile COM interface.
     *
     * @author mag
     *
     */
    @SuppressWarnings("rawtypes")
    public class DataObject
    extends ComInterface
    implements IVBDataObject
    {
       /* IVBDataObjectFiles interface */
       private comhandle filesHandle;

       /**
        * Constructor.
        *
        * @param   parent
        *          Parent widget.
        */
       private DataObject(GenericWidget parent)
       {
          super(IVBDataObject.class.getName(), parent);
          this.filesHandle = DataObjectFiles.newInstance(parent);
       }

       /**
        * Factory method.
        *
        * @param   parent
        *          Parent widget.
        *
        * @return a new instance wrapped in a comhandle.
        */
       public static comhandle newInstance(GenericWidget parent)
       {
          return new comhandle(new DataObject(parent));
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "FILES")
       public comhandle files()
       {
          return filesHandle;
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "CLEAR")
       public void clear()
       {
          LogicalTerminal.getClient().oleClear();
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "GETDATA")
       public memptr getData(integer format)
       {
          if (format.isUnknown())
          {
             return new memptr();
          }

          byte[] data = LogicalTerminal.getClient().oleGetData(format.intValue(), parent.getId());
          return new memptr(data);
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "GETDATA")
       public memptr getData(Integer format)
       {
          return getData(new integer(format));
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "SETDATA")
       public void setData(memptr value, integer format)
       {
          if (value.isUnknown() || format.isUnknown())
          {
             return;
          }

          byte [] data = value.getByteArray();
          LogicalTerminal.getClient().oleSetData(data, format.intValue());
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "SETDATA")
       public void setData(memptr value, Integer format)
       {
          setData(value, new integer(format));
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "SETDATA")
       public void setData(character value)
       {
          if (value.isUnknown())
          {
             return;
          }

          byte [] data = value.toString().getBytes();
          setData(new memptr(data), CF_TEXT);
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "GETFORMAT")
       public logical getFormat(integer format)
       {
          if (format.isUnknown())
          {
             return new logical();
          }

          return new logical(LogicalTerminal.getClient().oleGetFormat(format.intValue()));
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "GETFORMAT")
       public logical getFormat(Integer format)
       {
          return getFormat(new integer(format));
       }
    }