home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Programming Languages Suite
/
ProgLangD.iso
/
VCAFE.3.0A
/
Main.bin
/
EnvironmentDisplayOptions.java
< prev
next >
Wrap
Text File
|
1998-10-25
|
8KB
|
213 lines
/*
* Copyright 1998 Symantec Corporation, All Rights Reserved.
*/
package com.symantec.itools.vcafe.openapi.options;
import java.awt.Color;
/**
* The API used to represent and access the display-related options of the Visual Cafe environment.
* These options that appear in the "Display" tab in the Environment Options dialog.
* <p>Use <code>EnvironmentOptionSet.getDisplayOptions()</code> to get an instance of this object.
*
* @see com.symantec.itools.vcafe.openapi.VisualCafe#getEnvironmentOptionSet
* @see EnvironmentOptionSet#getDisplayOptions
*
* @author Symantec Internet Tools Division
* @version 1.0
* @since VCafe 3.0
*/
public abstract class EnvironmentDisplayOptions
{
/**
* Indicates display option pertains to source code windows.
* <p>Note: currently, access is only provided for options that apply to Source code windows.
* @see #getFont
* @see #getFontSize
* @see #getTextForegroundColor
* @see #getTextBackgroundColor
* @see #isTextBold
* @see #isTextItalic
* @see #getSelectedTextForegroundColor
* @see #getSelectedTextBackgroundColor
*/
public static final String CATEGORY_SOURCE_CODE = "Source code";
/**
* Gets the name of the font used in the specified type of window.
* @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
* @return the font name.
*/
public abstract String getFont(String category);
/**
* Gets the size of the font used in the specified type of window.
* @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
* @return the font size.
*/
public abstract int getFontSize(String category);
/**
* Gets the foreground <code>Color</code> of text in the specified type of window.
* @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
* @return the text foreground <code>Color</code>.
*/
public abstract Color getTextForegroundColor(String category);
/**
* Gets the background <code>Color</code> of text in the specified type of window.
* @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
* @return the text background <code>Color</code>.
*/
public abstract Color getTextBackgroundColor(String category);
/**
* Determines whether text is bold in the specified type of window.
* @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
* @return <code>true</code> if the text is bold, <code>false</code> otherwise.
*/
public abstract boolean isTextBold(String category);
/**
* Determines whether text is italic in the specified type of window.
* @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
* @return <code>true</code> if the text is italic, <code>false</code> otherwise.
*/
public abstract boolean isTextItalic(String category);
/**
* Gets the foreground <code>Color</code> of selected text in the specified type of window.
* @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
* @return the foreground <code>Color</code> of selected text.
*/
public abstract Color getSelectedTextForegroundColor(String category);
/**
* Gets the background <code>Color</code> of selected text in the specified type of window.
* @param category the display element category (currently only <code>CATEGORY_SOURCE_CODE</code> supported).
* @return the background <code>Color</code> of selected text.
*/
public abstract Color getSelectedTextBackgroundColor(String category);
/**
* Gets the foreground <code>Color</code> of error text in source code windows.
* @return the error text foreground <code>Color</code>.
*/
public abstract Color getErrorsForegroundColor();
/**
* Gets the foreground <code>Color</code> of comment text in source code windows.
* @return the comment text foreground <code>Color</code>.
* @see #isCommentsBold
* @see #isCommentsItalic
*/
public abstract Color getCommentsForegroundColor();
/**
* Determines whether comment text in source code windows is bold.
* @return <code>true</code> if comment text is bold, <code>false</code> otherwise.
* @see #getCommentsForegroundColor
* @see #isCommentsItalic
*/
public abstract boolean isCommentsBold();
/**
* Determines whether comment text in source code windows is italic.
* @return <code>true</code> if comment text is italic, <code>false</code> otherwise.
* @see #getCommentsForegroundColor
* @see #isCommentsBold
*/
public abstract boolean isCommentsItalic();
/**
* Gets the foreground <code>Color</code> of keyword text in source code windows.
* @return the keyword text foreground <code>Color</code>.
* @see #isKeywordsBold
* @see #isKeywordsItalic
*/
public abstract Color getKeywordsForegroundColor();
/**
* Determines whether keyword text in source code windows is bold.
* @return <code>true</code> if keyword text is bold, <code>false</code> otherwise.
* @see #getKeywordsForegroundColor
* @see #isKeywordsItalic
*/
public abstract boolean isKeywordsBold();
/**
* Determines whether keyword text in source code windows is italic.
* @return <code>true</code> if keyword text is italic, <code>false</code> otherwise.
* @see #getKeywordsForegroundColor
* @see #isKeywordsBold
*/
public abstract boolean isKeywordsItalic();
/**
* Gets the foreground <code>Color</code> of current line text in source code windows.
* @return the current line text foreground <code>Color</code>.
* @see #isCurrentLineBold
* @see #isCurrentLineItalic
*/
public abstract Color getCurrentLineForegroundColor();
/**
* Determines whether current line text in source code windows is bold.
* @return <code>true</code> if current line text is bold, <code>false</code> otherwise.
* @see #getCurrentLineForegroundColor
* @see #isCurrentLineItalic
*/
public abstract boolean isCurrentLineBold();
/**
* Determines whether current line text in source code windows is italic.
* @return <code>true</code> if current line text is italic, <code>false</code> otherwise.
* @see #getCurrentLineForegroundColor
* @see #isCurrentLineBold
*/
public abstract boolean isCurrentLineItalic();
/**
* Gets the foreground <code>Color</code> of custom keyword text in source code windows.
* @return the custom keyword text foreground <code>Color</code>.
* @see #isCustomKeywordsBold
* @see #isCustomKeywordsItalic
*/
public abstract Color getCustomKeywordsForegroundColor();
/**
* Determines whether custom keyword text in source code windows is bold.
* @return <code>true</code> if custom keyword text is bold, <code>false</code> otherwise.
* @see #getCustomKeywordsForegroundColor
* @see #isCustomKeywordsItalic
*/
public abstract boolean isCustomKeywordsBold();
/**
* Determines whether custom keyword text in source code windows is italic.
* @return <code>true</code> if custom keyword text is italic, <code>false</code> otherwise.
* @see #getCustomKeywordsForegroundColor
* @see #isCustomKeywordsBold
*/
public abstract boolean isCustomKeywordsItalic();
/**
* Gets the foreground <code>Color</code> of current execution line text in source code windows.
* @return the current execution line text foreground <code>Color</code>.
* @see #getExecutionLineBackgroundColor
*/
public abstract Color getExecutionLineForegroundColor();
/**
* Gets the foreground <code>Color</code> of current execution line text in source code windows.
* @return the current execution line text foreground <code>Color</code>.
* @see #getExecutionLineForegroundColor
*/
public abstract Color getExecutionLineBackgroundColor();
}