Main Page
    Cookbook/Overview     ImageMeister     the jcprops file     Licensing
    Binary Installation & Configuration [ Win · Mac · Nix · OSX ]     Changes
    Public API
    Source Code Main Page
        Java [ Common · Win · Mac · Nix ]     Native Code [ Common · Win · Mac · Nix ]     Manifest
        Native Code Overviews [ Common · Win · Mac · Nix · Strings ]     Macros [ General · Native Macros ]
        Walkthroughs [ Java only · Java and native ]     Building [ Win · Mac · Nix · OSX ]     Distribution Issues

All Packages  This Package  Class Hierarchy  Class Search  Index

Interface com.jconfig.AppFile

  Summary

public interface  AppFile
     extends com.jconfig.DiskFile
{
          // Fields 27
     public static final int AF_32;
     public static final int AF_68K;
     public static final int AF_ACTIVATE_FG;
     public static final int AF_APPE;
     public static final int AF_APP_DIED_MSG;
     public static final int AF_CAN_BG;
     public static final int AF_CFM68;
     public static final int AF_DESKACC;
     public static final int AF_DISPLAYMANAGER;
     public static final int AF_DOS;
     public static final int AF_FRONT_CLICKS;
     public static final int AF_HLE_AWARE;
     public static final int AF_LOCAL_REMOTE_EVENTS;
     public static final int AF_MULTILAUNCH;
     public static final int AF_NO_LAYER_SWITCH;
     public static final int AF_OS216;
     public static final int AF_OSXPACKAGE;
     public static final int AF_PEF;
     public static final int AF_PIF;
     public static final int AF_POSIX;
     public static final int AF_STAT_AWARE;
     public static final int AF_SUSPEND_RESUME;
     public static final int AF_UNKNOWN;
     public static final int AF_USE_TES;
     public static final int AF_W32;
     public static final int AF_WOW;
     public static final String copyrightString;

          // Methods 11
     public abstract String executableTypeToString(int);
     public abstract AppCommand[] getAllCommands();
     public abstract AppCommand getCommand(String);
     public abstract int getExecutableType();
     public abstract FileType[] getFileTypes(int);
     public abstract IconBundle getIconBundle(FileType);
     public abstract AppProcess[] getInstances();
     public abstract int getMinimumPartition();
     public abstract int getSizeFlags();
     public abstract int getSuggestedPartition();
     public abstract AppProcess performCommand(AppCommand, int);
}

Interface for objects which represent an application's disk file. This does not represent a running instance of the application, only the file. Arrays of objects of this class are returned from the 'getApps()' methods of the FileRegistry class.

Author:
Copyright (c) 1997-2002 Samizdat Productions. All Rights Reserved.


  Cross Reference

Returned By:
Many

Implemented By:
AppFileMRJ, AppFileOSX, AppFileNix, AppFileMSVM





  Fields

· copyrightString

Summary  |  Top
   public static final String copyrightString


· AF_NO_LAYER_SWITCH

Summary  |  Top
   public static final int AF_NO_LAYER_SWITCH

Used with the performCommand() method.


· AF_DISPLAYMANAGER

Summary  |  Top
   public static final int AF_DISPLAYMANAGER

A Mac-specific flag returned by the getSizeFlags method.


· AF_USE_TES

Summary  |  Top
   public static final int AF_USE_TES

A Mac-specific flag returned by the getSizeFlags method.


· AF_STAT_AWARE

Summary  |  Top
   public static final int AF_STAT_AWARE

A Mac-specific flag returned by the getSizeFlags method.


· AF_LOCAL_REMOTE_EVENTS

Summary  |  Top
   public static final int AF_LOCAL_REMOTE_EVENTS

A Mac-specific flag returned by the getSizeFlags method.


· AF_HLE_AWARE

Summary  |  Top
   public static final int AF_HLE_AWARE

A Mac-specific flag returned by the getSizeFlags method.


· AF_32

Summary  |  Top
   public static final int AF_32

A Mac-specific flag returned by the getSizeFlags method.


· AF_APP_DIED_MSG

Summary  |  Top
   public static final int AF_APP_DIED_MSG

A Mac-specific flag returned by the getSizeFlags method.


· AF_FRONT_CLICKS

Summary  |  Top
   public static final int AF_FRONT_CLICKS

A Mac-specific flag returned by the getSizeFlags method.


· AF_APPE

Summary  |  Top
   public static final int AF_APPE

A Mac-specific flag returned by the getSizeFlags method.


· AF_ACTIVATE_FG

Summary  |  Top
   public static final int AF_ACTIVATE_FG

A Mac-specific flag returned by the getSizeFlags method.


· AF_CAN_BG

Summary  |  Top
   public static final int AF_CAN_BG

A Mac-specific flag returned by the getSizeFlags method.


· AF_SUSPEND_RESUME

Summary  |  Top
   public static final int AF_SUSPEND_RESUME

A Mac-specific flag returned by the getSizeFlags method.


· AF_MULTILAUNCH

Summary  |  Top
   public static final int AF_MULTILAUNCH

A Mac-specific flag returned by the getSizeFlags method.


· AF_DESKACC

Summary  |  Top
   public static final int AF_DESKACC

A Mac-specific flag returned by the getSizeFlags method.


· AF_W32

Summary  |  Top
   public static final int AF_W32

Returned by the getExecutableType method.


· AF_DOS

Summary  |  Top
   public static final int AF_DOS

Returned by the getExecutableType method.


· AF_WOW

Summary  |  Top
   public static final int AF_WOW

Returned by the getExecutableType method.


· AF_PIF

Summary  |  Top
   public static final int AF_PIF

Returned by the getExecutableType method.


· AF_POSIX

Summary  |  Top
   public static final int AF_POSIX

Returned by the getExecutableType method.


· AF_OS216

Summary  |  Top
   public static final int AF_OS216

Returned by the getExecutableType method.


· AF_PEF

Summary  |  Top
   public static final int AF_PEF

Returned by the getExecutableType method.


· AF_CFM68

Summary  |  Top
   public static final int AF_CFM68

Returned by the getExecutableType method.


· AF_68K

Summary  |  Top
   public static final int AF_68K

Returned by the getExecutableType method.


· AF_UNKNOWN

Summary  |  Top
   public static final int AF_UNKNOWN

Returned by the getExecutableType method.


· AF_OSXPACKAGE

Summary  |  Top
   public static final int AF_OSXPACKAGE

Returned by the getExecutableType method.


  Methods

· getIconBundle

Summary  |  Top

   public abstract IconBundle getIconBundle(FileType ft) 

Returns the IconBundle associated with this application. May return null if the application's icons can't be found.



· getFileTypes

Summary  |  Top
   public abstract FileType[] getFileTypes(int maxToReturn) 

Returns the set of FileType's which are associated with this application. May return null if no file types could be determined.

Parameter Description
maxToReturn the maximum number of file types requested. The actual number returned may be less or more than the requested amount.



· getCommand

Summary  |  Top
   public abstract AppCommand getCommand(String commandName) 

Returns the indicated command. The 'commandName' argument is one of the constants defined in the AppCommand interface. If this instance cannot accept commands of the indicated type, null is returned.
After retrieving a command using this method, you can add arguments to it, if desired, and then pass the command to the 'performCommand' method to execute the command.



· getAllCommands

Summary  |  Top
   public abstract AppCommand[] getAllCommands() 

Returns all the commands which this application can accept.



· performCommand

Summary  |  Top
   public abstract AppProcess performCommand(AppCommand command, 
                                             int flags) 

Performs the indicated command. If an error occurs, or if that command does not cause the creation of a new instance of the application, returns null. Otherwise, returns an AppProcess object representing the new application instance. To open the instance in the background, OR the flags argument with 'AF_NO_LAYER_SWITCH'. If the command is not one of those recognized by this application, an IllegalArgumentException exception is thrown.



· getInstances

Summary  |  Top
   public abstract AppProcess[] getInstances() 

Returns the set of all instances of this application currently running.



· getExecutableType

Summary  |  Top
   public abstract int getExecutableType() 

Indicates the architecture of this application. Returns one of the preceding constants.



· getSizeFlags

Summary  |  Top
   public abstract int getSizeFlags() 

Mac-specific method which returns the 'SIZE' flags for this application.



· getMinimumPartition

Summary  |  Top
   public abstract int getMinimumPartition() 

Mac-specific method which returns the minimum memory space which an instance of this application would occupy.



· getSuggestedPartition

Summary  |  Top
   public abstract int getSuggestedPartition() 

Mac-specific method which returns the suggested memory space which an instance of this application would occupy.



· executableTypeToString

Summary  |  Top
   public abstract String executableTypeToString(int f) 

Convenience method which converts the return value of getExecutableType() into a string representation.



All Packages  This Package  Class Hierarchy  Class Search  Index
Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7