home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Programming Languages Suite
/
ProgLangD.iso
/
VCAFE.3.0A
/
Main.bin
/
EnvironmentEditingOptions.java
< prev
next >
Wrap
Text File
|
1998-10-25
|
6KB
|
157 lines
/*
* Copyright 1998 Symantec Corporation, All Rights Reserved.
*/
package com.symantec.itools.vcafe.openapi.options;
/**
* The API used to represent and access the editing-related options of the Visual Cafe environment.
* These options that appear in the "Editing" tab in the Environment Options dialog.
* <p>Use <code>EnvironmentOptionSet.getEditingOptions()</code> to get an instance of this object.
*
* @see com.symantec.itools.vcafe.openapi.VisualCafe#getEnvironmentOptionSet
* @see EnvironmentOptionSet#getEditingOptions
*
* @author Symantec Internet Tools Division
* @version 1.0
* @since VCafe 3.0
*/
public abstract class EnvironmentEditingOptions
{
/**
* Indicates the text cursor will be a block when the editor is in insert mode.
* @see #getInsert
*/
public static final int INSERT_BLOCK = 0;
/**
* Indicates the text cursor will be an underline when the editor is in insert mode.
* @see #getInsert
*/
public static final int INSERT_UNDERLINE = 1;
/**
* Indicates the text cursor will be a vertical bar when the editor is in insert mode (default).
* @see #getInsert
*/
public static final int INSERT_VERTICALBAR = 2;
/**
* Gets the type of text cursor displayed when the editor is in insert mode.
* <p> The "Insert" key toggles between insert and overwrite modes.
* @return One of:<ul type=circle>
* <li>INSERT_BLOCK - a block text cursor,
* <li>INSERT_UNDERLINE - an underline text cursor, or
* <li>INSERT_VERTICALBAR - a vertical bar text cursor (default).
* </ul>
*/
public abstract int getInsert();
/**
* Determines whether the text cursor will blink while the editor is in insert mode.
* <p>The default is <code>true</code>.
* @return <code>true</code> if the cursor will blink, <code>false</code> otherwise.
*/
public abstract boolean isInsertBlink();
/**
* Indicates the text cursor will be a block when the editor is in overwrite mode (default).
* @see #getOverwrite
*/
public static final int OVERWRITE_BLOCK = 0;
/**
* Indicates the text cursor will be an underline when the editor is in overwrite mode.
* @see #getOverwrite
*/
public static final int OVERWRITE_UNDERLINE = 1;
/**
* Indicates the text cursor will be a vertical bar when the editor is in overwrite mode.
* @see #getOverwrite
*/
public static final int OVERWRITE_VERTICALBAR = 2;
/**
* Gets the type of text cursor displayed when the editor is in overwrite mode.
* <p> The "Insert" key toggles between insert and overwrite modes.
* @return One of:<ul type=circle>
* <li>OVERWRITE_BLOCK - a block text cursor (default),
* <li>OVERWRITE_UNDERLINE - an underline text cursor, or
* <li>OVERWRITE_VERTICALBAR - a vertical bar text cursor.
* </ul>
*/
public abstract int getOverwrite();
/**
* Determines whether the text cursor will blink while the editor is in overwrite mode.
* <p>The default is <code>true</code>.
* @return <code>true</code> if the cursor will blink, <code>false</code> otherwise.
*/
public abstract boolean isOverwriteBlink();
/**
* Determines whether the Class Browser and Hierarchy Editor will ask for confirmation before
* deleting a class member.
* <p>The default is <code>true</code>.
* @return <code>true</code> if deletions are confirmed, <code>false</code> otherwise.
*/
public abstract boolean isConfirmDeleteMember();
/**
* Determines whether the Class Browser and Hierarchy Editor will ask for confirmation before
* changing the inheritance of a class.
* <p>The default is <code>true</code>.
* @return <code>true</code> if inheritance changes are confirmed, <code>false</code> otherwise.
*/
public abstract boolean isConfirmInheritanceChange();
/**
* Indicates the you cannot select (and change) multiple classes in the Class Browser and
* Hierarchy Editor.
* @see #getMultipleSelection
*/
public static final int MULTIPLESELECTION_NO = 0;
/**
* Indicates the you can select (and change) multiple classes in the Class Browser and
* Hierarchy Editor.
* @see #getMultipleSelection
*/
public static final int MULTIPLESELECTION_YES = 1;
/**
* Indicates the you can select (and change) multiple classes in the Class Browser and
* Hierarchy Editor, but changes to multiple selections require confirmation (default).
* @see #getMultipleSelection
*/
public static final int MULTIPLESELECTION_CONFIRM = 2;
/**
* Gets the multiple selection mode of the Class Browser and Hierarchy Editor.
* @return One of:<ul type=circle>
* <li>MULTIPLESELECTION_NO - multiple selections not allowed,
* <li>MULTIPLESELECTION_YES - multiple selections allowed, or
* <li>MULTIPLESELECTION_CONFIRM - multiple selections allowed; changes require confirmation (default).
* </ul>
*/
public abstract int getMultipleSelection();
/**
* Determines whether a horizontal scroll bar is shown at the bottom of source windows and panes.
* <p>The default is <code>true</code>.
* @return <code>true</code> if a horizontal scroll bar is shown, <code>false</code> otherwise.
*/
public abstract boolean isShowHorizontalScrollBars();
/**
* Determines whether the code helper is displayed in source windows and panes.
* <p>The code helper is a "smart" list of identifiers that popus up at opportune times, allowing
* quick entry of commonly used items.
* <p>The default is <code>true</code>.
* @return <code>true</code> if the code helper is shown, <code>false</code> otherwise.
*/
public abstract boolean isAutomaticallyShowCodeHelper();
/**
* Determines whether syntax errors are highlighted while editing source.
* <p>The default is <code>true</code>.
* @return <code>true</code> if syntax errors are highlighted, <code>false</code> otherwise.
*/
public abstract boolean isHilightSyntaxErrorsWhileEditing();
}