# Java Notes

# Applets

## Why no applets in these notes

These notes were originally written using applets almost entirely. However, all applet examples are being changed to applications.

- The only really portable applets are written in Java 1.1 because this is the minimum assumption about what is installed on a user's computer. Java has moved far beyond that. I'm not interested in programs that are limited to the older, and seriously inferior, AWT. Yes, Java plugins can be used for the more recent versions, but it can still be a problem. To get around this, many books that teach applets suggest using the `appletviewer` program thereby negating the supposed applet advantages.
- In a controlled environment, such as a large company, it's possible to use later versions of applets, but they aren't the best idea for general examples.
- Many current applets should instead be animated GIFs, JavaScript, or Flash.
- Assuming the later versions of Java are used, most applet source will look similar to application code. However, there are some divergences that are annoying: the common practice of `init` instead of a contructors, the fixed size as opposed to using `pack`, lack of I/O capability (without permissions), ... It's even worse when using Java 1.1 because the lack of a content pane distorts the program.
- Java WebStart is a better solution to web distributed software.
- The primary use of Java has turned out to be applications, not applets as predicted by the initial hype.

## Converting Applets to Applications

To make an applet into an application, add a `main()`method to the applet's class -- you don't have to create a new class. It may seem a little strange that adding a `main` method to a class will make it into an application, but that's the most common way of doing it. An application is any program that has a `main()` method. This new `main()` does what a browser does.

The `main` method should do the following:

1. Create a window (JFrame) to hold the applet.
2. Make the window's close box stop the applet.
3. Create a new applet object, and add it to the window.
4. Start the applet by calling init(), then start().
5. Finalize the layout.
6. Make the window (with the applet in it) visible.

### Example

Here is a very small applet, which just displays some text.

    import javax.swing.*;

    public class SampleApplet extends JApplet {
        public SampleApplet() {
            add(new JLabel("This is an Applet."));
        }
    }

Add a `main()` method, and it can be used as either an application or an applet.

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
    // File   : deployment/appletapp/SampleApplet.java
    // Purpose: Demos dual applet / application.
    // Author : Fred Swartz - 2006 Aug 5 - placed in public domain.
    // Comments: Unless the applet references parameters in the HTML
    //           page, just add a main program which creates a
    //           JFrame to put the applet in.
    //           Applets are often initialized by calling their init()
    //           method -- this sample applet defines a constructor
    //           instead of init(), but both styles work.
    // Tag: <applet code="appletapp.SampleApplet.class" archive="appletapp.jar"
    //                                         width="220" height="20"></applet>

    package appletapp;

    import java.awt.*;
    import javax.swing.*;

    public class SampleApplet extends JApplet {

        //============================================================ main
        public static void main(String[] args) {
            //... Create an initialize the applet.
            JApplet theApplet = new SampleApplet();
            //theApplet.init();         // Needed if overridden in applet
            //theApplet.start();        // Needed if overridden in applet

            //... Create a window (JFrame) and make applet the content pane.
            JFrame window = new JFrame("Sample Applet and Application");
            window.setContentPane(theApplet);
            window.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
            window.pack();              // Arrange the components.
            //System.out.println(theApplet.getSize());
            window.setVisible(true);    // Make the window visible.
        }

        //=============================================== Applet constructor
        public SampleApplet() {
            add(new JLabel("This is both an Applet and Application!"));
        }
    }

- You can use this as an applet and the browser will ignore `main()`.
- Although `SampleApplet` is the name of the class, we need to create an instance of it. An applet is a kind of panel, so it can be used for the contentPane in a JFrame.
- Usually only applets which do animation have a `start()` method. If your applet doesn't have a `start()` method, you don't need this call, although it won't cause problems because JApplet has defined a version that does nothing. Similarly with `init()` which is commonly used in applets, altho a constructor would be a better choice. If there is no `init()`, there's no need to call it.

Some applets may use features that require additional work.

- An applet can call `getCodeBase()` to find out where it was loaded from to get additional classes, images, or other data, then use the return value to get more things. If an applet does this, then you must define `getCodeBase()`.
- If an applet gets parameters from the web page, you will have to provide a `getParameter()` method.
- The `showStatus()` method must be supplied if used by the applet.

## The <applet...> HTML tag

You need to specify the following values in an applet tag.

- Size. `width="nn" height="mm"`, where nn and mm are the width and the height of the area the applet will occupy on the web page. Applets are not resizeable (except when run with the appletviewer application, but if you're using appletviewer, why are you writing an applet? Specifying the size is a nasty problem. Because applets can be run on web pages in many different environments, you don't know the pixel exact dimentions of the particular widgets, so you have to estimate the largest size that will be required and specify that in your applet tag. I often add `System.out.println` to print that applet size (use `getSize()), then add a little.\ I hope you are using a layout that will expand gracefully.`
- Class file location. There are several possibities.
  Simple class files
    Specify `code="Xxxx.class"`
  Jar file
    If you're using packages (eg, with NetBeans), you will need to specify the .jar file as an archive and then give the class which contains the applet, qualified by the package name. Specify `code="yourPackage.Xxxx.class" archive="yourPackage.jar"`

### Example tag

This applet tag can be used to display the above applet.

    <applet code="appletapp.SampleApplet.class" archive="appletapp.jar" width="220"
                                                                    height="20"></applet>