home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / EnvironmentEditingOptions.java < prev    next >
Text File  |  1998-10-25  |  6KB  |  157 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 editing-related options of the Visual Cafe environment.
  9.  * These options that appear in the "Editing" tab in the Environment Options dialog.
  10.  * <p>Use <code>EnvironmentOptionSet.getEditingOptions()</code> to get an instance of this object.
  11.  *
  12.  * @see com.symantec.itools.vcafe.openapi.VisualCafe#getEnvironmentOptionSet
  13.  * @see EnvironmentOptionSet#getEditingOptions
  14.  *
  15.  * @author Symantec Internet Tools Division
  16.  * @version 1.0
  17.  * @since VCafe 3.0
  18.  */
  19. public abstract class EnvironmentEditingOptions
  20. {
  21.         /**
  22.          * Indicates the text cursor will be a block when the editor is in insert mode.
  23.          * @see #getInsert
  24.          */
  25.         public static final int        INSERT_BLOCK = 0;
  26.         /**
  27.          * Indicates the text cursor will be an underline when the editor is in insert mode.
  28.          * @see #getInsert
  29.          */
  30.         public static final int        INSERT_UNDERLINE = 1;
  31.         /**
  32.          * Indicates the text cursor will be a vertical bar when the editor is in insert mode (default).
  33.          * @see #getInsert
  34.          */
  35.         public static final int        INSERT_VERTICALBAR = 2;
  36.  
  37.     /**
  38.      * Gets the type of text cursor displayed when the editor is in insert mode.
  39.      * <p> The "Insert" key toggles between insert and overwrite modes.
  40.      * @return One of:<ul type=circle>
  41.      * <li>INSERT_BLOCK - a block text cursor,
  42.      * <li>INSERT_UNDERLINE - an underline text cursor, or
  43.      * <li>INSERT_VERTICALBAR - a vertical bar text cursor (default).
  44.      * </ul>
  45.      */
  46.     public abstract int getInsert();
  47.  
  48.     /**
  49.      * Determines whether the text cursor will blink while the editor is in insert mode.
  50.      * <p>The default is <code>true</code>.
  51.      * @return <code>true</code> if the cursor will blink, <code>false</code> otherwise.
  52.      */
  53.     public abstract boolean isInsertBlink();
  54.  
  55.         /**
  56.          * Indicates the text cursor will be a block when the editor is in overwrite mode (default).
  57.          * @see #getOverwrite
  58.          */
  59.         public static final int        OVERWRITE_BLOCK = 0;
  60.         /**
  61.          * Indicates the text cursor will be an underline when the editor is in overwrite mode.
  62.          * @see #getOverwrite
  63.          */
  64.         public static final int        OVERWRITE_UNDERLINE = 1;
  65.         /**
  66.          * Indicates the text cursor will be a vertical bar when the editor is in overwrite mode.
  67.          * @see #getOverwrite
  68.          */
  69.         public static final int        OVERWRITE_VERTICALBAR = 2;
  70.  
  71.     /**
  72.      * Gets the type of text cursor displayed when the editor is in overwrite mode.
  73.      * <p> The "Insert" key toggles between insert and overwrite modes.
  74.      * @return One of:<ul type=circle>
  75.      * <li>OVERWRITE_BLOCK - a block text cursor (default),
  76.      * <li>OVERWRITE_UNDERLINE - an underline text cursor, or
  77.      * <li>OVERWRITE_VERTICALBAR - a vertical bar text cursor.
  78.      * </ul>
  79.      */
  80.     public abstract int getOverwrite();
  81.  
  82.     /**
  83.      * Determines whether the text cursor will blink while the editor is in overwrite mode.
  84.      * <p>The default is <code>true</code>.
  85.      * @return <code>true</code> if the cursor will blink, <code>false</code> otherwise.
  86.      */
  87.     public abstract boolean isOverwriteBlink();
  88.  
  89.     /**
  90.      * Determines whether the Class Browser and Hierarchy Editor will ask for confirmation before
  91.      * deleting a class member.
  92.      * <p>The default is <code>true</code>.
  93.      * @return <code>true</code> if deletions are confirmed, <code>false</code> otherwise.
  94.      */
  95.     public abstract boolean isConfirmDeleteMember();
  96.  
  97.     /**
  98.      * Determines whether the Class Browser and Hierarchy Editor will ask for confirmation before
  99.      * changing the inheritance of a class.
  100.      * <p>The default is <code>true</code>.
  101.      * @return <code>true</code> if inheritance changes are confirmed, <code>false</code> otherwise.
  102.      */
  103.     public abstract boolean isConfirmInheritanceChange();
  104.  
  105.         /**
  106.          * Indicates the you cannot select (and change) multiple classes in the Class Browser and
  107.          * Hierarchy Editor.
  108.          * @see #getMultipleSelection
  109.          */
  110.         public static final int        MULTIPLESELECTION_NO = 0;
  111.         /**
  112.          * Indicates the you can select (and change) multiple classes in the Class Browser and
  113.          * Hierarchy Editor.
  114.          * @see #getMultipleSelection
  115.          */
  116.         public static final int        MULTIPLESELECTION_YES = 1;
  117.         /**
  118.          * Indicates the you can select (and change) multiple classes in the Class Browser and
  119.          * Hierarchy Editor, but changes to multiple selections require confirmation (default).
  120.          * @see #getMultipleSelection
  121.          */
  122.         public static final int        MULTIPLESELECTION_CONFIRM = 2;
  123.  
  124.     /**
  125.      * Gets the multiple selection mode of the Class Browser and Hierarchy Editor.
  126.      * @return One of:<ul type=circle>
  127.      * <li>MULTIPLESELECTION_NO - multiple selections not allowed,
  128.      * <li>MULTIPLESELECTION_YES - multiple selections allowed, or
  129.      * <li>MULTIPLESELECTION_CONFIRM - multiple selections allowed; changes require confirmation (default).
  130.      * </ul>
  131.      */
  132.     public abstract int getMultipleSelection();
  133.  
  134.     /**
  135.      * Determines whether a horizontal scroll bar is shown at the bottom of source windows and panes.
  136.      * <p>The default is <code>true</code>.
  137.      * @return <code>true</code> if a horizontal scroll bar is shown, <code>false</code> otherwise.
  138.      */
  139.     public abstract boolean isShowHorizontalScrollBars();
  140.  
  141.     /**
  142.      * Determines whether the code helper is displayed in source windows and panes.
  143.      * <p>The code helper is a "smart" list of identifiers that popus up at opportune times, allowing
  144.      * quick entry of commonly used items.
  145.      * <p>The default is <code>true</code>.
  146.      * @return <code>true</code> if the code helper is shown, <code>false</code> otherwise.
  147.      */
  148.     public abstract boolean isAutomaticallyShowCodeHelper();
  149.  
  150.     /**
  151.      * Determines whether syntax errors are highlighted while editing source.
  152.      * <p>The default is <code>true</code>.
  153.      * @return <code>true</code> if syntax errors are highlighted, <code>false</code> otherwise.
  154.      */
  155.     public abstract boolean isHilightSyntaxErrorsWhileEditing();
  156. }
  157.