DataObjectFiles.java

/*
** Module   : DataObjectFiles.java
** Abstract : an implementation of IVBDataObjectFiles COM interface
**
** Copyright (c) 2019, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 MAG 20191021 Created initial version.
*/

/*
** 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.*;

/**
 * An server side implementation of IVBDataObjectFiles COM interface used to implement in Drag & Drop.
 * The interface is implemented as a COM object and wrapped into a comhandle type.
 * All calls to this interface are delegated to the client side implementation of IVBDataObjectFiles 
 * interface. {@link com.goldencode.p2j.ui.client.gui.DragDropHelper}
 * 
 * @author mag
 *
 */
@SuppressWarnings("rawtypes")
public class DataObjectFiles 
extends ComInterface
implements IVBDataObjectFiles
{
   /**
    * Constructor.
    * 
    * @param   parent
    *          Parent widget.
    */
   private DataObjectFiles(GenericWidget parent)
   {
      super(IVBDataObjectFiles.class.getName(), 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 DataObjectFiles(parent));
   }

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

   /**
    * {@inheritDoc}
    */
   @ComProperty(name = "COUNT")
   public integer count()
   {
      return new integer(LogicalTerminal.getClient().getNumDroppedFiles());
   }

   /**
    * {@inheritDoc}
    */
   @ComProperty(name = "ITEM")
   public character item(integer index)
   {
      if (index.isUnknown())
         return new character();
      
      return new character(LogicalTerminal.getClient().getDroppedFile(index.intValue()));
   }

   /**
    * {@inheritDoc}
    */
   @ComProperty(name = "ITEM")
   public character item(Integer index)
   {
      return item(new integer(index));
   }

   /**
    * {@inheritDoc}
    */
   @ComMethod(name = "ADD")
   public void add(character fileName)
   {
      if (fileName.isUnknown())
         return;
      
      LogicalTerminal.getClient().addDroppedFileName(fileName.toStringMessage());
   }

   /**
    * {@inheritDoc}
    */
   @ComMethod(name = "ADD")
   public void add(String fileName)
   {
      add(new character(fileName));
   }

   /**
    * {@inheritDoc}
    */
   @ComMethod(name = "ADD")
   public void add(character fileName, integer index)
   {
      if (fileName.isUnknown() || index.isUnknown())
         return;
      
      LogicalTerminal.getClient().addDroppedFileName(fileName.toStringMessage(), index.intValue());
   }

   /**
    * {@inheritDoc}
    */
   @ComMethod(name = "ADD")
   public void add(String fileName, integer index)
   {
      add(new character(fileName), index);
   }

   /**
    * {@inheritDoc}
    */
   @ComMethod(name = "ADD")
   public void add(character fileName, Integer index)
   {
      add(fileName, new integer(index));
   }

   @ComMethod(name = "ADD")
   public void add(String fileName, Integer index)
   {
      add(new character(fileName), new integer(index));
   }

   /**
    * {@inheritDoc}
    */
   @ComMethod(name = "REMOVE")
   public void remove(integer index)
   {
      if (index.isUnknown())
         return;

      LogicalTerminal.getClient().removeDroppedFile(index.intValue());
   }

   @ComMethod(name = "REMOVE")
   public void remove(Integer index)
   {
      remove(new integer(index));
   }
}