PictureObject.java

/*
** Module   : PictureObject.java
** Abstract : Represents 4GL picture object.
**
** Copyright (c) 2020-2021, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 SBI 20200525 Added 4GL picture object implementation.
** 002 SBI 20210711 Added new overloaded loadPicture method for an input argument of character type.
*/

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


/**
 * Represents 4GL picture object.
 */
public class PictureObject extends ComObject
{
   /** Stores the file system path to the picture */
   private final String imagePath;

   /** The global image identifier */
   private final int imageId;

   /** The widget id */
   private final int widgetId;

   /**
    * Creates immutable instance of this picture object
    * 
    * @param    path
    *           The file system path to the image file.
    */
   public PictureObject(String path)
   {
      this.imagePath = path;
      
      this.widgetId = WidgetId.nextID().asInt();
      
      this.imageId = LogicalTerminal.loadGlobalImage(getWidgetId(), path);
   }

   /**
    * Loads the picture object and returns the comhandle
    * 
    * @param    path
    *           The file system path to the image file.
    * 
    * @return   The comhandle to the picture object.
    */
   public static comhandle loadPicture(String path)
   {
      return new comhandle(new PictureObject(path));
   }
   
   /**
    * Loads the picture object and returns the comhandle
    * 
    * @param    path
    *           The file system path to the image file.
    * 
    * @return   The comhandle to the picture object.
    */
   public static comhandle loadPicture(character path)
   {
      return loadPicture(path.toJavaType());
   }

   /**
    * Returns this class simple name.
    * 
    * @return   "PictureObject"
    */
   @Override
   public String getActivexName()
   {
      return getClass().getSimpleName();
   }

   /**
    * Tests if there is an image given by this image path.
    * 
    * @return    True if there is an image given by this image path, otherwise false
    */
   @Override
   public boolean valid()
   {
      return this.imageId != -1;
   }

   /**
    * Tests if the image resource doesn't exist.
    */
   @Override
   public boolean unknown()
   {
      return !valid();
   }

   /**
    * Gets the system path to this image
    * 
    * @return   The image path
    */
   public String getImagePath()
   {
      return imagePath;
   }

   /**
    * Gets the global image identifier
    * 
    * @return   The global image identifier
    */
   public int getImageId()
   {
      return imageId;
   }

   /**
    * Return this widget id.
    * 
    * @return   The widget id
    */
   public int getWidgetId()
   {
      return widgetId;
   }

   /**
    * Removes the registered image.
    */
   @Override
   public void delete()
   {
      LogicalTerminal.removeGlobalImages(getWidgetId());
      
      super.delete();
   }
}