Contents Up Previous Next Web Site Home Page

Quick Page Reference...

Click on one of the green balls to see a sub-section, or the section itself to read the whole section.

Starting the Application

Parts of the program

The Title Bar

The Menu

The Toolbar

The Tabbed Notebook

The Settings Tab

The 'Project Properties' Section

The 'Files In Project' Section

The 'Java Developers Kit (JDK) Environment Information' section

The Java Command Output Window

Quick Function Reference

File Menu Reference

New Project

New File

Open Project

Open File

Save All

Save Project

Save File

Close File

Close All

Close Project

Transfer to Web Site

Print

Exit

Edit Menu Reference

Undo

Cut

Copy

Paste

Delete

Select All

Find

Replace

Goto Line No

Compile Menu Reference

Project Class File

Current Class File

Allow Deprecated Methods

Run Menu Reference

Run from Web Page

Run Applet

Run Application

Archive Menu Reference

Create Jar File from Directory Menu

Create Jar File from Project Menu

Extract files from JAR

Cleanup class files

Help Menu

Help Contents

JDK Help

Sun Web Site

QuickCup Web Site

Readme text

Copyright Details

About

Closing the application

QuickCup: Starting the application

If you chose to install QuickCup using the program group that was suggested, then the program group will be called, appropriately, QuickCup. Otherwise, in these instructions, substitute the alternative name you chose...

To start the QuickCup application, click on the button on the Windows desktop, and click on the Programs menu that pops up. Then click on the Quickcup menu that appears to the right, and finally, click on the menu item to launch the application.

Creating a desktop shortcut

If you wish to create a desktop shortcut for the application, right-click over the  button on the Windows desktop, and select the Open menu option. Double click on the icon marked Programs and then double-click on the  icon (program group) marked QuickCup.

Now right-click over the icon. Click on the Send To menu, and then click on the Desktop (create shortcut) menu option.

A shortcut icon has now been created on your desktop. You may now double-click on this icon in the future to obtain access to the program, if you prefer.

To clean-up, close the QuickCup window, and then the Programs window, and then the Start Menu window by clicking in the at the top-right hand corner of each of these windows.

Parts of the program

It is useful when reading through the documentation to understand what the different parts of the QuickCup application are, what they are called, and also their purpose.

The Title Bar

The top part of the screen is the title bar, which shows the name and version of the application as follows:-

The icon at the top-left hand corner is the icon when you first start the application, and helps to identify the program. It is also the icon which appears in the task bar at the bottom of the Windows desktop to show you which applications you have open on your computer.

You can see that the title bar shows the name of the application, the version number, and a copyright notice. The three buttons at the right-hand side of the title bar perform the following respective functions:-

The Menu

The menu is the line of text just below the title bar, and looks like this:-

It is used to select different functions from within the QuickCup application. Each of the words on the line (known as the menu bar) represents a type of function that can be performed.

To access one of these words, either click on the word with the mouse pointer, or hold down the Alt key and press the first letter of the word that you wish to use (e.g. to access the Compile menu, hold down the Alt key and press the C key). You may notice that the key you press is the key that appears as underlined in the word.

The menus' functions are as follows:-

When you have chosen a topic area, a list of options will drop down from the menu word that you chose, and from these you can choose the function that you wish to perform. These are detailed in the Quick Function Reference section.

The Toolbar

The toolbar appears just below the menu, and consists of a number of buttons with pictures (or icons) on. If you hover your cursor over each of the buttons, a small box will appear above the button (known as a ToolTip) to give a brief explanation of the button's function.

When you are clicked on the Settings tab, the toolbar will look like this:-

When you are clicked on any other tab, then a few more of the buttons become available (find, replace, and goto) as they are related to text-editing:-

Notice that the Save button is greyed unless a change has been made either to the project details or one of the files attached to the project. This indicates whether something in the project needs to be saved.

Each of the buttons (except for the last, Show Console Window button) have a direct equivalent in the menu. They are as follows:

The tabbed notebook

The application is split into different 'tabbed pages' in a notebook style. The tabs look like this:-

When you click on one of the tabs, you will see information relating to the title of the tab. The first tab relates to project settings, and any other tabs relate to files that are attached to the project, and available for editing. You can see in this example, that the selected tab looks like it is at the front of the others (TextBurst.htm) and that the text of this file has been altered (the title has an asterisk '*' after it).

The settings tab

The settings tab gives the main 'global' information relating to the currently active project. Most of the information in this section is saved with the project (.qjp) file.

The settings tab is divided into different sections, each enclosed by a box:-

The 'Project Properties' section

This section relates to identifying information about the project.

The 'Files in Project' section

This section relates to the files attached to the project. These are generally files that you would want to edit using the inbuilt text-editing facilities of QuickCup. However, if you wish to compress files into a JAR file that only appear in the project (for example, if you have multiple projects in one directory), you can also add ineditable files - just be careful not to inadvertently edit them!

 

Typical files you would wish to add to a project might be Java Source Code files (end with .java), HTML Source Code files (end with .htm or .html), and possibly text data files (usually end with .txt).

To add a file, you can either type the name into the text box at the bottom of this section directly (in which case, the text will appear in red until you have typed a valid filename, at which time it turns to black), or you can click on the button to use a dialog box to select which directory and file you wish to add to the project, which will fill in the text box for you.

Once you have the correct filename in the edit box, click on the button to add the filename to the list of files attached to the project. If the file is a standard editable file, a tick will be placed next to it, and a new tab created from which you can edit the file.

If you wish to close this tab without removing the file from the project, click on the tick next to the file. Click on the empty box to place a tick back again to re-open the file, and create a tab to edit the text again.

If the file you add is the first html file added to the project, it will automatically be assigned to the Main HTML File heading. This is the filename of the web page which will be used if you choose to launch the applet using either your default web browser or the applet viewer.

If you wish to change which html file is used to perform these functions, click the filename in the list of attached files to highlight it (not the tickbox), and then click on the button that displays the current Main HTML File. Note that the filename must end with either .htm or .html

If the file you add is the first java source file added to the project, it will automatically be assigned to the Main Java File heading. This is the filename that is compiler if you click on the button to compile the project, and also the filename used to launch an application.

If you wish to change which java source file is used to perform these functions, click the filename in the list of attached files to highlight it (not the tickbox), and then click on the button that displays the current Main Java File. Note that the filename must end with .java

If you wish to remove a file from the project, so that it is no longer available for editing within the QuickCup environment, click on the filename you wish to remove in the list (not the tickbox), and click on the button to the left of the edit box.

Note that if you increase the size of the window, the visible space for the list of files attached to the project will be increased accordingly.

The 'Java Developers Kit (JDK) Environment Information' section

This section relates to how to access the standard Sun™ tools, such as the compiler, application launcher, applet viewer, and other miscellaneous tools. In order to use these tools, QuickCup needs to know where they are stored.

When you install the Java Software Development Kit  (JDK) from their web site, you will be asked which directory you wish to install them to. Typically, this will be c:\jdk1.3.1 if the Java Development Environment you downloaded was version 1.3.1 etc.

To change the base directory/folder of the Java SDK installation you wish to use for compilation purposes, change the directory details in the Base JDK Path: text box. If you wish to select a directory with your mouse, click on the button to the right of the text box, and whichever directory you select will be placed in the text box.

If you right-click over the Base JDK Path: title, then you will see a pop-up menu to choose one of the Java SDK installations that have been auto-detected on your system (must be in either the c:\ or c:\program files directory) , or the latest JDK version installed.

To change the base directory/folder of the Java SDK Documentation installation you wish to use to access from the Help | Java SDK menu, change the directory details in the Bask Docn Path: text box. If you wish to select a directory with your mouse, click on the button to the right of the text box, and whichever directory you select will be placed in the text box.

If you click on the Store environment information with project file? check-box and place a check/tick into the box, then this path information will be stored with the project, overriding and replacing the global path. In general, this is to be avoided, unless you have different project that will be using different versions of the JDK.

The Class Paths method is used to override the CLASSPATH environment variable, which holds a list of paths/directories that have standard classes and libraries of classes. This is normally set up when you install the JDK, but if you wish to override this for your project, you can list a number of directories, one-per-line in this text box. If you wish to include the normal class path in this list as well, then click on the +CLASSPATH check-box.

You can see what the current standard class path is by hovering your cursor over the +CLASSPATH checkbox. A ToolTip will be displayed showing the current class path.

Another way of checking is to click on the button on the Windows task-bar, click on the Run... option and type command (or cmd for Windows NT, 2000 or XP),  and click on the OK button. This takes you into the command processor.

Now enter SET CLASSPATH and press ENTER. The contents of the class path will then be displayed. If the result says Environment variable CLASSPATH not defined then the class path has not been defined. This is not vitally important, as a default class path will be ascertained by QuickCup from the java development kit that you have selected.

The Java Command Output Window

If you click on the button on the toolbar, the Command Output Window will be displayed. This shows the results of the various functions that are called from the Java Software Development Kit.

When one of these utilities are invoked, a message tells you which utility is invoked, the directory from which the command is being executed, and the command-line equivalent (i.e. what you would have to type yourself from the command-line to do this same thing).

Anything that follows this, up to the message Process Completed is output from the utility that has been invoked.

In the example shown above, the compiler has been invoked by clicking on the button. There was an error in the source code - the variable blueDirection was incorrect spelled. This took place on line 114, so using the goto button (), the name was corrected, and the compiler invoked again. This time, there was no messages from the compiler, so all was OK.

Note that if the utility was not invoked at all, you can expect there to be no pause or delay whilst the application is running. This may indicate that you have the wrong directory for the Java Software Development Kit.

Quick Function Reference

Click here to view the page contents, if you wish to find a specific function.

Briefly, the functions, categorized by each menu, are listed below, by their menu title:-

File Menu

Edit Menu

Compile Menu

Run Menu

Archive Menu

Help Menu

Closing the application

To close the QuickCup application, you can do one of four things:-

If you have made any changes to any of the files, or to the project, you will be asked if you wish to save those changes. Normally you would wish to do so, in which case you would click on the Yes button. However, if you made some changes you do not wish to keep, click on the No button instead.  If you change your mind, and you don't wish to quit the QuickCup program after all, click on the Cancel button.


(c) Copyright 2001-2 Arctan Computer Ventures Ltd.   All Rights Reserved.
If you have any issues regarding this on-line help, please contact the author by clicking here.
This Page was last updated: 26 April 2002 16:58