TreeViewNodeObject.java

/*
** Module   : TreeViewNodeObject.java
** Abstract : A COM wrapper for a TreeView node resource.
**
** Copyright (c) 2020, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 MAG 20200203 Created initial version.
**     EVL 20200223 Minor Javadoc fix.
**     VVT 20210630 Using generics in the TREELIST/TREEVIEW implementation eliminated:
**                  TreeViewNodeResource replaced by TreeNodeResource.
**                  See discussion in #5118.
*/

/*
** 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 COM wrapper for a TreeView node resource.
 * 
 * @author mag
 *
 */
public class TreeViewNodeObject
extends ComObject
{
   /** TreeView node */
   private final TreeNodeResource node;
   
   /**
    * Constructor.
    * 
    * @param   node
    *          Node entry.
    */
   private TreeViewNodeObject(final TreeNodeResource node)
   {
      this.node = node;
   }
   
   /**
    * Factory method.
    * 
    * @param   node
    *          Node entry.
    *          
    * @return a new instance wrapped as a comhandle.
    */
   public static comhandle newInstance(final TreeNodeResource node)
   {
      return node == null ? new comhandle() : new comhandle(new TreeViewNodeObject(node));
   }
   
   @Override
   public boolean valid()
   {
      return false;
   }

   @Override
   public void delete()
   {
      // no op
   }

   @Override
   public String getActivexName()
   {
      return TreeViewNodeResource.class.getName();
   }
   
   /**
   * Retrieve node ID
   * 
   * @return   Node ID
   */
   @ComProperty(name = "INDEX")
   public integer getIndex()
   {
      return new integer(node.getNodeId());
   }
   
   /**
   * Retrieve node text
   * 
   * @return   Node text
   */
   @ComProperty(name = "TEXT")
   public character getText()
   {
      return node.getNodeText();
   }

   /**
   * Retrieve node key
   * 
   * @return   Node key
   */
   @ComProperty(name = "KEY")
   public character getKey()
   {
      return node.getNodeKey();
   }
   
   /**
   * Retrieve node image.
   * 
   * @return   Node image.
   */
   @ComProperty(name = "IMAGE")
   public integer getImage()
   {
      return node.getNodeIcon();
   }

   /**
   * Retrieve node selected image.
   * 
   * @return   Node selected image.
   */
   @SuppressWarnings("static-method")
   @ComProperty(name = "SELECTEDIMAGE")
   public integer getSelectedImage()
   {
      // FIXME selected image is not yet implemented in TreeView
      return new integer();
   }
}