Class com.symantec.itools.vcafe.openapi.options.EnvironmentDisplayOptions
All Packages Class Hierarchy This Package Previous Next Index
Class com.symantec.itools.vcafe.openapi.options.EnvironmentDisplayOptions
Object
|
+----com.symantec.itools.vcafe.openapi.options.EnvironmentDisplayOptions
- public abstract class EnvironmentDisplayOptions
- extends Object
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.
Use EnvironmentOptionSet.getDisplayOptions()
to get an instance of this object.
- Version:
- 1.0
- Author:
- Symantec Internet Tools Division
- Since:
- VCafe 3.0
- See Also:
- getEnvironmentOptionSet, getDisplayOptions
-
CATEGORY_SOURCE_CODE
- Indicates display option pertains to source code windows.
-
com.symantec.itools.vcafe.openapi.options.EnvironmentDisplayOptions()
-
-
getCommentsForegroundColor()
- Gets the foreground
Color
of comment text in source code windows.
-
getCurrentLineForegroundColor()
- Gets the foreground
Color
of current line text in source code windows.
-
getCustomKeywordsForegroundColor()
- Gets the foreground
Color
of custom keyword text in source code windows.
-
getErrorsForegroundColor()
- Gets the foreground
Color
of error text in source code windows.
-
getExecutionLineBackgroundColor()
- Gets the foreground
Color
of current execution line text in source code windows.
-
getExecutionLineForegroundColor()
- Gets the foreground
Color
of current execution line text in source code windows.
-
getFont(String)
- Gets the name of the font used in the specified type of window.
-
getFontSize(String)
- Gets the size of the font used in the specified type of window.
-
getKeywordsForegroundColor()
- Gets the foreground
Color
of keyword text in source code windows.
-
getSelectedTextBackgroundColor(String)
- Gets the background
Color
of selected text in the specified type of window.
-
getSelectedTextForegroundColor(String)
- Gets the foreground
Color
of selected text in the specified type of window.
-
getTextBackgroundColor(String)
- Gets the background
Color
of text in the specified type of window.
-
getTextForegroundColor(String)
- Gets the foreground
Color
of text in the specified type of window.
-
isCommentsBold()
- Determines whether comment text in source code windows is bold.
-
isCommentsItalic()
- Determines whether comment text in source code windows is italic.
-
isCurrentLineBold()
- Determines whether current line text in source code windows is bold.
-
isCurrentLineItalic()
- Determines whether current line text in source code windows is italic.
-
isCustomKeywordsBold()
- Determines whether custom keyword text in source code windows is bold.
-
isCustomKeywordsItalic()
- Determines whether custom keyword text in source code windows is italic.
-
isKeywordsBold()
- Determines whether keyword text in source code windows is bold.
-
isKeywordsItalic()
- Determines whether keyword text in source code windows is italic.
-
isTextBold(String)
- Determines whether text is bold in the specified type of window.
-
isTextItalic(String)
- Determines whether text is italic in the specified type of window.
CATEGORY_SOURCE_CODE
public static final java.lang.String CATEGORY_SOURCE_CODE
- Indicates display option pertains to source code windows.
Note: currently, access is only provided for options that apply to Source code windows.
- See Also:
- getFont, getFontSize, getTextForegroundColor, getTextBackgroundColor, isTextBold, isTextItalic, getSelectedTextForegroundColor, getSelectedTextBackgroundColor
EnvironmentDisplayOptions
public EnvironmentDisplayOptions()
getCommentsForegroundColor
public abstract java.awt.Color getCommentsForegroundColor()
- Gets the foreground
Color
of comment text in source code windows.
- Returns:
- the comment text foreground
Color
.
- See Also:
- isCommentsBold, isCommentsItalic
getCurrentLineForegroundColor
public abstract java.awt.Color getCurrentLineForegroundColor()
- Gets the foreground
Color
of current line text in source code windows.
- Returns:
- the current line text foreground
Color
.
- See Also:
- isCurrentLineBold, isCurrentLineItalic
getCustomKeywordsForegroundColor
public abstract java.awt.Color getCustomKeywordsForegroundColor()
- Gets the foreground
Color
of custom keyword text in source code windows.
- Returns:
- the custom keyword text foreground
Color
.
- See Also:
- isCustomKeywordsBold, isCustomKeywordsItalic
getErrorsForegroundColor
public abstract java.awt.Color getErrorsForegroundColor()
- Gets the foreground
Color
of error text in source code windows.
- Returns:
- the error text foreground
Color
.
getExecutionLineBackgroundColor
public abstract java.awt.Color getExecutionLineBackgroundColor()
- Gets the foreground
Color
of current execution line text in source code windows.
- Returns:
- the current execution line text foreground
Color
.
- See Also:
- getExecutionLineForegroundColor
getExecutionLineForegroundColor
public abstract java.awt.Color getExecutionLineForegroundColor()
- Gets the foreground
Color
of current execution line text in source code windows.
- Returns:
- the current execution line text foreground
Color
.
- See Also:
- getExecutionLineBackgroundColor
getFont
public abstract java.lang.String getFont(String category)
- Gets the name of the font used in the specified type of window.
- Parameters:
- category - the display element category (currently only
CATEGORY_SOURCE_CODE
supported).
- Returns:
- the font name.
getFontSize
public abstract int getFontSize(String category)
- Gets the size of the font used in the specified type of window.
- Parameters:
- category - the display element category (currently only
CATEGORY_SOURCE_CODE
supported).
- Returns:
- the font size.
getKeywordsForegroundColor
public abstract java.awt.Color getKeywordsForegroundColor()
- Gets the foreground
Color
of keyword text in source code windows.
- Returns:
- the keyword text foreground
Color
.
- See Also:
- isKeywordsBold, isKeywordsItalic
getSelectedTextBackgroundColor
public abstract java.awt.Color getSelectedTextBackgroundColor(String category)
- Gets the background
Color
of selected text in the specified type of window.
- Parameters:
- category - the display element category (currently only
CATEGORY_SOURCE_CODE
supported).
- Returns:
- the background
Color
of selected text.
getSelectedTextForegroundColor
public abstract java.awt.Color getSelectedTextForegroundColor(String category)
- Gets the foreground
Color
of selected text in the specified type of window.
- Parameters:
- category - the display element category (currently only
CATEGORY_SOURCE_CODE
supported).
- Returns:
- the foreground
Color
of selected text.
getTextBackgroundColor
public abstract java.awt.Color getTextBackgroundColor(String category)
- Gets the background
Color
of text in the specified type of window.
- Parameters:
- category - the display element category (currently only
CATEGORY_SOURCE_CODE
supported).
- Returns:
- the text background
Color
.
getTextForegroundColor
public abstract java.awt.Color getTextForegroundColor(String category)
- Gets the foreground
Color
of text in the specified type of window.
- Parameters:
- category - the display element category (currently only
CATEGORY_SOURCE_CODE
supported).
- Returns:
- the text foreground
Color
.
isCommentsBold
public abstract boolean isCommentsBold()
- Determines whether comment text in source code windows is bold.
- Returns:
-
true
if comment text is bold, false
otherwise.
- See Also:
- getCommentsForegroundColor, isCommentsItalic
isCommentsItalic
public abstract boolean isCommentsItalic()
- Determines whether comment text in source code windows is italic.
- Returns:
-
true
if comment text is italic, false
otherwise.
- See Also:
- getCommentsForegroundColor, isCommentsBold
isCurrentLineBold
public abstract boolean isCurrentLineBold()
- Determines whether current line text in source code windows is bold.
- Returns:
-
true
if current line text is bold, false
otherwise.
- See Also:
- getCurrentLineForegroundColor, isCurrentLineItalic
isCurrentLineItalic
public abstract boolean isCurrentLineItalic()
- Determines whether current line text in source code windows is italic.
- Returns:
-
true
if current line text is italic, false
otherwise.
- See Also:
- getCurrentLineForegroundColor, isCurrentLineBold
isCustomKeywordsBold
public abstract boolean isCustomKeywordsBold()
- Determines whether custom keyword text in source code windows is bold.
- Returns:
-
true
if custom keyword text is bold, false
otherwise.
- See Also:
- getCustomKeywordsForegroundColor, isCustomKeywordsItalic
isCustomKeywordsItalic
public abstract boolean isCustomKeywordsItalic()
- Determines whether custom keyword text in source code windows is italic.
- Returns:
-
true
if custom keyword text is italic, false
otherwise.
- See Also:
- getCustomKeywordsForegroundColor, isCustomKeywordsBold
isKeywordsBold
public abstract boolean isKeywordsBold()
- Determines whether keyword text in source code windows is bold.
- Returns:
-
true
if keyword text is bold, false
otherwise.
- See Also:
- getKeywordsForegroundColor, isKeywordsItalic
isKeywordsItalic
public abstract boolean isKeywordsItalic()
- Determines whether keyword text in source code windows is italic.
- Returns:
-
true
if keyword text is italic, false
otherwise.
- See Also:
- getKeywordsForegroundColor, isKeywordsBold
isTextBold
public abstract boolean isTextBold(String category)
- Determines whether text is bold in the specified type of window.
- Parameters:
- category - the display element category (currently only
CATEGORY_SOURCE_CODE
supported).
- Returns:
-
true
if the text is bold, false
otherwise.
isTextItalic
public abstract boolean isTextItalic(String category)
- Determines whether text is italic in the specified type of window.
- Parameters:
- category - the display element category (currently only
CATEGORY_SOURCE_CODE
supported).
- Returns:
-
true
if the text is italic, false
otherwise.
All Packages Class Hierarchy This Package Previous Next Index