home *** CD-ROM | disk | FTP | other *** search
Java Source | 1998-10-25 | 2.3 KB | 68 lines |
- /*
- * Copyright 1998 Symantec Corporation, All Rights Reserved.
- */
-
- package com.symantec.itools.vcafe.openapi.options;
-
- /**
- * The API used to represent and access the general options of the Visual Cafe environment.
- * These options that appear in the "General" tab in the Environment Options dialog.
- * <p>Use <code>EnvironmentOptionSet.getGeneralOptions()</code> to get an instance of this object.
- *
- * @see com.symantec.itools.vcafe.openapi.VisualCafe#getEnvironmentOptionSet
- * @see EnvironmentOptionSet#getGeneralOptions
- *
- * @author Symantec Internet Tools Division
- * @version 1.0
- * @since VCafe 3.0
- */
- public abstract class EnvironmentGeneralOptions
- {
- /**
- * Indicates Visual Cafe will create a new default project on startup.
- * @see #getOnStartup
- */
- public static final int ONSTARTUP_CREATE_A_NEW_PROJECT = 0;
- /**
- * Indicates Visual Cafe will open the project from the last session on startup.
- * @see #getOnStartup
- */
- public static final int ONSTARTUP_OPEN_THE_LAST_PROJECT = 1;
- /**
- * Indicates Visual Cafe will take no special action on startup.
- * @see #getOnStartup
- */
- public static final int ONSTARTUP_DO_NOTHING = 2;
-
- /**
- * Gets Visual Cafe's current startup action
- * @return One of:<ul type=circle>
- * <li>ONSTARTUP_CREATE_A_NEW_PROJECT - create a new default project,
- * <li>ONSTARTUP_OPEN_THE_LAST_PROJECT - open the project from the last session, or
- * <li>ONSTARTUP_DO_NOTHING - take no special action.
- * </ul>
- */
- public abstract int getOnStartup();
-
- /**
- * Gets the path used to locate project source files when they are not in the project directory.
- * @return the path.
- */
- public abstract String getLookForSourceFilesInPath();
-
- /**
- * Gets a list of help files used by the environment.
- * <p>The help filenames are seperated by spaces.
- * @return the list of help files.
- */
- public abstract String getUseTheseHelpFiles();
-
- /**
- * Determines whether Visual Cafe will use a Multi-Document Interface (MDI) or the original
- * Single-Document Interface (SDI).
- * The SDI environment was used exclusively before Visual Cafe 2.5.
- * @return <code>true</code> if using MDI, <code>false</code> otherwise.
- */
- public abstract boolean isMDIDevelopmentEnvironment();
- }
-