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

  Summary

public interface  Monitor
     extends com.jconfig.DumpInfo
{
          // Fields 2
     public static final int TEST_ONLY_MASK;
     public static final String copyrightString;

          // Methods 6
     public abstract Rectangle getBounds();
     public abstract int getDepth();
     public abstract Rectangle getWorkarea();
     public abstract boolean isMainMonitor();
     public abstract int setDepth(int, int);
     public abstract int setResolution(Dimension, Dimension, int);
}

Represents a video monitor. The 'getMonitors' and 'getMainMonitor' methods of the 'FileRegistry' singleton return objects of this class.

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


  Cross Reference

Returned By:
FileRegistryI.getMainMonitor(), FileRegistryI.getMonitors(), FileRegistry.getMainMonitor(), FileRegistry.getMonitors()

Implemented By:
MonitorPlain





  Fields

· copyrightString

Summary  |  Top
   public static final String copyrightString


· TEST_ONLY_MASK

Summary  |  Top
   public static final int TEST_ONLY_MASK

See the 'setDepth' and 'setResolution' methods.


  Methods

· getBounds

Summary  |  Top

   public abstract Rectangle getBounds() 

Returns the global coordinates of the monitor. On a Mac, the upper left corner of the main monitor ( the one with the menu bar ) is at <0,0>.



· getWorkarea

Summary  |  Top
   public abstract Rectangle getWorkarea() 

Returns the 'work area' of the monitor, in global coordinates. This is the bounds, minus any menu/task bars. For instance, if the main monitor of a Mac is 640x480, and the menu bar is 20 pixels high, this will return a Rectangle where x=0, y=20, width=640, and height=460.



· getDepth

Summary  |  Top
   public abstract int getDepth() 

Returns the bit depth of the monitor. If the value returned is zero or less, an error occured.



· isMainMonitor

Summary  |  Top
   public abstract boolean isMainMonitor() 

Returns whether this is the main monitor.



· setDepth

Summary  |  Top
   public abstract int setDepth(int newDepth, 
                                int flags) 

Tries to set the indicated depth. If 'TEST_ONLY_MASK' is set in 'flags', whether this depth can be set is tested, but the depth is not changed. Returns an error code, where zero means no error occured.



· setResolution

Summary  |  Top
   public abstract int setResolution(Dimension requestedRes, 
                                     Dimension newRes, 
                                     int flags) 

Tries to set the indicated resolution. If 'TEST_ONLY_MASK' is set in 'flags', whether this resolution can be set is tested, but the resolution is not changed. On exit, 'newRes' contains the closest resolution possible. Returns an error code, where zero means no error occured.



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