Defined in Package.Def (version ?) Inherits from RootList
Class PackageRootList provides the functionality common to the DataPackage and Software package classes. Documentation for this class is included here as underpinnings for those classes.
Remember that if the documentation and the software (especially the definition files) disagree, always trust the software.
You probably won't use any objects of class PackageRootList. You will, however, use software packages early and often.
Instantiate: never Subclass: rarely Call its methods: rarely
You will rarely if ever call any of the methods of class PackageRootList yourself. They are listed in the table below just in case you need them.
Class PackageRootList has these methods you might call:
| Method | Description |
|---|---|
| InstallList | Objects to be installed when package is activated |
| Init | Set up fields |
| Author | Return the address card of the person or company who created the software |
| SetAuthor | Set the author field to a copy of the given author |
| Managing the install list | |
| InstallEntryCount | Return the number of entries in the install list |
| InstallEntryAt | Fill in the parameters with information from the object at the given index in the install list |
| InstallEntriesFor | |
| AddInstallEntry | Given a new object to be installed, add the proper entries to the installlist, receivers, and installparameters lists |
| RemoveInstallEntryAt | Remove the entries at the given index from each of the installation lists |
| RemoveInstallEntriesFor | Given an object, remove its corresponding entries from the installation lists |
| Activating and deactivating (wrapping and unwrapping) | |
| AutoActivate | Return the value in the autoactivate field |
| SetAutoActivate | Set the autoactivate field to the given boolean |
| CanActivate | Return true; subclasses can override to do checking and return false to prevent activation |
| ActivatedPackage | Called after activating package |
| AboutToDeactivatePackage | Called before graceful deactivate (not on card removal) |
| AboutToRemovePackage | Called before graceful removal (not on card removal) |
Class PackageRootList defines the following fields:
| Field | Type | Description |
|---|---|---|
| author | AddressCard | An address card for the author |
| installList | ObjectList | List of objects to be installed when package is activated |
| receivers | ObjectList | List of objects to be installed into |
| installFlags | FixedList | Receiver-specific parameters that are not objects |
| installParameters | ObjectList | Receiver-specific parameters that are objects |
| installTargets | Object | Which packages to install into, and which version |
| autoActivate | Boolean | If set, activate package when it is inserted |
The two system-defined subclasses of PackageRootList are DataPackage and SoftwarePackage. See the chapter on class SoftwarePackage for more information.
Since you're not likely to call any methods of class PackageRootList, this version of the documentation omits their detailed descriptions.