Class com.symantec.itools.vcafe.openapi.ComponentLibrary 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.ComponentLibrary 

Object
   |
   +----com.symantec.itools.vcafe.openapi.ComponentLibrary
public abstract class ComponentLibrary
extends Object
implements VisualRepository
The API used to represent and access the Component Library in Visual Cafe.

Version:
1.0
Author:
Symantec Internet Tools Division
Since:
VCafe 3.0
See Also:
VisualRepository, getComponentLibrary

Constructor Index

o com.symantec.itools.vcafe.openapi.ComponentLibrary()

Method Index

o addClassToLibrary(File)
Adds a class file to the Component Library in Visual Cafe.
o addJarToLibrary(File)
Adds a jar file to the Component Library in Visual Cafe.
o addObject(VisualObject, VisualObject, VisualObject)
Add a VisualObject to the repository.
o addObjectBefore(VisualObject, VisualObject, VisualObject)
Add a VisualObject to the repository
o getChildren(VisualObject)
Obtain the list of children VisualObjects of a given VisualObject in the repository tree.
o getObject(int)
Obtain a VisualObject with the given id.
o getObjects()
Obtain the list of all top level objects in the repository (children of the Root Object).
o getRootObject()
Obtain the root VisualObject in the repository tree.
o insertGroup(String, VisualObject)
Adds a group to the Component Library.
o insertObject(VisualObject, VisualObject, int)
Insert a VisualObject at a particular location in the repository
o removeObject(VisualObject)
Remove a given VisualObject from the repository.

Constructors

o ComponentLibrary 
public ComponentLibrary()

Methods

o addClassToLibrary 
public abstract boolean addClassToLibrary(File classFile)
Adds a class file to the Component Library in Visual Cafe. This performs the same action as using the Visual Cafe menus to insert a Component into the library (Insert -> Component into Library). Errors are reported in Visual Cafe's message window. Could fail if the classFile isn't actually a class file, or if the classFile isn't on the classpath.

Parameters:
classFile - the class file to be added.
Returns:
true if the class file was successfully added, false otherwise.
o addJarToLibrary 
public abstract void addJarToLibrary(File jarFile)
Adds a jar file to the Component Library in Visual Cafe. This performs the same action as using the Visual Cafe menus to insert a Component into the library (Insert -> Component into Library). Errors are reported in Visual Cafe's message window.

Parameters:
jarFile - the jar file to be added.
o insertGroup 
public abstract com.symantec.itools.vcafe.openapi.VisualObject insertGroup(String name,
                                                                           VisualObject insertionLocation)
Adds a group to the Component Library. If a group with the given name at insertionLocation already exists, it is returned instead of a new one.

Parameters:
name - the name for the new group.
insertionLocation - where to insert the group. If null, the group is inserted at the root of the component library. If insertionLocation is a group, the new group is created within it. Otherwise, the new group is created after insertionLocation.
Returns:
the new group. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index