home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / ComponentLibrary.java < prev    next >
Text File  |  1998-10-25  |  2KB  |  55 lines
  1. /*
  2.  * Copyright 1998 Symantec Corporation, All Rights Reserved.
  3.  */
  4.  
  5. package com.symantec.itools.vcafe.openapi;
  6.  
  7.  
  8. /**
  9.  * The API used to represent and access the Component Library in
  10.  * Visual Cafe.
  11.  * @see VisualRepository
  12.  * @see VisualCafe#getComponentLibrary
  13.  *
  14.  * @author Symantec Internet Tools Division
  15.  * @version 1.0
  16.  * @since VCafe 3.0
  17.  */
  18. public abstract class ComponentLibrary implements VisualRepository
  19. {
  20.     /**
  21.      * Adds a group to the Component Library.  If a group with the given name at insertionLocation
  22.      * already exists, it is returned instead of a new one.
  23.      *
  24.      * @param name                the name for the new group.
  25.      * @param insertionLocation    where to insert the group.  If null, the group is inserted
  26.      *                            at the root of the component library. If insertionLocation is
  27.      *                            a group, the new group is created within it.  Otherwise, the new
  28.      *                            group is created after insertionLocation.
  29.      * @return                    the new group.
  30.      */
  31.     public abstract VisualObject insertGroup(String name, VisualObject insertionLocation);
  32.  
  33.     /**
  34.      * Adds a jar file to the Component Library in Visual Cafe.
  35.      * This performs the same action as using the Visual Cafe menus to insert a Component into
  36.      * the library (Insert -> Component into Library).
  37.      * Errors are reported in Visual Cafe's message window.
  38.      *
  39.      * @param jarFile       the jar file to be added.
  40.      */
  41.     public abstract void addJarToLibrary(java.io.File jarFile);
  42.  
  43.     /**
  44.      * Adds a class file to the Component Library in Visual Cafe.
  45.      * This performs the same action as using the Visual Cafe menus to insert a Component into
  46.      * the library (Insert -> Component into Library).
  47.      * Errors are reported in Visual Cafe's message window.
  48.      * Could fail if the classFile isn't actually a class file, or if the classFile isn't on the classpath.
  49.      *
  50.      * @param classFile       the class file to be added.
  51.      * @return <code>true</code> if the class file was successfully added, <code>false</code> otherwise.
  52.      */
  53.      public abstract boolean addClassToLibrary(java.io.File classFile);
  54. }
  55.