home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / EnvironmentOptionSet.java < prev    next >
Encoding:
Java Source  |  1998-10-25  |  2.5 KB  |  71 lines
  1. /*
  2.  * Copyright 1998 Symantec Corporation, All Rights Reserved.
  3.  */
  4.  
  5. package com.symantec.itools.vcafe.openapi.options;
  6.  
  7. /**
  8.  * The API used to represent and access the options of the Visual Cafe environment.
  9.  * The settings from various tabs of the "Environment Options" dialog are accessed via a
  10.  * <code>VisualCafe</code>'s <code>EnvironmentOptionSet</code>.
  11.  * <p>Use <code>VisualCafe.getEnvironmentOptionSet()</code> to get an instance of this object.
  12.  *
  13.  * @see com.symantec.itools.vcafe.openapi.VisualCafe#getEnvironmentOptionSet
  14.  * @see EnvironmentGeneralOptions
  15.  * @see EnvironmentDebuggingOptions
  16.  * @see EnvironmentDisplayOptions
  17.  * @see EnvironmentEditingOptions
  18.  */
  19. public abstract class EnvironmentOptionSet
  20. {
  21.     /**
  22.      * Gets the environment's general options.
  23.      * <p>The returned <code>EnvironmentGeneralOptions</code> object allows access to the options in the
  24.      * "General" tab of the Environment Options dialog.
  25.      *
  26.      * @return        the General tab's options.
  27.      * @see EnvironmentGeneralOptions
  28.      */
  29.     public abstract EnvironmentGeneralOptions getGeneralOptions();
  30.  
  31.     /**
  32.      * Gets the environment's debugging options.
  33.      * <p>The returned <code>EnvironmentDebuggingOptions</code> object allows access to the options in the
  34.      * "Debugging" tab of the Environment Options dialog.
  35.      *
  36.      * @return        the Debugging tab's options.
  37.      * @see EnvironmentDebuggingOptions
  38.      */
  39.     public abstract EnvironmentDebuggingOptions getDebuggingOptions();
  40.  
  41.     /**
  42.      * Gets the environment's display options.
  43.      * <p>The returned <code>EnvironmentDisplayOptions</code> object allows access to the options in the
  44.      * "Display" tab of the Environment Options dialog.
  45.      *
  46.      * @return        the Display tab's options.
  47.      * @see EnvironmentDisplayOptions
  48.      */
  49.     public abstract EnvironmentDisplayOptions getDisplayOptions();
  50.  
  51.     /**
  52.      * Gets the environment's editing options.
  53.      * <p>The returned <code>EnvironmentEditingOptions</code> object allows access to the options in the
  54.      * "Editing" tab of the Environment Options dialog.
  55.      *
  56.      * @return        the Editing tab's options.
  57.      * @see EnvironmentEditingOptions
  58.      */
  59.     public abstract EnvironmentEditingOptions getEditingOptions();
  60.  
  61.     /**
  62.      * Gets the environment's format options.
  63.      * <p>The returned <code>EnvironmentFormatOptions</code> object allows access to the options in the
  64.      * "Format" tab of the Environment Options dialog.
  65.      *
  66.      * @return        the Format tab's options.
  67.      * @see EnvironmentFormatOptions
  68.      */
  69.     public abstract EnvironmentFormatOptions getFormatOptions();
  70. }
  71.