# ListImage.java

    /*
    ** Module   : ListImage.java
    ** Abstract : an implementation of IImage COM interface
    **
    ** Copyright (c) 2019-2020, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 MAG 20191106 Created initial version.
    ** 002 SBI 20200520 Added detached instance constructor and two fields to hold index and key.
    **         20200529 Changed to use PictureObject, implemented all required methods.
    */

    /*
    ** 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 IImage COM interface
     *
     * @author mag
     *
     */
    @SuppressWarnings("rawtypes")
    public class ListImage
    extends ComInterface
    implements IImage
    {
       /** The 4GL pictute object */
       private comhandle picture;

       /** The extra data associated with this image */
       private BaseDataType tag;

       /** Self instance reference */
       private comhandle self;

       /**
        * Constructor.
        *
        * @param   parent
        *          Parent widget.
        */
       private ListImage(GenericWidget parent)
       {
          this(parent, null);
       }

       /**
        * Constructor.
        *
        * @param   parent
        *          Parent widget.
        */
       private ListImage(GenericWidget parent, comhandle picture)
       {
          super(IImage.class.getName(), parent);

          setPicture(picture);
       }

       /**
        * Factory method.
        *
        * @param   parent
        *          Parent widget.
        *
        * @return a new instance wrapped in a comhandle.
        */
       public static comhandle newInstance(GenericWidget parent, comhandle picture)
       {
          ListImage comObject = new ListImage(parent, picture);
          comhandle selfReference = new comhandle(comObject);
          comObject.self = selfReference;
          comhandle.resourceId(comObject);

          return selfReference;
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "DRAW")
       public void draw(integer hDC, integer x, integer y, integer style)
       {
          // nop
       }

       /**
        * {@inheritDoc}
        */
       @ComMethod(name = "EXTRACTICON")
       public memptr extractIcon()
       {
          return new memptr();
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "INDEX")
       public integer getIndex()
       {
          ListImages listImages = getListImages();

          if (listImages == null)
          {
             return new integer();
          }

          int index = listImages.findIndex(self);

          if (index != -1)
          {
             return new integer(index + 1);
          }

          return new integer();
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "INDEX")
       public void setIndex(integer index)
       {
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "KEY")
       public character getKey()
       {
          ListImages listImages = getListImages();

          if (listImages == null)
          {
             return new character();
          }

          return new character(listImages.findKey(self));
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "KEY")
       public void setKey(character key)
       {
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "PICTURE")
       public comhandle getPicture()
       {
          if (picture == null)
          {
             return new comhandle();
          }

          return picture;
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "PICTURE")
       public void setPicture(comhandle picture)
       {
          // reduce the ref count for the current picture
          reducePictureRefCount();

          this.picture = picture;

          ComObject unwrappedPicture = getPicture().getResource();

          if (unwrappedPicture != null)
          {
             unwrappedPicture.ref();
          }
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "TAG")
       public BaseDataType getTag()
       {
          if (tag == null)
          {
             return new character();
          }

          return tag;
       }

       /**
        * {@inheritDoc}
        */
       @ComProperty(name = "TAG")
       public void setTag(BaseDataType tag)
       {
          this.tag = tag;
       }

       /**
        * Clears the consumed resources.
        */
       @Override
       public void delete()
       {
          reducePictureRefCount();

          super.delete();
       }

       /**
        * Reduces the reference counter of the current picture object in order that it can be deleted.
        */
       private void reducePictureRefCount()
       {
          ComObject unwrappedPicture = getPicture().getResource();

          if (unwrappedPicture != null)
          {
             unwrappedPicture.deref();
          }
       }

       /**
        * Unwrap list images object.
        *
        * @return   The ListImages instance, the container of list image objects.
        */
       private ListImages getListImages()
       {
          if (parent instanceof ImageListWidget)
          {
             return ((ImageListWidget) parent).getListImages().unwrapListImages();
          }

          return null;
       }
    }