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.AppProcess

  Summary

public interface  AppProcess
     extends com.jconfig.DumpInfo
{
          // Fields 5
     public static final int APP_MOVE_MAXIMIZE;
     public static final int APP_MOVE_MINIMIZE;
     public static final int APP_MOVE_TOBACK;
     public static final int APP_MOVE_TOFRONT;
     public static final String copyrightString;

          // Methods 7
     public abstract AppCommand[] getAllCommands();
     public abstract AppFile getAppFile();
     public abstract AppCommand getCommand(String);
     public abstract int[] getPlatformData();
     public abstract boolean isRunning();
     public abstract int move(AppProcess, int, int);
     public abstract int performCommand(AppCommand, int);
}

Represents a currently running instance of an application. Objects of this type are created using the 'performCommand' method of an AppFile object.

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


  Cross Reference

Returned By:
AppFile.getInstances(), AppFile.performCommand(), FileRegistryI.getProcesses(), FileRegistryPlain.getProcesses(), FileRegistry.getProcesses(), AppFileMRJ.getInstances(), AppFileMRJ.performCommand(), AppFileOSX.getInstances(), AppFileOSX.performCommand(), FileRegistryMRJ.getProcesses(), ProcessHelperMRJ.getProcesses(), AppFileCommandMgrNix.performCommand(), AppFileNix.getInstances(), AppFileNix.performCommand(), FileRegistryNix.getProcesses(), AppFileCommandMgrMSVM.performCommand(), AppFileMSVM.getInstances(), AppFileMSVM.performCommand(), FileRegistryMSVM.getProcesses(), ProcessHelperMSVM.getProcesses(), Tester.tryOpenApp(), Tester.tryOpenAppWithDoc()

Implemented By:
AppProcessMRJ, AppProcessNix, AppProcessMSVM





  Fields

· copyrightString

Summary  |  Top
   public static final String copyrightString


· APP_MOVE_TOFRONT

Summary  |  Top
   public static final int APP_MOVE_TOFRONT

See the move() method.


· APP_MOVE_TOBACK

Summary  |  Top
   public static final int APP_MOVE_TOBACK

See the move() method.


· APP_MOVE_MINIMIZE

Summary  |  Top
   public static final int APP_MOVE_MINIMIZE

See the move() method.


· APP_MOVE_MAXIMIZE

Summary  |  Top
   public static final int APP_MOVE_MAXIMIZE

See the move() method.


  Methods

· getAppFile

Summary  |  Top

   public abstract AppFile getAppFile() 

Returns the AppFile object from which this object was created.



· 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 instance can accept.



· performCommand

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

Performs the indicated command. If the command is not one of those recognized by this application, an IllegalArgumentException exception is thrown. Returns an error code; if this is non-zero, an error occurred.

Parameter Description
flags reserved; set to 0



· move

Summary  |  Top
   public abstract int move(AppProcess fromProcess, 
                            int selector, 
                            int flags) 

Used to minimize, maximize this process, or send it in front of or behind other processes, if possible.

Parameter Description
fromProcess reserved; set to null
selector one of the values: APP_MOVE_TOFRONT, APP_MOVE_TOBACK, APP_MOVE_MINIMIZE, APP_MOVE_MAXIMIZE
flags reserved; set to 0



· isRunning

Summary  |  Top
   public abstract boolean isRunning() 

Indicates whether this instance is indeed still running.



· getPlatformData

Summary  |  Top
   public abstract int[] getPlatformData() 

Returns platform-specific data for this process.
On MRJ/PowerMac, the return array contains the ProcessSerialNumber for this process, lowLongOfPSN in the first element of the array, highLongOfPSN in the second.
On MS VM/Win95, the return array contains five 32-bit values: the first element of the array contains the HWND for the main window of the main thread of the process, and the next four elements contain the PROCESS_INFORMATION struct from the call to CreateProcess, with 'hProcess' at the second element of the array, etc.
Other platforms: TBA.



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