home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / EnvironmentDisplayOptions.java < prev    next >
Text File  |  1998-10-25  |  8KB  |  213 lines
  1. /*
  2.  * Copyright 1998 Symantec Corporation, All Rights Reserved.
  3.  */
  4.  
  5. package com.symantec.itools.vcafe.openapi.options;
  6.  
  7. import java.awt.Color;
  8.  
  9. /**
  10.  * The API used to represent and access the display-related options of the Visual Cafe environment.
  11.  * These options that appear in the "Display" tab in the Environment Options dialog.
  12.  * <p>Use <code>EnvironmentOptionSet.getDisplayOptions()</code> to get an instance of this object.
  13.  *
  14.  * @see com.symantec.itools.vcafe.openapi.VisualCafe#getEnvironmentOptionSet
  15.  * @see EnvironmentOptionSet#getDisplayOptions
  16.  *
  17.  * @author Symantec Internet Tools Division
  18.  * @version 1.0
  19.  * @since VCafe 3.0
  20.  */
  21. public abstract class EnvironmentDisplayOptions
  22. {
  23.  
  24.         /**
  25.          * Indicates display option pertains to source code windows.
  26.          * <p>Note: currently, access is only provided for options that apply to Source code windows.
  27.          * @see #getFont
  28.          * @see #getFontSize
  29.          * @see #getTextForegroundColor
  30.          * @see #getTextBackgroundColor
  31.          * @see #isTextBold
  32.          * @see #isTextItalic
  33.          * @see #getSelectedTextForegroundColor
  34.          * @see #getSelectedTextBackgroundColor
  35.          */
  36.         public static final String CATEGORY_SOURCE_CODE = "Source code";
  37.  
  38.  
  39.     /**
  40.      * Gets the name of the font used in the specified type of window.
  41.      * @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
  42.      * @return the font name.
  43.      */
  44.     public abstract String getFont(String category);
  45.  
  46.     /**
  47.      * Gets the size of the font used in the specified type of window.
  48.      * @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
  49.      * @return the font size.
  50.      */
  51.     public abstract int getFontSize(String category);
  52.  
  53.     /**
  54.      * Gets the foreground <code>Color</code> of text in the specified type of window.
  55.      * @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
  56.      * @return the text foreground <code>Color</code>.
  57.      */
  58.     public abstract Color getTextForegroundColor(String category);
  59.  
  60.     /**
  61.      * Gets the background <code>Color</code> of text in the specified type of window.
  62.      * @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
  63.      * @return the text background <code>Color</code>.
  64.      */
  65.     public abstract Color getTextBackgroundColor(String category);
  66.  
  67.     /**
  68.      * Determines whether text is bold in the specified type of window.
  69.      * @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
  70.      * @return <code>true</code> if the text is bold, <code>false</code> otherwise.
  71.      */
  72.     public abstract boolean isTextBold(String category);
  73.  
  74.     /**
  75.      * Determines whether text is italic in the specified type of window.
  76.      * @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
  77.      * @return <code>true</code> if the text is italic, <code>false</code> otherwise.
  78.      */
  79.     public abstract boolean isTextItalic(String category);
  80.  
  81.  
  82.     /**
  83.      * Gets the foreground <code>Color</code> of selected text in the specified type of window.
  84.      * @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
  85.      * @return the foreground <code>Color</code> of selected text.
  86.      */
  87.     public abstract Color getSelectedTextForegroundColor(String category);
  88.  
  89.     /**
  90.      * Gets the background <code>Color</code> of selected text in the specified type of window.
  91.      * @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
  92.      * @return the background <code>Color</code> of selected text.
  93.      */
  94.     public abstract Color getSelectedTextBackgroundColor(String category);
  95.  
  96.     /**
  97.      * Gets the foreground <code>Color</code> of error text in source code windows.
  98.      * @return the error text foreground <code>Color</code>.
  99.      */
  100.     public abstract Color getErrorsForegroundColor();
  101.  
  102.     /**
  103.      * Gets the foreground <code>Color</code> of comment text in source code windows.
  104.      * @return the comment text foreground <code>Color</code>.
  105.      * @see #isCommentsBold
  106.      * @see #isCommentsItalic
  107.      */
  108.     public abstract Color getCommentsForegroundColor();
  109.  
  110.     /**
  111.      * Determines whether comment text in source code windows is bold.
  112.      * @return <code>true</code> if comment text is bold, <code>false</code> otherwise.
  113.      * @see #getCommentsForegroundColor
  114.      * @see #isCommentsItalic
  115.      */
  116.     public abstract boolean isCommentsBold();
  117.  
  118.     /**
  119.      * Determines whether comment text in source code windows is italic.
  120.      * @return <code>true</code> if comment text is italic, <code>false</code> otherwise.
  121.      * @see #getCommentsForegroundColor
  122.      * @see #isCommentsBold
  123.      */
  124.     public abstract boolean isCommentsItalic();
  125.  
  126.     /**
  127.      * Gets the foreground <code>Color</code> of keyword text in source code windows.
  128.      * @return the keyword text foreground <code>Color</code>.
  129.      * @see #isKeywordsBold
  130.      * @see #isKeywordsItalic
  131.      */
  132.     public abstract Color getKeywordsForegroundColor();
  133.  
  134.     /**
  135.      * Determines whether keyword text in source code windows is bold.
  136.      * @return <code>true</code> if keyword text is bold, <code>false</code> otherwise.
  137.      * @see #getKeywordsForegroundColor
  138.      * @see #isKeywordsItalic
  139.      */
  140.     public abstract boolean isKeywordsBold();
  141.  
  142.     /**
  143.      * Determines whether keyword text in source code windows is italic.
  144.      * @return <code>true</code> if keyword text is italic, <code>false</code> otherwise.
  145.      * @see #getKeywordsForegroundColor
  146.      * @see #isKeywordsBold
  147.      */
  148.     public abstract boolean isKeywordsItalic();
  149.  
  150.     /**
  151.      * Gets the foreground <code>Color</code> of current line text in source code windows.
  152.      * @return the current line text foreground <code>Color</code>.
  153.      * @see #isCurrentLineBold
  154.      * @see #isCurrentLineItalic
  155.      */
  156.     public abstract Color getCurrentLineForegroundColor();
  157.  
  158.     /**
  159.      * Determines whether current line text in source code windows is bold.
  160.      * @return <code>true</code> if current line text is bold, <code>false</code> otherwise.
  161.      * @see #getCurrentLineForegroundColor
  162.      * @see #isCurrentLineItalic
  163.      */
  164.     public abstract boolean isCurrentLineBold();
  165.  
  166.     /**
  167.      * Determines whether current line text in source code windows is italic.
  168.      * @return <code>true</code> if current line text is italic, <code>false</code> otherwise.
  169.      * @see #getCurrentLineForegroundColor
  170.      * @see #isCurrentLineBold
  171.      */
  172.     public abstract boolean isCurrentLineItalic();
  173.  
  174.     /**
  175.      * Gets the foreground <code>Color</code> of custom keyword text in source code windows.
  176.      * @return the custom keyword text foreground <code>Color</code>.
  177.      * @see #isCustomKeywordsBold
  178.      * @see #isCustomKeywordsItalic
  179.      */
  180.     public abstract Color getCustomKeywordsForegroundColor();
  181.  
  182.     /**
  183.      * Determines whether custom keyword text in source code windows is bold.
  184.      * @return <code>true</code> if custom keyword text is bold, <code>false</code> otherwise.
  185.      * @see #getCustomKeywordsForegroundColor
  186.      * @see #isCustomKeywordsItalic
  187.      */
  188.     public abstract boolean isCustomKeywordsBold();
  189.  
  190.     /**
  191.      * Determines whether custom keyword text in source code windows is italic.
  192.      * @return <code>true</code> if custom keyword text is italic, <code>false</code> otherwise.
  193.      * @see #getCustomKeywordsForegroundColor
  194.      * @see #isCustomKeywordsBold
  195.      */
  196.     public abstract boolean isCustomKeywordsItalic();
  197.  
  198.  
  199.     /**
  200.      * Gets the foreground <code>Color</code> of current execution line text in source code windows.
  201.      * @return the current execution line text foreground <code>Color</code>.
  202.      * @see #getExecutionLineBackgroundColor
  203.      */
  204.     public abstract Color getExecutionLineForegroundColor();
  205.  
  206.     /**
  207.      * Gets the foreground <code>Color</code> of current execution line text in source code windows.
  208.      * @return the current execution line text foreground <code>Color</code>.
  209.      * @see #getExecutionLineForegroundColor
  210.      */
  211.     public abstract Color getExecutionLineBackgroundColor();
  212. }
  213.