diff --git a/extensions/calpa/CHANGES.txt b/extensions/calpa/CHANGES.txt new file mode 100644 index 0000000..ed7d779 --- /dev/null +++ b/extensions/calpa/CHANGES.txt @@ -0,0 +1,130 @@ + calpa.html Java package + + Changes since Version 2.0 beta + + +Version 2.021 + + - Verison 2.02 was very short-lived. The system font bug in Java 2 + which had been pointed out in the KNOWN PROBLEMS of readme.txt was + causing a number of unforseen problems for CalPane users when the + tag was used. Regrettably therefore the support of + system fonts has once again been disabled within CalPane. The code + will be reactivated when JavaSoft have fixed the Java 2 bug. + + +Version 2.02 + + - New methods in CalHTMLPane to force synchronous loading of + documents: + + setLoadSynchronously(boolean b) + isLoadSynchronouslyEnabled() + + If loadSynchronously is enabled then showHTMLDocument() methods + will not return until a document has loaded. In addition documents + loading from activated hyperlinks will also load synchronously. + + Loading synchronously effectively blocks the current AWT thread + which will reduce the responsiveness of CalPane, but can be useful + for programmers who want to be sure that a document has loaded + before proceeding with another operation. Generally it is better + to use the callback methods in CalHTMLObserver to determine when a + document has finished loading. + + + - New method in CalHTMLPane to allow access to form components: + + getIDComponents(String targetFrame) + + This method returns a Hashtable containing all components in the + target frame which have the HTML 'id' attribute, as for example: + + + + This method allows programmers to get handles to HTML form + components after they have been created, either to monitor/ + manipulate their state, or programmatically fire a form submission. + + If the target frame is null then all id components within the + CalPane are returned. + + + - Enhancement of form submission to give feedback on custom + components. When a custom component is included in a form via the + OBJECT tag, the CalPane will call that component's toString() method + and include this string in the form submission. This enables users + to pass information regarding the state of the component by + overriding the toString() method. For example, if you had added a + JColorChooser like this: + + + + ...you could override toString() to pass the RGB values of the + selected color. The form submission would include the text: + + chooser=[whatever toString() returns] + + + - New methods added to CalHTMLPreferences to allow programmers to + handle hyperlink events themselves: + + setAutomaticallyFollowHyperlinks(boolean) + isAutomaticallyFollowHyperlinksEnabled() + + + - New method added to CalHTMLPane for programmers using HTML + Strings rather than URLs: + + scrollToReference(String ref, String targetFrame) + + + - The CalGuide now includes a page containing answers to some common + programming questions. + + + - New methods added to CalHTMLPreferences: + + setDefaultFont(int displaySize, Font font) + getDefaultFont(int displaySize) + setDefaultButtonFont(int displaySize, Font font) + getDefaultButtonFont(int displaySize) + setDefaultFormTextFont(int displaySize, Font font) + getDefaultFormTextFont(int displaySize) + + These methods have been incorporated to allow the setting of + system fonts under Java 2. They replace the following 1.1 methods + which are now deprecated: + + setDefaultFont(int, int, int) + setFormFont(int, int, int, int) + + + - New methods added to CalHTMLPreferences: + + setShowHyperlinkOnMouseFocus(boolean) + isShowHyperlinkOnMouseFocusEnabled() + + This hyperlink policy is commonly used in help systems where it is + obvious that all text is a hyperlink entry, and users only need to + know which hyperlink currently has focus. + + + - Bug Fixes: A few changes made to fix problems with borderless + frames. In particular the 'frameborder' attribute was incorrectly + implemented in FRAMESET tags: frameborder=no and frameborder=yes + were working the wrong way round. In addition viewport borders + were not being drawn around borderless framesets. + + +Version 2.01b + + - Bug Fix: An exception was being thrown when loading a document + containing over 8000 hyperlinks. + + - Bug Fix: The DOC_LOADED call from the top level frame was + incorrectly being sent twice to the statusUpdate() method + of CalHTMLObserver. + + - Bug Fix: The 'reload' argument sent to the CalPane's + showHTMLDocument() method was being ignored. diff --git a/extensions/calpa/Docs/CalGuide.html b/extensions/calpa/Docs/CalGuide.html new file mode 100644 index 0000000..e745431 --- /dev/null +++ b/extensions/calpa/Docs/CalGuide.html @@ -0,0 +1,100 @@ + + + + + + + +
+CalHTMLPane v2.0 + +Guide Index +
+
+ + + + +

+

CalHTMLPane v2.0 Guide

+ +
    +
  1. General +

    +

      +
    1. Getting started/Author's notes + +
    +

    +

  2. Example Tag Usage +

    +

      +
    1. Tables + +

      +

    2. Forms + +

      +

    3. Frames + +

      +

    4. Images + +

      +

    5. Misc + +
    +

    +

  3. Programming the CalHTMLPane +

    +

      +
    1. Javadoc + +
    2. Misc + +
    +
+

+

+
+Copyright © 1999 Andrew Moulden, 82A Queens Road, Leicester, LE2 1TU, United Kingdom +
+ + diff --git a/extensions/calpa/Docs/ReadMeExamples/MyFifthCalPaneApplication.java b/extensions/calpa/Docs/ReadMeExamples/MyFifthCalPaneApplication.java new file mode 100644 index 0000000..f9bbb52 --- /dev/null +++ b/extensions/calpa/Docs/ReadMeExamples/MyFifthCalPaneApplication.java @@ -0,0 +1,26 @@ +import java.net.*; +import java.awt.*; +import javax.swing.*; +import calpa.html.*; + +public class MyFifthCalPaneApplication { + + public static void main(String args[]) { + + String markup = "

Hello World

"; + + //create ColorChooser, name it, add it to CalHTMLManager + JColorChooser chooser = new JColorChooser(); + chooser.setName("mycolorchooser"); + CalHTMLManager.addUserComponent(chooser); + + JFrame f = new JFrame(); + CalHTMLPane pane = new CalHTMLPane(); + f.getContentPane().add(pane, "Center"); + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + pane.showHTMLDocument(markup); + } +} + diff --git a/extensions/calpa/Docs/ReadMeExamples/MyFirstCalPaneApplication.java b/extensions/calpa/Docs/ReadMeExamples/MyFirstCalPaneApplication.java new file mode 100644 index 0000000..ed2fbe1 --- /dev/null +++ b/extensions/calpa/Docs/ReadMeExamples/MyFirstCalPaneApplication.java @@ -0,0 +1,31 @@ +import java.net.*; +import java.awt.*; +import javax.swing.*; +import calpa.html.*; + +public class MyFirstCalPaneApplication { + + public static void main(String args[]) { + + URL url = null; + try { + //This is an example URL. You need to format your own. + //If you use an http URL you'll need an open http connection + url = new URL("file:///c:/jdk1.2/docs/api/overview-summary.html"); + } catch (MalformedURLException e) { + System.err.println("Malformed URL"); + System.exit(1); + } + + JFrame f = new JFrame(); + CalHTMLPane pane = new CalHTMLPane(); + f.getContentPane().add(pane, "Center"); + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + if (url != null) { + pane.showHTMLDocument(url); + pane.requestFocus(); + } + } +} diff --git a/extensions/calpa/Docs/ReadMeExamples/MyFourthCalPaneApplication.java b/extensions/calpa/Docs/ReadMeExamples/MyFourthCalPaneApplication.java new file mode 100644 index 0000000..d317531 --- /dev/null +++ b/extensions/calpa/Docs/ReadMeExamples/MyFourthCalPaneApplication.java @@ -0,0 +1,50 @@ +import java.net.*; +import java.awt.*; +import javax.swing.*; +import calpa.html.*; + +public class MyFourthCalPaneApplication { + + public static void main(String args[]) { + + URL url = null; + try { + url = new URL("file:///c:/jdk1.2/docs/api/overview-summary.html"); + } catch (MalformedURLException e) { + System.err.println("Malformed URL"); + System.exit(1); + } + + JFrame f = new JFrame(); + JLabel label = new JLabel("0"); + label.setBorder(BorderFactory.createEmptyBorder(2, 8, 2, 8)); + label.setPreferredSize(label.getPreferredSize()); + label.setText(""); + CalHTMLPane pane = new CalHTMLPane(null, new MyCalHTMLObserver(label), null); + f.getContentPane().add(pane, "Center"); + f.getContentPane().add(label, "South"); + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + if (url != null) { + pane.showHTMLDocument(url); + } + } + + + private static class MyCalHTMLObserver extends DefaultCalHTMLObserver { + + JLabel label; + + public MyCalHTMLObserver(JLabel label) { + + super(); + this.label = label; + } + + public void linkFocusedUpdate(CalHTMLPane p, URL url) { + + label.setText((url == null) ? "" : url.toExternalForm()); + } + } +} diff --git a/extensions/calpa/Docs/ReadMeExamples/MySecondCalPaneApplication.java b/extensions/calpa/Docs/ReadMeExamples/MySecondCalPaneApplication.java new file mode 100644 index 0000000..cd30b60 --- /dev/null +++ b/extensions/calpa/Docs/ReadMeExamples/MySecondCalPaneApplication.java @@ -0,0 +1,36 @@ +import java.net.*; +import java.awt.*; +import javax.swing.*; +import calpa.html.*; + +public class MySecondCalPaneApplication { + + public static void main(String args[]) { + + URL url = null; + try { + url = new URL("file:///c:/jdk1.2/docs/api/overview-summary.html"); + } catch (MalformedURLException e) { + System.err.println("Malformed URL"); + System.exit(1); + } + + JFrame f = new JFrame(); + + //create a Preferences object + CalHTMLPreferences pref = new CalHTMLPreferences(); + + //use one of its methods to enable the test navbar + pref.setShowTestNavBar(true); + + //now pass the pref object to the Pane's constructor + CalHTMLPane pane = new CalHTMLPane(pref, null, null); + f.getContentPane().add(pane, "Center"); + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + if (url != null) { + pane.showHTMLDocument(url); + } + } +} diff --git a/extensions/calpa/Docs/ReadMeExamples/MySixthCalPaneApplication.java b/extensions/calpa/Docs/ReadMeExamples/MySixthCalPaneApplication.java new file mode 100644 index 0000000..1e61d66 --- /dev/null +++ b/extensions/calpa/Docs/ReadMeExamples/MySixthCalPaneApplication.java @@ -0,0 +1,48 @@ +import java.awt.*; +import java.awt.event.*; +import javax.swing.*; +import calpa.html.*; + +public class MySixthCalPaneApplication { + + public static void main(String args[]) { + + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + d.width = Math.min(d.width, 800); + d.height = Math.min(d.height, 600); + JFrame f = new JFrame(); + CalHTMLPane pane = new CalHTMLPane(); + JPanel p = new JPanel(); + JTextArea ta = new JTextArea(); + ta.setLineWrap(true); + JScrollPane sp = new JScrollPane(ta); + sp.setPreferredSize(new Dimension(d.width / 2, d.height / 4)); + JButton b = new JButton("Show Dialog"); + b.addActionListener(new MyListener(pane, ta)); + p.add(sp); + p.add(b); + f.getContentPane().add(pane, "Center"); + f.getContentPane().add(p, "South"); + f.setSize(new Dimension(d.width - 10, d.height - 40)); + f.setVisible(true); + } + + private static class MyListener implements ActionListener { + + CalHTMLPane pane; + JTextArea ta; + + public MyListener(CalHTMLPane pane, JTextArea ta) { + + this.pane = pane; + this.ta = ta; + } + + public void actionPerformed(ActionEvent e) { + + pane.showDialog(ta.getText(), null, -1, -1, -1, -1); + } + } + +} + diff --git a/extensions/calpa/Docs/ReadMeExamples/MyThirdCalPaneApplication.java b/extensions/calpa/Docs/ReadMeExamples/MyThirdCalPaneApplication.java new file mode 100644 index 0000000..17934a1 --- /dev/null +++ b/extensions/calpa/Docs/ReadMeExamples/MyThirdCalPaneApplication.java @@ -0,0 +1,68 @@ +import java.net.*; +import java.awt.*; +import java.awt.event.*; +import javax.swing.*; +import calpa.html.*; + +public class MyThirdCalPaneApplication { + + public static void main(String args[]) { + + URL url = null; + try { + url = new URL("file:///c:/jdk1.2/docs/api/overview-summary.html"); + } catch (MalformedURLException e) { + System.err.println("Malformed URL"); + System.exit(1); + } + + JFrame f = new JFrame(); + CalHTMLPane pane = new CalHTMLPane(); + f.getContentPane().add(pane, "Center"); + + //create a panel, add buttons, and add a listener to the buttons + JPanel p = new JPanel(); + MyListener ml = new MyListener(pane); + String[] s = {"Reload", "Back", "Forward", "Stop"}; + JButton b; + for (int i=0; i<4; i++) { + b = new JButton(s[i]); + b.addActionListener(ml); + p.add(b); + } + f.getContentPane().add(p, "South"); + + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + if (url != null) { + pane.showHTMLDocument(url); + } + } + + + private static class MyListener implements ActionListener { + + CalHTMLPane pane; + + public MyListener(CalHTMLPane pane) { + + this.pane = pane; + } + + public void actionPerformed(ActionEvent e) { + + String s = e.getActionCommand(); + + if (("Reload").equals(s)) { + pane.reloadDocument(); + } else if (("Back").equals(s)) { + pane.goBack(); + } else if (("Forward").equals(s)) { + pane.goForward(); + } else if (("Stop").equals(s)) { + pane.stopAll(); + } + } + } +} diff --git a/extensions/calpa/Docs/html/guide-Forms-accesskey.html b/extensions/calpa/Docs/html/guide-Forms-accesskey.html new file mode 100644 index 0000000..c22d01f --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-accesskey.html @@ -0,0 +1,102 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Attr: accesskey
+ +

+ + + + + + + + + +
+Synopsis:
+Use this attribute to give a keyboard accelerator to a form component. + +

For form buttons created with the INPUT tag the button text will show +the accelerator underlined. + +

For other controls the U (underline) tag can be used to mark the key +accelerator. + +

Note that the LABEL tag can be used to pass focus to another form +component by using the for attribute (see HTML4.0 spec). + +

+

+Example: +

+ + + + +
+ +<P align=center>
+<INPUT type=button value="Press me" accesskey="P">  
+Your <U>n</U>ame: <INPUT type=text accesskey=n>
+<P align=center>
+<LABEL bgcolor=white for=mycombo accesskey='c'><U>C</U>omposer</LABEL>
+<SELECT id=mycombo>
+  <OPTION>Mozart
+  <OPTION>Schubert
+  <OPTION>Bach
+</SELECT>
+
+

+ + +

+Rendering: +Note: Java 1.2 has a bug (no. 4159610) relating to this example. If +the textfield has focus and an accelerator is used for a different control, the +accelerator character will show within the textfield +

+   +Your name: +

+ + +
+
+ +

+

+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-button.html b/extensions/calpa/Docs/html/guide-Forms-button.html new file mode 100644 index 0000000..86e53e9 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-button.html @@ -0,0 +1,178 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Tag: INPUT (submit)
+Tag: INPUT (reset)
+Tag: INPUT (button)
+

+

+ + + + + + + + + + + + + +
+Default Rendering (no color modification): +

+

+ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
 lookandfeelthreedeeflush
uicontrol +
white +
black +
(light) +
(dark) +
+
+
+
+Setting color attributes: +

+ + + + +
+<TABLE border=2 cellspacing=2 cellpadding=5 width=200 bgcolor=uicontrol>
+  <COLGROUP span=2 align=center width=50%></COLGROUP>
+  <TR><TH>threedee</TH><TH>flush</TH></TR>
+  <TR bgcolor=aa88aa><TD>
+    <INPUT type=button style=threedee bgcolor=aa88aa value="Press Me">
+    <INPUT type=button style=flush bgcolor=aa88aa value="Press Me">
+  </TD></TR>
+ +  <TR><TD>
+    <INPUT type=button style=threedee bgcolor=779988 value="Press Me">
+    <INPUT type=buton style=flush bgcolor=779988 value="Press Me">
+  </TD></TR>
+ +  <TR bgcolor=ee99aa><TD>
+    <INPUT type=button style=threedee bgcolor=ee99aa value="Press Me">
+    <INPUT type=button style=flush bgcolor=ee99aa value="Press Me">
+  </TD></TR>
+ +  <TR><TD>
+    <INPUT type=button style=threedee bgcolor=ccaa22 value="Press Me">
+    <INPUT type=button style=flush bgcolor=ccaa22 value="Press Me">
+  </TD></TR>
+ + +</TABLE> +
+

+

+

+Rendering: +
+ ++ + + + + + + + + + + + + + + + + + +
threedeeflush
+
+

+The inner highlight of the flush style can be removed by +setting the control's bordercolorlight to the same color as its background +

+ + +
+<TABLE align=center border=2 cellspacing=2 cellpadding=5 width=100 bgcolor=aabbcc>
+<TR><TD>
+  <INPUT type=button align=bottom style=flush bgcolor=aabbcc
+  bordercolorlight=aabbcc value="Press Me">
+</TD></TR>
+</TABLE> +
+

+ + + + +
+ +
+

+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-buttontag.html b/extensions/calpa/Docs/html/guide-Forms-buttontag.html new file mode 100644 index 0000000..d9b2119 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-buttontag.html @@ -0,0 +1,123 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Tag: BUTTON
+

+

+ + + + + + + + + + + + + + + +
+Synopsis:
+The BUTTON tag can contain HTML content, although it cannot contain +other form components, framesets, or hyperlinks. +

Within the threedee and flush styles the marginwidth and marginheight +attributes determine the button's insets (the gap between the button's border +and its content). The default marginwidth is 5 pixels, default marginheight 2 pixels. +

This tag takes the type attribute. The default type is submit. +

Note that to get the spacing and word-wrap you desire within the button it +is often advisable to format content using tables. +

+Example: +

+ + + + +
+<BUTTON style=lookandfeel bgcolor=ccaacc>
+  <IMG src="images/gift.gif" align=left>
+  <DIV align=center>Click<BR>here for<BR clear=left>your special<BR>
+  <FONT color=red><B><I>FREE GIFT!!</I></B></FONT></DIV>
+</BUTTON> +

+<BUTTON style=threedee bgcolor=palegreen>
+  <IMG src="images/gift.gif" align=left>
+  <DIV align=center>Click<BR>here for<BR clear=left>your special<BR>
+  <FONT color=red><B><I>FREE GIFT!!</I></B></FONT></DIV>
+</BUTTON> +

+<BUTTON style=flush bgcolor=aaaaee>
+  <IMG src="images/gift.gif" align=left>
+  <DIV align=center>Click<BR>here for<BR clear=left>your special<BR>
+  <FONT color=yellow><B><I>FREE GIFT!!</I></B></FONT></DIV>
+</BUTTON> +

+

+

+Rendering: +

+ ++ + + + + + + +
lookandfeelthreedeeflush
+ + + + + +
+
+

+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-checkbox.html b/extensions/calpa/Docs/html/guide-Forms-checkbox.html new file mode 100644 index 0000000..24cb3d2 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-checkbox.html @@ -0,0 +1,151 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Tag: INPUT (checkbox)
+

+

+ + + + + + + + + + + + +
+Default Rendering (no color modification): +

+ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
 lookandfeelthreedeeflush
uicontrol + Text Text Text
white + Text Text Text
black + Text Text Text
(light) + Text Text Text
(dark) + Text Text Text
+
+

+Setting color attributes: +

+ + + + +
+<TABLE border=2 cellspacing=2 cellpadding=5 width=200 bgcolor=uicontrol>
+  <COLGROUP span=2 align=center width=50%></COLGROUP>
+  <TR><TH>threedee</TH><TH>flush</TH></TR>
+  <TR><TD>
+    <INPUT type=checkbox style=threedee bgcolor=uicontrol> Text
+    <INPUT type=checkbox style=flush bgcolor=green text=white> Text
+  </TD></TR>
+ +  <TR bgcolor=779988><TD>
+    <INPUT type=checkbox style=threedee bgcolor=779988> Text
+    <INPUT type=checkbox style=flush bgcolor=779988 text=yellow> Text
+  </TD></TR>
+ +  <TR bgcolor=ee99aa><TD>
+    <INPUT type=checkbox style=threedee bgcolor=ee99aa> Text
+    <INPUT type=checkbox style=flush bgcolor=red text=white> Text
+  </TD></TR>
+ +  <TR bgcolor=ccaa22><TD>
+    <INPUT type=checkbox style=threedee bgcolor=ccaa22> Text
+    <INPUT type=checkbox style=flush bgcolor=ccaa22> Text
+  </TD></TR>
+ + +</TABLE> +
+

+

+

+Rendering: +
+ ++ + + + + + + + + + + + + + + + + + +
threedeeflush
Text Text
Text Text
Text Text
Text Text
+
+

+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-color.html b/extensions/calpa/Docs/html/guide-Forms-color.html new file mode 100644 index 0000000..03bda10 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-color.html @@ -0,0 +1,133 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Attr: bgcolor
+Attr: bordercolorlight
+Attr: bordercolordark
+Attr: bordercolor
+Attr: text
+Attr: arrowcolor
+

+

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Use Within:
+<INPUT> <TEXTAREA>, <SELECT>, <BUTTON>, + <LABEL> +
+Arguments: A hexidecimal color code or default color name
+e.g. bordercolorlight=A0A0A0 bordercolordark=green +
+Synopsis:
+bgcolor determines the base control color of the form component. +

bordercolorlight sets the highlight color of the component. +

bordercolordark sets the shadow color of the component. +

bordercolor sets the background of text components, lists etc.
+except when used within <LABEL> when it sets the label border color +

text sets the foreground (text) color. +

arrowcolor sets the color of arrows within comboboxes and scroll buttons. +

+Example: +

+ + + + +
+<TABLE border=3 cellspacing=3 cellpadding=5 bgcolor=6688aa>
+  <TR><TD align=center>
+    <SELECT style=flush text=white arrowcolor=white align=bottom>
+      <OPTION>Winnie the Pooh
+      <OPTION>Bambi
+      <OPTION>Babe
+      <OPTION>E.T.
+    </SELECT>
+  </TD></TR>
+  <TR><TD>
+    <TEXTAREA style=threedee bgcolor=6688aa rows=4 bordercolor=ddddff
+    align=bottom>Target locked...
+    </TEXTAREA>
+  </TD></TR>
+  <TR><TD align=center>
+    <INPUT style=threedee type=button bgcolor=dd0000 text=white
+     value=Fire align=bottom>
+  </TD></TR>
+</TABLE> +
+

+

+Rendering: +
+ + + + + +
+ +
+
+
+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-combobox.html b/extensions/calpa/Docs/html/guide-Forms-combobox.html new file mode 100644 index 0000000..e3f6ae9 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-combobox.html @@ -0,0 +1,188 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Tag: SELECT (combobox)
+

+

+ + + + + + + + + + + + +
+Default Rendering (no color modification): +

+

+ ++ + + + + + + +
lookandfeelthreedeeflush
+ + + + + +
+
+
+With color attributes: +

+ + +
+<SELECT style=threedee bgcolor=ccbbcc>
+<SELECT style=flush bgcolor=ccbbcc>
+
+

+ ++ + + + +
threedeeflush
+ + + +
+
+

+Use the bordercolorlight attribute to soften the inner highlight color +of the flush style +

+ + +
+<SELECT style=flush bgcolor=ccbbcc bordercolorlight=eeddee>
+
+

+ + +
+ + +
+

+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-labeltag.html b/extensions/calpa/Docs/html/guide-Forms-labeltag.html new file mode 100644 index 0000000..e53ac18 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-labeltag.html @@ -0,0 +1,101 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Tag: LABEL
+

+

+ + + + + + + + + + + + + + +
+Synopsis:
+The LABEL tag can contain HTML content, although it cannot contain +other form components, framesets, or hyperlinks. + +

The marginwidth and marginheight +attributes determine the label's insets (the gap between the button's border +and its content). The default marginwidth is 3 pixels, default marginheight 2 pixels. + +

Use the for attribute to transfer focus from a label to another +form component (see HTML4.0 spec). + +

Use the border attribute to set the size of the label's border and +the bordercolor attribute to set the border's color. + +

Use the dropshadow attribute to give the label a small shadow effect. + +

Note that to get the spacing and word-wrap you desire within the label it +is often advisable to format content using tables. + +

+Example: +

+ + + + +
+<LABEL dropshadow border=1 bordercolor=black bgcolor=ddddee>
+  <TABLE cellspacing=2><TR><TD align=center>
+    <FONT size=-1 face=helvetica>Call now for<BR>information</FONT>
+  </TD><TD>
+    <IMG src="images/phone.gif">
+  </TD></TR></TABLE>
+</LABEL>
+
+

+

+Rendering: +
+ +
+
+
+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-radio.html b/extensions/calpa/Docs/html/guide-Forms-radio.html new file mode 100644 index 0000000..afc5f75 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-radio.html @@ -0,0 +1,151 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Tag: INPUT (radio)
+

+

+ + + + + + + + + + +
+Default Rendering (no color modification): +

+ + ++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
 lookandfeelthreedeeflush
uicontrol + Text Text Text
white + Text Text Text
black + Text Text Text
(light) + Text Text Text
(dark) + Text Text Text
+ +
+

+Setting color attributes: +

+ + + + +
+<TABLE border=2 cellspacing=2 cellpadding=5 width=200 bgcolor=uicontrol>
+  <COLGROUP span=2 align=center width=50%></COLGROUP>
+  <TR><TH>threedee</TH><TH>flush</TH></TR>
+  <TR bgcolor=aa88aa><TD>
+    <INPUT type=radio style=threedee bgcolor=aa88aa> Text
+    <INPUT type=radio style=flush bgcolor=aa88aa> Text
+  </TD></TR>
+ +  <TR bgcolor=779988><TD>
+    <INPUT type=radio style=threedee bgcolor=779988> Text
+    <INPUT type=radio style=flush bgcolor=779988> Text
+  </TD></TR>
+ +  <TR bgcolor=ee99aa><TD>
+    <INPUT type=radio style=threedee bgcolor=ee99aa> Text
+    <INPUT type=radio style=flush bgcolor=ee99aa> Text
+  </TD></TR>
+ +  <TR bgcolor=ccaa22><TD>
+    <INPUT type=radio style=threedee bgcolor=ccaa22> Text
+    <INPUT type=radio style=flush bgcolor=ccaa22> Text
+  </TD></TR>
+ + +</TABLE> +
+

+

+

+Rendering: +
+ ++ + + + + + + + + + + + + + + + + + +
threedeeflush
Text Text
Text Text
Text Text
Text Text
+
+

+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-selection.html b/extensions/calpa/Docs/html/guide-Forms-selection.html new file mode 100644 index 0000000..d4fe659 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-selection.html @@ -0,0 +1,154 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Tag: SELECT (list)
+

+

+ + + + + + + +
+Default Rendering (no color modification): +

+

+ ++ + + + + + + +
lookandfeelthreedeeflush
+ + + + + +
+
+
+With color attributes: +

+ + +
+<SELECT style=threedee bgcolor=mediumturquoise size=5>
+<SELECT style=flush bgcolor=mediumturquoise size=5>
+
+

+ ++ + + + +
threedeeflush
+ + + +
+
+

+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-style.html b/extensions/calpa/Docs/html/guide-Forms-style.html new file mode 100644 index 0000000..c760ea0 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-style.html @@ -0,0 +1,188 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Attr: style
+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Use Within:
+<INPUT> <TEXTAREA>, <SELECT>, <BUTTON> +
+Arguments: lookandfeel | threedee | flush +
+Synopsis:
+Certain Swing Look & Feel controls do not render well within HTML documents +due to default color, sizing, opacity and border settings on the component. +The CalHTMLPane supports two additional rendering styles: threedee +and flush which will give consistent rendering irrespective of the +installed Look & Feel. + +

Note that styles can be freely mixed within a document. +

+

Examples of THREEDEE style form rendering
+ + +
+ + + + + + + +
Personal Details
Your name
Address
Zip Code
Email address
+ +
+
+		 + + +
+ + + + + + + +
Personal Details
Your name
Address
Zip Code
Email address
+ +
+
+
Examples of FLUSH style form rendering
+ + +
+ + + + + + + +
Personal Details
Your name
Address
Zip Code
Email address
+ +
+
+		 + + +
+ + + + + + + +
Personal Details
Your name
Address
Zip Code
Email address
+ +
+
+
Examples of LOOKANDFEEL style form rendering
+ + +
+ + + + + + + +
Personal Details
Your name
Address
Zip Code
Email address
+ +
+
+		 + + +
+ + + + + + + +
Personal Details
Your name
Address
Zip Code
Email address
+ +
+
+
+ +

+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-text.html b/extensions/calpa/Docs/html/guide-Forms-text.html new file mode 100644 index 0000000..0340d55 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-text.html @@ -0,0 +1,143 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Tag: INPUT (text)
+Tag: INPUT (password)
+Tag: TEXTAREA
+

+

+ + + + + + + + + + + + + +
+Default Rendering (no color modification, size=18): +

+ + ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 uicontrol backgroundwhite background
lookandfeel +
threedee +
flush +
 light backgrounddark background
lookandfeel +
threedee +
flush +
+
+

+Setting color attributes: +

+ + + + +
+<TABLE border=2 cellspacing=2 cellpadding=5 bgcolor=gray>
+  <COLGROUP span=2 align=center></COLGROUP>
+  <TR>
+    <TH><FONT color=white>threedee</FONT></TH>
+    <TH><FONT color=white>flush</FONT></TH>
+  </TR>
+  <TR>
+    <TD><TEXTAREA rows=4 style=threedee
+      bgcolor=gray>Some sample text</TEXTAREA></TD>
+    <TD><TEXTAREA rows=4 style=flush bordercolor=maroon
+      text=yellow>Some sample text</TEXTAREA></TD>
+  <TR>
+</TABLE> +
+

+

+

+Rendering: +
+ ++ + + + + + +
threedeeflush
+ +
+
+

+Implementation Notes:
+
    +
  • Note that the background color of text components is set with the bordercolor
    +attribute. +
  • Input into textfields can be constrained using the maxlength attribute +
  • Swing's JTextArea normally allows tabbing within it, but this has been changed
    +within the CalPane to allow for consistent keyboard navigation +
+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Forms-uiscrollcolors.html b/extensions/calpa/Docs/html/guide-Forms-uiscrollcolors.html new file mode 100644 index 0000000..ffd053b --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Forms-uiscrollcolors.html @@ -0,0 +1,149 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+2: Forms +

+

+

+Attr: uiscrollcolors
+

+

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Use Within:
+<TEXTAREA>, <SELECT>, +
+Arguments: None +
+Synopsis:
+This attribute attempts to match the scrollbar thumb color in the +THREEDEE and FLUSH rendering styles to that of the installed Look And +Feel. +

It relies on consistent information being available within the PLAF +UIDefaults hashtable. +

To see the effect of using this attribute you need to view the given example +in a L&F which uses a distinctive scrollbar thumb color, such as MetalLookAndFeel. +

+Example: +

+ + + + +
+<TABLE border=2 cellspacing=2 cellpadding=20 bgcolor=uicontrol>
+  <TR><TD align=center>
+    <SELECT style=threedee uiscrollcolors align=abstop>
+      <OPTION>One
+      <OPTION>Two
+      <OPTION>Three
+      <OPTION>Four
+      <OPTION>Five
+      <OPTION>Six
+      <OPTION>Seven
+      <OPTION>Eight
+      <OPTION>Nine
+      <OPTION>Ten
+      <OPTION>Eleven
+      <OPTION>Twelve
+    </SELECT>
+    &nbsp;
+    <SELECT style=flush size=4 uiscrollcolors align=abstop>
+      <OPTION>Monday
+      <OPTION>Tuesday
+      <OPTION>Wednesday
+      <OPTION>Thursday
+      <OPTION>Friday
+      <OPTION>Saturday
+      <OPTION>Sunday
+    </SELECT>
+ +  </TD></TR>
+</TABLE> +
+

+

+Rendering: +
+ + + +
+ +  + +
+
+
+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Frames-iframe.html b/extensions/calpa/Docs/html/guide-Frames-iframe.html new file mode 100644 index 0000000..b732403 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Frames-iframe.html @@ -0,0 +1,99 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+3: Frames +

+

+

+Tag: IFRAME
+

+

+ + + + + + + + + + + + + + + +
+Synopsis:
+Creates an inline frame which can be dynamically updated with documents. +See the HTML4.0 spec for details. Placing an IFRAME in your document is much +like placing an image. For this reason the hspace and vspace +attributes are supported in addition to the usual frame attributes. +

Always remember to use the closing </IFRAME> tag. Content between +the opening and closing tags is for HTML viewers which do not support inline +frames, and you will lose the rest of the document if you omit the closing +tag (not just in the CalPane, but in browsers such as IE4 as well). +
+

+Example: +

+ + + + +
+<IFRAME hspace=4 vspace=4 align=left src="newsflash.html"
+  width=400 height=300 name=myiframe></IFRAME>
+This is a floating inline frame. Text will wrap around it as normal. Note
+that the frame will handle its own internal links or it can be updated
+externally. +<BR clear=left>
+<P align=center><A href="techupdate.html" target=myiframe>
+Press here to update the frame with a new document</A><BR> + +
+

+

+Rendering: +

+ +This is a floating inline frame. Text will wrap around it as normal. Note +that the frame will handle its own internal links or it can be updated +externally. + +
+

Press here +to update the frame with a new document
+ +
+

+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next + +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Images-imagemap.html b/extensions/calpa/Docs/html/guide-Images-imagemap.html new file mode 100644 index 0000000..daea46f --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Images-imagemap.html @@ -0,0 +1,169 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+4: Images +

+

+

+Tag: MAP
+Tag:AREA
+Attr: usemap +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Synopsis:
+The CalHTMLPane supports the rect, circle and poly shapes within the +AREA tag. + +

Coords can be expressed in absolute or percentage terms. +

+Example 1: +

+ + + + +
+<P align=center>
+<IMG src="images/map.gif" usemap="#test" width=200 height=100>
+<MAP name=test>
+<AREA shape="rect" coords="25,25,55,85" href="maprect.html" target=myiframe2>
+<AREA shape="circle" coords="100,50,15" href="mapcircle.html" target=myiframe2>
+<AREA shape="poly" coords=150,25,125,70,175,70 href="maptriangle.html" target=myiframe2>
+</MAP>
+<P align=center>
+<TABLE frame=void rules=all cellspacing=0 cellpadding=0>
+<TR><TD bordercolor=black>
+<IFRAME frameborder=0 scrolling=no name="myiframe2" width=300 height=100></IFRAME>
+</TD></TR>
+</TABLE>
+ + +
+

+

+Rendering: +
+

+ + + + + + +

+ + +
+ +
+
+

+Example 2:
+In the first example we used the actual size of the image (200 x 100 pixels) and used +the real coords of the shapes within that image. If we placed the image in +a document at a different size (say 250 x 125 pixels) the imagemap would no +longer work correctly. However, by using percentage instead of absolute coordinates we can place +the image at any size within our document, providing its aspect ratio is +maintained. + +

Take the rectangle as an example. You can see that its coords in the +200 x 100 image are 25, 25, 55, 85. This is equivalent to 12.5%, 25%, 27.5%, 85%. +We can't use fractions so we enter these coords into the map as: +

coords="12%,25%,27%,85%" +

The percentage coords are therefore slightly inexact, but this is not +normally much of a problem. + +

Here's the whole example using percentage coords, demonstrating that two +completely different image sizes can use the same map: +

+ + + + +
+<P align=center>
+<IMG src="images/map.gif" usemap="#test2" width=300 height=150>
+<IMG src="images/map.gif" usemap="#test2" width=150 height=75>
+<MAP name=test2>
+<AREA shape="rect" coords="12%,25%,27%,85%" href="maprect.html" target=myiframe3>
+<AREA shape="circle" coords="50%,50%,7%" href="mapcircle.html" target=myiframe3>
+<AREA shape="poly" coords=75%,25%,62%,70%,87%,70% href="maptriangle.html" target=myiframe3>
+</MAP>
+<P align=center>
+<TABLE frame=void rules=all cellspacing=0 cellpadding=0>
+<TR><TD bordercolor=black>
+<IFRAME frameborder=0 scrolling=no name="myiframe3" width=300 height=100></IFRAME>
+</TD></TR>
+</TABLE>
+
+

+

+Rendering: +
+

+ + + + + + + +

+ + +
+ +
+
+

+ + +

+ + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Misc-align.html b/extensions/calpa/Docs/html/guide-Misc-align.html new file mode 100644 index 0000000..9f79336 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Misc-align.html @@ -0,0 +1,128 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+5: Misc +

+

+

+Attr: align +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Use With:
+Images, form components, inline frames, <OBJECT> tag +
+Arguments: +abstop | top | absmiddle | middle | texttop | baseline | bottom | absbottom | left | right
+
+Synopsis:
+abstop aligns the object to the top of the line +

top and texttop align the object to the top of any text +

absmiddle aligns the object to the center point of the line +

middle aligns the object to the middle of any text +

bottom and baseline align the object to the baseline of any text +

absbottom aligns the object to the bottom of the line +

left will float the object on the left margin +

right will float the object on the right margin +

+Example: +

+ + + + +
+ +<TABLE width=100% border=0 cellspacing=0 cellpadding=1 bgcolor=black><TR><TD></TD></TR></TABLE>
+<IMG src="nosrc.gif" alt="top texttop" align=top width=80 height=80>
+Some text
+<IMG src="nosrc.gif" alt="bottom baseline" align=bottom width=80 height=50>
+more
+<IMG src="nosrc.gif" alt="abstop" align=abstop width=80 height=80>
+more
+<IMG src="nosrc.gif" alt="middle" align=middle width=80 height=80>
+more
+<IMG src="nosrc.gif" alt="absmiddle" align=absmiddle width=100 height=80>
+more
+<IMG src="nosrc.gif" alt="absbottom" align=absbottom width=100 height=50>
+<TABLE width=100% border=0 cellspacing=0 cellpadding=1 bgcolor=black><TR><TD></TD></TR></TABLE>
+ + + + + + + +
+

+

+Rendering: +
+

+
+top texttop +Some text +bottom baseline +more +abstop +more +middle +more +absmiddle +more +absbottom +
+
+
+

+ +

+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Misc-colornames.html b/extensions/calpa/Docs/html/guide-Misc-colornames.html new file mode 100644 index 0000000..0099074 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Misc-colornames.html @@ -0,0 +1,262 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+5: Misc +

+

+

+Default Color Names
+The following default color names are supported by the CalHTMLPane: +

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameExampleHex valueNameExampleHex value
aliceblue #f0f8fflightskyblue #87cefa
antiquewhite #faebd7lightslategray #778899
aqua #00fffflightsteelblue #b0c4de
aquamarine #7fffd4lightyellow #ffffe0
azure #f0fffflime #00ff00
beige #f5f5dclimegreen #32cd32
bisque #ffe4c4linen #faf0e6
black #000000magenta #ff00ff
blanchedalmond #ffebcdmaroon #800000
blue #0000ffmediumaquamarine #66cdaa
blueviolet #8a2be2mediumblue #0000cd
brown #a52a2amediumorchid #ba55d3
burlywood #deb887mediumpurple #9370db
cadetblue #5f9ea0mediumseagreen #3cb371
chartreuse #7fff00mediumslateblue #7b68ee
chocolate #d2691emediumspringgreen #00fa9a
coral #ff7f50mediumturquoise #48d1cc
cornflowerblue #6495edmediumvioletred #c71585
cornsilk #fff8dcmidnightblue #191970
crimson #dc143cmintcream #f5fffa
cyan #00ffffmistyrose #ffe4e1
darkblue #00008bmoccasin #ffe4b5
darkcyan #008b8bnavajowhite #ffdead
darkgoldenrod #b8860bnavy #000080
darkgray #a9a9a9oldlace #fdf5e6
darkgreen #006400olive #808000
darkkhaki #bdb76bolivedrab #6b8e23
darkmagenta #8b008borange #ffa500
darkolivegreen #556b2forangered #ff4500
darkorange #ff8c00orchid #da70d6
darkorchid #9932ccpalegoldenrod #eee8aa
darkred #8b0000palegreen #98fb98
darksalmon #e9967apaleturquoise #afeeee
darkseagreen #8fbc8fpalevioletred #db7093
darkslateblue #483d8bpapayawhip #ffefd5
darkslategray #2f4f4fpeachpuff #ffdab9
darkturquoise #00ced1peru #cd853f
darkviolet #9400d3pink #ffc0cb
deeppink #ff1493plum #dda0dd
deepskyblue #00bfffpowderblue #b0e0e6
dimgray #696969purple #800080
dodgerblue #1e90ffred #ff0000
firebrick #b22222rosybrown #bc8f8f
floralwhite #fffaf0royalblue #4169e1
forestgreen #228b22saddlebrown #8b4513
fuchsia #ff00ffsalmon #fa8072
ghostwhite #f8f8ffsandybrown #f4a460
gainsboro #dcdcdcseagreen #2e8b57
gold #ffd700seashell #fff5ee
goldenrod #daa520sienna #a0522d
gray #808080silver #c0c0c0
green #008000skyblue #87ceeb
greenyellow #adff2fslateblue #6a5acd
honeydew #f0fff0slategray #708090
hotpink #ff69b4snow #fffafa
indianred #cd5c5cspringgreen #00ff7f
indigo #4b0082steelblue #4682b4
ivory #fffff0tan #d2b48c
khaki #f0e68cteal #008080
lavender #e6e6fathistle #d8bfd8
lavenderblush #fff0f5tomato #ff6347
lawngreen #7cfc00turquoise #40e0d0
lemonchiffon #fffacduicontrol (variable)
lightblue #add8e6uihighlight (variable)
lightcoral #f08080uishadow (variable)
lightcyan #e0ffffviolet #ee82ee
lightgoldenrodyellow #fafad2wheat #f5deb3
lightgreen #90ee90white #ffffff
lightgrey #d3d3d3whitesmoke #f5f5f5
lightpink #ffb6c1yellow #ffff00
lightsalmon #ffa07ayellowgreen #9acd32
lightseagreen #20b2aa   
+
+

+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Misc-float.html b/extensions/calpa/Docs/html/guide-Misc-float.html new file mode 100644 index 0000000..beb85df --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Misc-float.html @@ -0,0 +1,126 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+5: Misc +

+

+

+Attr: align (floating) +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Use With:
+Tables, Images, form components, inline frames, <OBJECT> tag +
+Arguments: +left | right
+
+Synopsis:
+

left will float the object on the left margin +

right will float the object on the right margin +

Multiple objects may be floated left and right. +

  • Note that you need to be sure when using right-aligned floats that there is sufficient +space between the left and right margins. If horizontal space becomes too +narrow you may see rendering problems as +text or other objects begin to overlap the right hand float. You should be +able to see this happen in the example below if you gradually reduce the width +of the display frame. This is an effect of asynchronous +parsing/loading, and you will experience the same rendering effect on a Web browser +such as Internet Explorer 4. +
+
+Example: +

+ + + + +
+This is a start of the text and you can
+<IMG src="images/orchid.gif" width=100 height=94 align=left>
+<IMG src="images/orchid.gif" width=100 height=94 align=right>
+see that even though we inserted two images between the words 'can' and 'see', +the text
+<TABLE border align=left cellpadding=3>
+  <TR><TD>Floating table</TD></TR>
+</TABLE>
+<INPUT align=right type=button value="Floating button">
+will continue on the same line as if the images have been ignored. +Only when a new line occurs will the images be inserted against the right and +left margins. We've also floated a table and a form component to demonstrate +that multiple objects can be floated. You need to be careful when using +right margin floats if you are authoring documents for small displays. +Rendering errors can occur if the display width becomes too narrow. +
+

+

+Rendering: +
+

+This is a start of the text and you can + + +see that even though we inserted two images between the words 'can' and 'see', +the text +
Floating table
+ +will continue on the same line as if the images have been ignored. +Only when a new line occurs will the images be inserted against the right and +left margins. We've also floated a table and a form component to demonstrate +that multiple objects can be floated. You need to be careful when using +right margin floats if you are authoring documents for small displays. +Rendering errors can occur if the display width becomes too narrow. +
+
+

+ +

+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Misc-lines.html b/extensions/calpa/Docs/html/guide-Misc-lines.html new file mode 100644 index 0000000..fe67c5e --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Misc-lines.html @@ -0,0 +1,119 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+5: Misc +

+

+

+Drawing horizontal lines
+

+

+ + + + + + +
+The standard way to draw a horizontal line is to use the <HR> tag: +

+ + +
+<HR width=100%> +
+

+ +


+In a CalHTMLPane this tag can also take a color argument: +

+ +
+<HR width=100% color=green size=1> +
+

+ +


+The <HR> tag line-breaks and creates automatic spacing. However this is +not always desired, and in such cases the <TABLE> tag can be used to +create lines. We draw two such lines below to show that no space is created +between successive lines. +

+ +
+<TABLE width=100% bgcolor=blue cellspacing=0 border=0 cellpadding=1>
+  <TR><TD></TD></TR>
+</TABLE>
+<TABLE width=50% bgcolor=yellow cellspacing=0 border=0 cellpadding=1>
+  <TR><TD></TD></TR>
+</TABLE> + +
+

+ + +
+ + +
+ +


+Lines drawn using the <TABLE> tag can be inset: +

+ +
+<TABLE width=100% frame=none cellspacing=0 cellpadding=0 rules=all>
+  <TR><TD></TD></TR>
+</TABLE>
+ +
+

+ + +
+ +


+...or by reversing the cell border colors, a raised line can be drawn: +

+ +
+<TABLE width=100% frame=none cellspacing=0 cellpadding=0 rules=all>
+  <TR><TD bordercolorlight=uishadow bordercolordark=uicontrol></TD></TR>
+</TABLE>
+ +
+

+ + +
+ +
+

+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Prog-answers.html b/extensions/calpa/Docs/html/guide-Prog-answers.html new file mode 100644 index 0000000..909eff6 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Prog-answers.html @@ -0,0 +1,103 @@ + + + + + + + + +
+CalHTMLPane v2.0 Guide + +Programming Answers +
+
+ +

Programming Answers

+
+ +

+

+

+1. I don't want hyperlinks to be marked as visited and I can't see +a method in CalHTMLPreferences to turn this feature off. +

+The easiest way to turn this off is simply to set the default color of +visited links to that of unvisited links. You can do this through a +method in CalHTMLPreferences. + +So your code will look something like this: +

+CalHTMLPreferences pref = new CalHTMLPreferences();
+pref.setDefaultColor(CalCons.A_VLINK, pref.getDefaultColor(CalCons.A_LINK));
+CalHTMLPane pane = new CalHTMLPane(pref, null, null);
+
+ +
+2. CalPane uses THREEDEE style form components as default. I'd like +to have LOOKANDFEEL components as default. How do I do this? +

+You can make all components render in the current Look And Feel by +setting a property in CalHTMLPreferences: +

+CalHTMLPreferences pref = new CalHTMLPreferences();
+pref.setFormRenderingStyle(CalCons.USE_LOOK_AND_FEEL);
+CalHTMLPane pane = new CalHTMLPane(pref, null, null);
+
+
+3. Is it possible to do something like hyperlink-hover which you see in +some help systems? +

+Yes, there's a method in CalHTMLPreferences that enables you to do this: +

+CalHTMLPreferences pref = new CalHTMLPreferences();
+pref.setShowHyperlinkOnMouseFocus(true);
+CalHTMLPane pane = new CalHTMLPane(pref, null, null);
+
+
+4. I'm including some form components in a table. Each component is +in its own table cell and the cell has got a border. I want the component to fill the cell, +but there's always a gap above it. How can I get rid of this? +

+Change the alignment of the form component to something other than its default, which is a few +pixels below the text baseline. For example: +

+<TD><INPUT type=text align=top></TD> +

+
+5. I've got a document which has many form controls, each of which has its +own id. I get the the CalPane to load this document and then I call the getIDComponents() +method to access the components. However the Hashtable returned from this call is empty. +Here's my code: + +

+pane.showHTMLDocument(url);
+pane.getIDComponents(null);
+
+ +The CalPane will load the document asynchronously, so the showHTMLDocument() method will return +immediately, and you are consequently making the call to get the components before they +have been created. You need to ensure that the document has loaded before you try and get the components. You can +either do this by using CalHTMLObserver callbacks to monitor document loading, or you can force +the document to load synchronously with the setLoadSynchronously() method like this: + +
+pane.setLoadSynchronously(true);
+pane.showHTMLDocument(url);
+pane.setLoadSynchronously(false);
+pane.getIDComponents(null);
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Tables-background.html b/extensions/calpa/Docs/html/guide-Tables-background.html new file mode 100644 index 0000000..76b8523 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Tables-background.html @@ -0,0 +1,133 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+1: Tables +

+

+

+Attr: bgcolor +

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Use Within:
+<TABLE> <THEAD>, <TBODY>, <TFOOT>, + <TR>, <COLGROUP>, <COL>, <TH>, and <TD> +
+Arguments: A hexidecimal color code or default color name.
+(e.g. bgcolor=4488AA, bgcolor=silver) +
+Synopsis:
+Sets the background color of a table, table row, table cell etc. +

+When used within the <TABLE> tag, Netscape Navigator applies the +specified color only to the <TD/TH> elements within the table - any +border areas produced with the cellspacing attribute remain in the +background color of the table's parent (either the document itself or perhaps +a parent <TD/TH> element). Internet Explorer however renders +all of the table in the specified background color. +

+The CalPane follows Explorer in this respect, except +the Pane uses computed colors for any highlight and shadow lines in the table. +

+Example: +

+ + + + +
+<TABLE border=1 cellspacing=3 cellpadding=2 bgcolor=mediumaquamarine>
+  <TR><TD> Background Test +</TD></TR>
+</TABLE> +
+

+

+Rendering: + + + + + + + + + + + + +
Navigator Explorer CalPane
+ + +
Background test
+		    +
Background test
+		    +
Background test
+
+
+Implementation Notes:
+
    +
  • Some document authors who do not test their pages across multiple browsers +assume all table rendering is identical to Navigator. They therefore often +remove the border from a table similar to the one above in order to get +'empty space' around the TD element. They then proceed to align text and +images alongside the table, not realising that when such markup is viewed on a browser such +as Explorer no such 'empty space' exists. This leaves the text and images +completely flush to the table making the document seem poorly formatted. +
+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Tables-bordercolors.html b/extensions/calpa/Docs/html/guide-Tables-bordercolors.html new file mode 100644 index 0000000..169a089 --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Tables-bordercolors.html @@ -0,0 +1,107 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+1: Tables +

+

+

+Attr: bordercolor
+Attr: bordercolorlight
+Attr: bordercolordark +

+

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Use Within:
+<TABLE> <THEAD>, <TBODY>, <TFOOT>, + <TR>, <COLGROUP>, <COL>, <TH>, and <TD> +
+Arguments: A hexidecimal color code or default color name
+e.g. bordercolorlight="#4444dd" bordercolordark=navy +
+Synopsis:
Set the highlight color of table borders and rules + with bordercolorlight. +

Set the shadow color with bordercolordark. +

For single-color borders and rules use bordercolor. +

+Example: +

+ + + + +
+<TABLE border=3 cellspacing=3 cellpadding=5 bgcolor=aaccdd>
+  <TR>
+    <TD bordercolor=red> Red border +</TD>
+    <TD bordercolorlight=yellow bordercolordark=blue>
+       Blue shadow +<BR> Yellow highlight
+    </TD>
+  </TR>
+</TABLE> +
+

+

+Rendering: +
+ + + + +
Red border +Blue shadow
Yellow highlight
+
+
+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Tables-borders.html b/extensions/calpa/Docs/html/guide-Tables-borders.html new file mode 100644 index 0000000..5a4347d --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Tables-borders.html @@ -0,0 +1,174 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+1: Tables +

+

+

+Attr: frame
+Attr: border
+Attr: rules
+ +

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Use Within:
+<TABLE> +
+Arguments:
+frame: void | border | box | +hsides | vsides | above | below | lhs | rhs
+border: A number >=0 or no argument
+rules: none | groups | cols | +rows | all
+ + +
+Synopsis:
The border attribute specifies the thickness of any +border to be drawn around a table. +

The frame attribute determines which sides of the table any border +should be drawn. +

The rules attribute determines how lines between table cells are +drawn. + +

+

    +
  • "border=0" is equivalent to "frame=void"
    +
  • "frame=border" is equivalent to "frame=box"
    +
  • "border" with no argument is now deprecated but backward compatibility +requires a rendering equivalent to: "frame=border" "border=1" "rules=all" +

    +

+Example 1: +

+ + + + +
+<TABLE cellspacing=2 cellpadding=2 border=2 frame=hsides
bordercolor=maroon rules=none>
+  <TR>
+    <TD> Frequently Asked Questions +</TD>
+  </TR>
+</TABLE> +
+

+

+Rendering: +
+ + +
Frequently Asked Questions
+
+
+Example 2: +

+ + + + +
+ +<TABLE width=250 rules=groups bgcolor=plum border=3
+frame=box cellspacing=0>
+<COLGROUP span=1 align=center></COLGROUP>
+<COLGROUP span=2 align=center></COLGROUP>
+<COLGROUP span=1 align=center></COLGROUP>
+<THEAD>
+  <TR><TD colspan=4 align=center><B>Junior Attendees</B></TD></TR>
+</THEAD>
+<TBODY>
+  <TR><TH></TH><TH>Boys</TH><TH>Girls</TH><TH>Total</TH></TR>
+</TBODY>
+<TBODY>
+  <TR><TH>1997</TH><TD>16</TD><TD>18</TD><TD>34</TD></TR>
+  <TR><TH>1997</TH><TD>22</TD><TD>31</TD><TD>53</TD></TR>
+</TBODY>
+<TBODY>
+  <TR><TH>Total</TH><TD>38</TD><TD>49</TD><TD>87</TD></TR>
+</TBODY>
+</TABLE> +
+

+ + +

+Rendering: +
+ + + + + + + + + + + + + + + + + +
Junior Attendees
BoysGirlsTotal
1997161834
1998223153
Total384987
+
+
+
+
+ + + + + +
+Guide Index  | + JavaDoc  | + Previous  | + Next +
+ + + diff --git a/extensions/calpa/Docs/html/guide-Tables-widths.html b/extensions/calpa/Docs/html/guide-Tables-widths.html new file mode 100644 index 0000000..6f7064c --- /dev/null +++ b/extensions/calpa/Docs/html/guide-Tables-widths.html @@ -0,0 +1,104 @@ + + +

+ + + + + +
+CalHTMLPane v2.0 Guide + +Example Tag Usage +
+

+

+1: Tables +

+

+

+Column widths
+ +

+ + + + + + + + + +
+Synopsis:
+Table column widths can be expressed in absolute, percentage, or relative +form. See HTML4.0 spec for details. +
+Example: +

+ + + + +
+ +<TABLE border=1 width=100% align=center cellpadding=2 bgcolor=sandybrown>
+  <COLGROUP align=center>
+    <COL width=100>
+    <COL width=10%>
+    <COL width=0*>
+    <COL span=3 width=*>
+    <COL width=2*>
+  </COLGROUP>
+  <TR>
+    <TD>100 Pixels</TD><TD>10%</TD><TD>0*</TD>
+    <TD>1*</TD><TD>1*</TD><TD>1*</TD><TD>2*</TD>
+  </TR>
+</TABLE>
+
+

+ + +

+Rendering: +

+ +++++++ + + + + +
100 Pixels10%0*1*1*1*2*
+

+Column 1 requests an absolute width of 100 pixels
+Column 2 requests 10% of available width
+Column 3 requests that it always be set to its minimum width
+Columns 4-7 request proportions of the remaining width +
  • Columns 4, 5 and 6 each request one portion of the remainder +
  • Column 7 requests two portions of the remainder + +

    Note that the eventual apportionment of widths to each column depends +very much on the amount of space available to the table. +

    • +
    +

    + + + + + +
    +Guide Index  | + JavaDoc  | + Previous  | + Next +
    + + + diff --git a/extensions/calpa/Docs/html/images/bill.gif b/extensions/calpa/Docs/html/images/bill.gif new file mode 100644 index 0000000..c91ae37 Binary files /dev/null and b/extensions/calpa/Docs/html/images/bill.gif differ diff --git a/extensions/calpa/Docs/html/images/flash.gif b/extensions/calpa/Docs/html/images/flash.gif new file mode 100644 index 0000000..d969b68 Binary files /dev/null and b/extensions/calpa/Docs/html/images/flash.gif differ diff --git a/extensions/calpa/Docs/html/images/gift.gif b/extensions/calpa/Docs/html/images/gift.gif new file mode 100644 index 0000000..7156410 Binary files /dev/null and b/extensions/calpa/Docs/html/images/gift.gif differ diff --git a/extensions/calpa/Docs/html/images/map.gif b/extensions/calpa/Docs/html/images/map.gif new file mode 100644 index 0000000..3aeea9a Binary files /dev/null and b/extensions/calpa/Docs/html/images/map.gif differ diff --git a/extensions/calpa/Docs/html/images/orchid.gif b/extensions/calpa/Docs/html/images/orchid.gif new file mode 100644 index 0000000..b9e77ce Binary files /dev/null and b/extensions/calpa/Docs/html/images/orchid.gif differ diff --git a/extensions/calpa/Docs/html/images/phone.gif b/extensions/calpa/Docs/html/images/phone.gif new file mode 100644 index 0000000..c4c69da Binary files /dev/null and b/extensions/calpa/Docs/html/images/phone.gif differ diff --git a/extensions/calpa/Docs/html/images/scott.gif b/extensions/calpa/Docs/html/images/scott.gif new file mode 100644 index 0000000..20eb92e Binary files /dev/null and b/extensions/calpa/Docs/html/images/scott.gif differ diff --git a/extensions/calpa/Docs/html/mapcircle.html b/extensions/calpa/Docs/html/mapcircle.html new file mode 100644 index 0000000..8ffd62c --- /dev/null +++ b/extensions/calpa/Docs/html/mapcircle.html @@ -0,0 +1,8 @@ + + +
    +

    Circle Link

    +You clicked within the circle +
    + + diff --git a/extensions/calpa/Docs/html/maprect.html b/extensions/calpa/Docs/html/maprect.html new file mode 100644 index 0000000..71a67e4 --- /dev/null +++ b/extensions/calpa/Docs/html/maprect.html @@ -0,0 +1,8 @@ + + +
    +

    Rectangle Link

    +You clicked within the rectangle +
    + + diff --git a/extensions/calpa/Docs/html/maptriangle.html b/extensions/calpa/Docs/html/maptriangle.html new file mode 100644 index 0000000..8129a38 --- /dev/null +++ b/extensions/calpa/Docs/html/maptriangle.html @@ -0,0 +1,8 @@ + + +
    +

    Triangle Link

    +You clicked within the triangle +
    + + diff --git a/extensions/calpa/Docs/html/newsflash.html b/extensions/calpa/Docs/html/newsflash.html new file mode 100644 index 0000000..82384b3 --- /dev/null +++ b/extensions/calpa/Docs/html/newsflash.html @@ -0,0 +1,34 @@ + + +
    + + + + + + + +
        
    + +

    Gates and McNealy accused of collusion

    + +
    +

    Washington Tues 9th 2001: The computer world was left reeling today as +sensational evidence emerged that Sun Microsysytems chief Scott McNealy and +Microsoft chairman William H. Gates had agreed almost ten years ago on a +strategy that would leave them in complete dominance of the computer software +marketplace. + +

    Former Microsoft vice-president Ima Lyer claims he has 'irrefutable evidence' +that the two industry giants have been hoodwinking both politicians +and public for the past decade. In a written statement released by his legal +advisors to the press this morning, Lyer gives a detailed account of how +'Operation JAVA' was formulated by Gates and McNealy to remove all but minor +competition in the software industry.
    +(More details to follow) + +

    Next news + +

    + + diff --git a/extensions/calpa/Docs/html/newsflash2.html b/extensions/calpa/Docs/html/newsflash2.html new file mode 100644 index 0000000..cf583b1 --- /dev/null +++ b/extensions/calpa/Docs/html/newsflash2.html @@ -0,0 +1,23 @@ + + +
    +

    + +

    Former Microsoft vice-president retracts collusion claims

    + +
    +

    Washington Tues 9th 2001: Former Microsoft executive +Ima Lyer this afternoon surprisingly retracted his earlier claims that Microsoft +chairman William Gates and Sun Microsytems chief Scott McNealy conspired +to create a duopoly within the software marketplace. + +

    Speaking from the footsteps of his new $25 million private jet which was about +to whisk him away to his new luxury island retreat in the Caribbean, Mr. Lyer +said that he had been overworking recently and this had led him to make +"spurious and unsupportable claims" about the two industry leaders. + +

    Earlier news + +

    + + diff --git a/extensions/calpa/Docs/html/techupdate.html b/extensions/calpa/Docs/html/techupdate.html new file mode 100644 index 0000000..b88c1e1 --- /dev/null +++ b/extensions/calpa/Docs/html/techupdate.html @@ -0,0 +1,36 @@ + + +
    +

    TECH NEWS

    +

    Sun claims HotSpot JIT 'almost ready'

    + + +

    Palo Alto Tues 9th 2001: In a presentation to assembled +computer journalists this morning, Sun Microsystems executives announced +that the eagerly-awaited HotSpot Just-In-Time compiler was on the verge of +being released. +

    +"There are just a few last minute problems to clear and then we'll be +shipping," said a confident Dan Pinocchio, leader of the HotSpot design team. +

    +Details also emerged of the hardware that will be required to run the HotSpot +package, which Sun officials claim will enable Java applications to run at up +to ten times their normal speed. +

    +"You can run HotSpot on a 500Mhz PIII, but you won't see much of a boost," +Pinocchio explained. "We've found the best performance uplift comes when you +combine HotSpot with one of the new Cray XMP6 PC accelerator cards. Okay, +they cost $25,000, but you should see Java fly...". +

    +Asked to be a little more specific about a release date, marketing +vice-president Jerry Vaporware wasn't going to pinned down: +

    +"I'm not going to make any promises," he told the packed press room. "Our +developers have waited a long time for this and we want to get it right. A +few more ye...excuse me...weeks won't hurt." + +

    Latest news + +

    + + diff --git a/extensions/calpa/Docs/javadoc/allclasses-frame.html b/extensions/calpa/Docs/javadoc/allclasses-frame.html new file mode 100644 index 0000000..6e61098 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/allclasses-frame.html @@ -0,0 +1,33 @@ + + + + + + +All Classes + + + + + +All Classes +
    + + + + + +
    CalHTMLManager +
    +CalHTMLObserver +
    +CalHTMLPane +
    +CalHTMLPreferences +
    +DefaultCalHTMLObserver +
    +
    + + + diff --git a/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLManager.html b/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLManager.html new file mode 100644 index 0000000..bbeebe3 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLManager.html @@ -0,0 +1,545 @@ + + + + + + +: Class CalHTMLManager + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + +

    + +calpa.html +
    +Class CalHTMLManager

    +
    +java.lang.Object
+  |
+  +--calpa.html.CalHTMLManager
+
    +
    +
    +
    public class CalHTMLManager
    extends java.lang.Object
    + +

    +A class with static members and methods which primarily controls the caching of data + which will be available to all current instances of CalHTMLPane. +

    +

    +
    See Also:
    CalHTMLPane
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static voidaddUserComponent(javax.swing.JComponent component) + +
    +          Adds a JComponent to the Manager's component cache.
    +static voidaddUserComponentArray(javax.swing.JComponent[] componentArray, + java.lang.String classname) + +
    +          Adds an array of JComponents to the Manager's component cache.
    +static voidaddUserImage(java.awt.Image img, + java.lang.String name) + +
    +          Adds an Image to the Manager's image cache.
    +static voidemptyDocumentCache() + +
    +          Empties the Manager's document cache.
    +static intgetDocumentCacheCurrentSize() + +
    +          Returns the Manager's estimate of the current memory being taken up by cached documents.
    +static intgetDocumentCacheMaximumSize() + +
    +          Returns the max size of the document cache used by the Manager.
    +static javax.swing.JComponentgetUserComponent(java.lang.String classname, + java.lang.String name) + +
    +          Retrieves a JComponent from the Manager's component cache.
    +static java.awt.ImagegetUserImage(java.lang.String name) + +
    +          Retrieves an Image from the Manager's image cache.
    +static booleanisCacheDocumentsEnabled() + +
    +          Indicates whether document caching is currently enabled.
    +static booleanisCalFocusManagerEnabled() + +
    +          Indicates whether a CalFocusManager is currently enabled.
    +static voidremoveOldestDocumentFromCache() + +
    +          Removes the oldest document from the Manager's document cache.
    +static voidremoveUserComponent(java.lang.String name) + +
    +          Removes a JComponent from the Manager's component cache.
    +static voidremoveUserComponentArray(java.lang.String classname) + +
    +          Removes a JComponent array from the Manager's component cache.
    +static voidremoveUserImage(java.lang.String name) + +
    +          Removes an Image from the Manager's image cache.
    +static voidsetCacheDocuments(boolean enabled) + +
    +          Enables or disables the caching of documents by the Manager.
    +static voidsetCalFocusManagerEnabled(boolean enabled) + +
    +          Enables or disables the CalFocusManager.
    +static voidsetDocumentCacheMaximumSize(int size) + +
    +          Sets the size of the document cache used by the Manager.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
    +  +

    + + + + + + + + + + + + + + +
    +Method Detail
    + +

    +addUserComponent

    +
    +public static void addUserComponent(javax.swing.JComponent component)
    +
    +
    Adds a JComponent to the Manager's component cache. The component can then be incorporated + into an HTML document using the <OBJECT> tag.
    + The component must have an assigned name (set by calling the + AWT Component setName() method). + JComponents sent to this method which do not have a name will not be cached by the Manager.
    +
    Parameters:
    component - the JComponent to be added.
    +
    +
    +
    + +

    +removeUserComponent

    +
    +public static void removeUserComponent(java.lang.String name)
    +
    +
    Removes a JComponent from the Manager's component cache.
    +
    Parameters:
    name - the name of the JComponent to be removed.
    +
    +
    +
    + +

    +addUserComponentArray

    +
    +public static void addUserComponentArray(javax.swing.JComponent[] componentArray,
+                                         java.lang.String classname)
    +
    +
    Adds an array of JComponents to the Manager's component cache. + Individual components from this array can then be incorporated + into an HTML document using the <OBJECT> tag.
    + The component array must have an assigned class name. + Arrays sent to this method which do not have a class name will not be cached by the Manager.
    +
    Parameters:
    componentArray - the JComponent array to be added.
    classname - a class identifier for the JComponent array.
    +
    +
    +
    + +

    +removeUserComponentArray

    +
    +public static void removeUserComponentArray(java.lang.String classname)
    +
    +
    Removes a JComponent array from the Manager's component cache.
    +
    Parameters:
    classname - the class identifier of the JComponent array to be removed.
    +
    +
    +
    + +

    +getUserComponent

    +
    +public static javax.swing.JComponent getUserComponent(java.lang.String classname,
+                                                      java.lang.String name)
    +
    +
    Retrieves a JComponent from the Manager's component cache. If the JComponent was added to + the cache as part of a component array then the class name of the array must be sent to + this method in order to retrieve it.
    +
    Parameters:
    classname - the class identifier of the array the JComponent resides in (may be null).
    name - the name of the target JComponent.
    Returns:
    the requested JComponent or null if no JComponent matching the sent + parameters can be found
    See Also:
    addUserComponent(javax.swing.JComponent), +addUserComponentArray(javax.swing.JComponent[], java.lang.String)
    +
    +
    +
    + +

    +addUserImage

    +
    +public static void addUserImage(java.awt.Image img,
+                                java.lang.String name)
    +
    +
    Adds an Image to the Manager's image cache. The Image can then be incorporated + into an HTML document by naming the image within an <IMG> tag. + Incorporating images into documents via the Manager allows the programmer to ensure + that a fully loaded image is always available. In addition the image will always be + displayed, even if loadImages in CalHTMLPreferences has + been disabled. This can be useful when images are being displayed in buttons and other + form controls. +

    See the README.TXT file accompanying this documentation for further details.

    +
    Parameters:
    img - the Image to be cached.
    name - a name given to the Image for retrieval purposes.
    See Also:
    getUserImage(java.lang.String)
    +
    +
    +
    + +

    +getUserImage

    +
    +public static java.awt.Image getUserImage(java.lang.String name)
    +
    +
    Retrieves an Image from the Manager's image cache.
    +
    Parameters:
    name - the name of the target Image.
    Returns:
    the requested Image or null if no Image matching the sent + name can be found
    See Also:
    addUserImage(java.awt.Image, java.lang.String)
    +
    +
    +
    + +

    +removeUserImage

    +
    +public static void removeUserImage(java.lang.String name)
    +
    +
    Removes an Image from the Manager's image cache.
    +
    Parameters:
    name - the name of the Image to be removed.
    +
    +
    +
    + +

    +setCacheDocuments

    +
    +public static void setCacheDocuments(boolean enabled)
    +
    +
    Enables or disables the caching of documents by the Manager. The default setting + is true (enabled).
    +
    Parameters:
    enabled - a flag indicating whether the Manager should cache documents.
    +
    +
    +
    + +

    +isCacheDocumentsEnabled

    +
    +public static boolean isCacheDocumentsEnabled()
    +
    +
    Indicates whether document caching is currently enabled.
    +
    Returns:
    a flag indicating whether the Manager is currently able to cache documents.
    +
    +
    +
    + +

    +setDocumentCacheMaximumSize

    +
    +public static void setDocumentCacheMaximumSize(int size)
    +
    +
    Sets the size of the document cache used by the Manager. The size value represents Kilobytes + and should be greater than 0. The default value is 8000 (8Mb). Note that this can only be a + guide to the Manager as to how many documents to cache. + It is possible that the cache size figure may be exceeded + due to the difficulty of calculating the memory usage of a fully-parsed HTML document. +

    Once the cache size has been exceeded the Manager will empty the oldest document from the cache + and repeat this process until the memory taken up by documents in the cache falls below the cache size. +

    Documents in the Manager's cache do not contain images. These are cached by the JVM and will take + up additional memory (sometimes far in excess of the memory taken by documents). +

    Note: Kilobytes have been used in order to allow for the creation of very small cache sizes. + A cache size of 50K will be meaningless when dealing with normal HTML documents, but it allows for + the caching of mini 'documents' which have been created via Strings rather than URLs.

    +
    Parameters:
    size - the required size in kilobytes of the Manager's document cache.
    +
    +
    +
    + +

    +getDocumentCacheMaximumSize

    +
    +public static int getDocumentCacheMaximumSize()
    +
    +
    Returns the max size of the document cache used by the Manager.
    +
    Returns:
    the size in kilobytes of the Manager's document cache.
    +
    +
    +
    + +

    +getDocumentCacheCurrentSize

    +
    +public static int getDocumentCacheCurrentSize()
    +
    +
    Returns the Manager's estimate of the current memory being taken up by cached documents. The + return value represents Kilobytes. +

    The estimate does not include memory which is being taken up by cached document + images. These are managed separately by the JVM. Note also that a call to + Runtime.getRuntime().freeMemory() will invariably show a memory usage greater + than indicated by this method. This is due to the additional memory being used by any + CalHTMLPane objects and subsidiary objects related to the current document view + they are displaying.

    +
    Returns:
    an estimate of the current memory (in kilobytes) being used by cached documents.
    +
    +
    +
    + +

    +removeOldestDocumentFromCache

    +
    +public static void removeOldestDocumentFromCache()
    +
    +
    Removes the oldest document from the Manager's document cache.
    +
    + +

    +emptyDocumentCache

    +
    +public static void emptyDocumentCache()
    +
    +
    Empties the Manager's document cache.
    +
    + +

    +setCalFocusManagerEnabled

    +
    +public static void setCalFocusManagerEnabled(boolean enabled)
    +
    +
    Enables or disables the CalFocusManager. When a CalHTMLPane is + first instantiated it will replace the incumbent FocusManager with a + CalFocusManager unless disabled from doing so by this method. + The CalFocusManager should function identically to Swing's + DefaultFocusManager outside a CalHTMLPane but extends functionality when a + CalHTMLPane has keyboard focus (e.g. it enables tabbing between hyperlinks).
    + See the README.TXT file accompanying this documentation for more details on why the + CalFocusManager has been implemented in this way. +

    (Note that this method will neither install nor uninstall the CalFocusManager.)

    +
    Parameters:
    enabled - a flag indicating whether a CalFocusManager should handle keyboard control within + a CalHTMLPane.
    +
    +
    +
    + +

    +isCalFocusManagerEnabled

    +
    +public static boolean isCalFocusManagerEnabled()
    +
    +
    Indicates whether a CalFocusManager is currently enabled.
    +
    Returns:
    a flag indicating whether a CalFocusManager should handle keyboard traversal
    See Also:
    setCalFocusManagerEnabled(boolean)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLObserver.html b/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLObserver.html new file mode 100644 index 0000000..555a3d3 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLObserver.html @@ -0,0 +1,387 @@ + + + + + + +: Interface CalHTMLObserver + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + +

    + +calpa.html +
    +Interface CalHTMLObserver

    +
    +
    All Known Implementing Classes:
    DefaultCalHTMLObserver
    +
    +
    +
    +
    public abstract interface CalHTMLObserver
    + +

    +A class implementing this interface can be passed to a CalHTMLPane at + construction time and will thereafter receive notification of events which have occured within the Pane. + A CalHTMLPane always has one, and only one, attached CalHTMLObserver. +

    If a CalHTMLObserver is not passed to the Pane during construction, a + DefaultCalHTMLObserver + will be used. DefaultCalHTMLObserver implements all the methods of this + interface as null-ops, allowing the programmer to extend the class and only implement + those methods of interest. +

    Note that the same CalHTMLObserver may be used with several + CalHTMLPanes. +

    +

    +
    See Also:
    CalHTMLPane
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidformSubmitUpdate(CalHTMLPane pane, + java.net.URL docBaseURL, + int method, + java.lang.String action, + java.lang.String data) + +
    +          Notification that a form submission has been initiated.
    + voidhistoryUpdate(CalHTMLPane pane, + int position) + +
    +          Notification of a change in position within the Pane's document history.
    + voidlinkActivatedUpdate(CalHTMLPane pane, + java.net.URL url, + java.lang.String targetFrame, + java.lang.String jname) + +
    +          Notification that a hyperlink has been activated via the keyboard or mouse.
    + voidlinkFocusedUpdate(CalHTMLPane pane, + java.net.URL url) + +
    +          Notification that a hyperlink has received or lost keyboard/mouse focus.
    + voidshowNewFrameRequest(CalHTMLPane pane, + java.lang.String targetFrame, + java.net.URL url) + +
    +          Notification for a new CalHTMLPane to be created with + the specified top-level frame name and showing the specified document.
    + voidstatusUpdate(CalHTMLPane pane, + int status, + java.net.URL url, + int value, + java.lang.String message) + +
    +          Gives general notifications of events or errors which are occuring within the Pane.
    +  +

    + + + + + + + + + + + + + + +
    +Method Detail
    + +

    +linkActivatedUpdate

    +
    +public void linkActivatedUpdate(CalHTMLPane pane,
+                                java.net.URL url,
+                                java.lang.String targetFrame,
+                                java.lang.String jname)
    +
    +
    Notification that a hyperlink has been activated via the keyboard or mouse. + If the jname argument is null the link will be automatically followed by the calling Pane, unless + the URL protocol is 'mailto', which the Pane cannot currently handle. + If the jname argument is not null the pane will not attempt to follow the link, allowing + it to be handled here.
    +
    Parameters:
    pane - the CalHTMLPane which has called this method
    url - the URL of the link that has been activated
    targetFrame - the name of the frame where the contents of the URL are + to be displayed
    jname - A name given to the link so it can be handled outside the calling Pane
    +
    +
    +
    + +

    +linkFocusedUpdate

    +
    +public void linkFocusedUpdate(CalHTMLPane pane,
+                              java.net.URL url)
    +
    +
    Notification that a hyperlink has received or lost keyboard/mouse focus. + This method is called when there has been a change in focus. If the URL + sent is not null then a new link has now received focus. + If the URL is null then a link which previously had focus + has now lost it, and no link is currently focused. +

    This method can be used, for example, to update a status display which shows the currently + focused link on the user's screen.

    +
    Parameters:
    pane - the CalHTMLPane which has called this method
    url - the URL of the focused link, or null if no link has the focus
    +
    +
    +
    + +

    +statusUpdate

    +
    +public void statusUpdate(CalHTMLPane pane,
+                         int status,
+                         java.net.URL url,
+                         int value,
+                         java.lang.String message)
    +
    +
    Gives general notifications of events or errors which are occuring within the Pane. Apart from + the DOC_LENGTH status argument listed below, the value argument sent + will be the nesting level of the frame initiating this call. A nesting of 0 indicates the + Pane's top level frame has made the call. Often you will only be interested in calls from the + top level frame. For example, if a frameset document is loading you may get the DOC_LOADED + status call several times, but the one that really counts is the frame 0 call, and this is + never sent until all sub-frames have finished loading. +

    The current status arguments sent to this method are: +

      +
    • CalCons.PRE_CONNECT
      + The Pane is attempting to connect to the given URL to receive data. +
    • CalCons.PARSE_FAILED
      + The Pane was unable to connect to the given URL or was unable to parse the content. + Most likely this will be due to an incorrectly specified URL. + The message argument may contain further details of the reason for failure. +
    • CalCons.CONNECTED
      + The Pane has established a connection to the given URL and is receiving any content. +
    • CalCons.DOC_LENGTH
      + The size of the content at the given URL is known and is contained + in the value argument. +
    • CalCons.TITLE
      + The title of the document for the given URL is known and is contained + in the message argument. Only the title of a document in the Pane's top level frame + will be sent to this method. If the document has no name, the message will be null, unless the + document is a Frameset document in which case the message "Frameset" will be sent. +
    • CalCons.PARSE_FAILED_POST_CONNECT
      + An exception has been thrown during parsing of the data from the URL. This will most + likely be an IOException such as a server time-out. +
    • CalCons.WAITING_FOR_IMAGES
      + The document has been parsed but formatting cannot be completed because the document contains images + of unspecified size. The parsing thread is waiting for image updates to give it the information + it needs to format and display the document. +
    • CalCons.DOC_LOADED
      + All text and image data has been received, parsed and the document structure determined. +
    +
    Parameters:
    pane - the CalHTMLPane which has called this method
    status - the status code of the update
    url - a URL related to the status code
    value - a value related to the status code
    message - a message related to the status code
    +
    +
    +
    + +

    +formSubmitUpdate

    +
    +public void formSubmitUpdate(CalHTMLPane pane,
+                             java.net.URL docBaseURL,
+                             int method,
+                             java.lang.String action,
+                             java.lang.String data)
    +
    +
    Notification that a form submission has been initiated. Whether the Pane handles the + submission directly depends on whether handleFormSubmission is enabled or + disabled by the CalHTMLPreferences object controlling the Pane. +

    The method argument will be either CalCons.V_GET, CalCons.V_POST, or CalCons.V_JFORM
    + If the argument is V_JFORM then the Pane will take no action, irrespective of whether + handleFormSubmission is enabled. This allows the programmer to treat this method as + a pseudo actionListener for controls placed within documents. +

    The data argument sent to this method is an x-www-form-urlencoded concatenated string of the + form results gathered from successful form controls.

    +
    Parameters:
    pane - the CalHTMLPane which has called this method
    docBaseURL - the URL of the document containing the form, possibly modified + by the <BASE> tag
    method - a code for the form method - GET, POST or JFORM
    action - the value of the action attribute (if any) specified in the FORM tag
    data - the concatenated, encoded form results
    See Also:
    CalHTMLPreferences.setHandleFormSubmission(boolean)
    +
    +
    +
    + +

    +historyUpdate

    +
    +public void historyUpdate(CalHTMLPane pane,
+                          int position)
    +
    +
    Notification of a change in position within the Pane's document history. + This method's primary purpose is to allow the programmer to enable/disable controls which + navigate the Pane's history. Note that it is possible for the Pane to be simultaneously at the + top and bottom of its history (when the Pane has only shown a single document for example). + It's easiest to show how you might use this method with some simple pseudo-code: +
    + if (position == CalCons.AT_HISTORY_MIDDLE) {
    +     //...enable both the 'back' and 'forward' buttons
    + } else {
    +     if ((position & CalCons.AT_HISTORY_TOP) > 0) {
    +         //...disable the 'forward' button
    +     } else {
    +         //...enable the 'forward' button
    +     }
    +     if ((position & CalCons.AT_HISTORY_BOTTOM) > 0) {
    +         //...disable the 'back' button
    +     } else {
    +         //...enable the 'back' button
    +     }
    + } +
    +
    Parameters:
    pane - the CalHTMLPane which has called this method
    position - a value denoting the current position within the Pane's history
    +
    +
    +
    + +

    +showNewFrameRequest

    +
    +public void showNewFrameRequest(CalHTMLPane pane,
+                                java.lang.String targetFrame,
+                                java.net.URL url)
    +
    +
    Notification for a new CalHTMLPane to be created with + the specified top-level frame name and showing the specified document.
    +

    This method will be only be called if handleNewFrames is disabled in the + CalHTMLPreferences object controlling the Pane. The need for a new frame + occurs when an HTML anchor or other tag specifies that a URL should be displayed in a + frame which has a name unknown to the Pane, or when the reserved HTML name "_blank" is + specified.

    +
    Parameters:
    pane - the CalHTMLPane which has called this method
    targetFrame - the name to be given to the top-level frame of the new Pane, + or null if no name has been specified
    url - the URL of the document to be displayed in the new Pane
    See Also:
    CalHTMLPreferences.setHandleNewFrames(boolean)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLPane.html b/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLPane.html new file mode 100644 index 0000000..6a24077 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLPane.html @@ -0,0 +1,1190 @@ + + + + + + +: Class CalHTMLPane + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + +

    + +calpa.html +
    +Class CalHTMLPane

    +
    +java.lang.Object
+  |
+  +--java.awt.Component
+        |
+        +--java.awt.Container
+              |
+              +--javax.swing.JComponent
+                    |
+                    +--javax.swing.JLayeredPane
+                          |
+                          +--calpa.html.CalHTMLPane
+
    +
    +
    +
    public class CalHTMLPane
    extends javax.swing.JLayeredPane
    implements calpa.html.CalCons, java.awt.event.KeyListener
    + +

    +A component class which has the capacity to display HTML-formatted content. + The default rendering style of the Pane and other aspects of its operation + are controlled by a CalHTMLPreferences object. The Pane + communicates internal events (e.g. a selected hyperlink) to a + CalHTMLObserver object so that futher processing of such events + can be handled by the programmer. +

    Documents are displayed in the JLayeredPane.DEFAULT_LAYER.
    + The Pane's dialog (if used) is displayed in the JLayeredPane.MODAL_LAYER.
    + The Pane's test navigation bar (if used) is displayed in the JLayeredPane.PALETTE_LAYER. +

    See the README.TXT file accompanying this document for further details on how to use + this class. +

    +

    +
    See Also:
    CalHTMLPreferences, +CalHTMLObserver, Serialized Form
    +
    + +

    + + + + + + + + + + +
    Inner classes inherited from class javax.swing.JLayeredPane
    javax.swing.JLayeredPane.AccessibleJLayeredPane
    +  + + + + + + + +
    Inner classes inherited from class javax.swing.JComponent
    javax.swing.JComponent.AccessibleJComponent
    +  + + + + + + + + + + +
    Fields inherited from class javax.swing.JLayeredPane
    DEFAULT_LAYER, +DRAG_LAYER, +FRAME_CONTENT_LAYER, +LAYER_PROPERTY, +MODAL_LAYER, +PALETTE_LAYER, +POPUP_LAYER
    +  + + + + + + + +
    Fields inherited from class javax.swing.JComponent
    accessibleContext, +listenerList, +TOOL_TIP_TEXT_KEY, +ui, +UNDEFINED_CONDITION, +WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, +WHEN_FOCUSED, +WHEN_IN_FOCUSED_WINDOW
    +  + + + + + + + +
    Fields inherited from class java.awt.Component
    BOTTOM_ALIGNMENT, +CENTER_ALIGNMENT, +LEFT_ALIGNMENT, +RIGHT_ALIGNMENT, +TOP_ALIGNMENT
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    CalHTMLPane() + +
    +          Constructs a CalHTMLPane with default CalHTMLPreferences, + a default CalHTMLObserver and default top-level frame name.
    CalHTMLPane(CalHTMLPreferences prefs, + CalHTMLObserver obs, + java.lang.String name) + +
    +          Constucts a CalHTMLPane with the specified CalHTMLObserver, + CalHTMLPreferences and top-level frame name.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcloseDialog() + +
    +          Closes the Pane's dialog if it is currently visible.
    + java.util.HashtablegetIDComponents(java.lang.String targetFrame) + +
    +          Returns a Hashtable containing all components in the target frame which have the HTML 'id' attribute.
    + voidgoBack() + +
    +          Show the previous document in the Pane's history list.
    + voidgoForward() + +
    +          Show the next document in the Pane's history list.
    + voidgoHome() + +
    +          Show the contents of the URL specified as homeURL + by CalHTMLPreferences in the top level frame of the Pane.
    + booleanisFocusTraversable() + +
    +          Overrides JComponent isFocusTraversable().
    + booleanisLoadSynchronouslyEnabled() + +
    +          Returns whether documents will be loaded by the CalPane synchronously or asynchronously.
    + booleanisManagingFocus() + +
    +          Overrides JComponent isManagingFocus().
    + voidkeyPressed(java.awt.event.KeyEvent e) + +
    +          Public due to implementation requirements.
    + voidkeyReleased(java.awt.event.KeyEvent e) + +
    +          Public due to implementation requirements.
    + voidkeyTyped(java.awt.event.KeyEvent e) + +
    +          Public due to implementation requirements.
    + voidreloadDocument() + +
    +          Reloads the current document.
    + voidscrollToReference(java.lang.String ref, + java.lang.String targetFrame) + +
    +          Scrolls the document view to the specified anchor reference in the named target frame.
    + voidsetBounds(int x, + int y, + int w, + int h) + +
    +          Public due to inheritance.
    + voidsetLoadSynchronously(boolean b) + +
    +          Enables/disables the synchronous loading of documents.
    + booleansetScrollBarPolicy(int n) + +
    +          Sets the scrollbar policy of the Pane.
    + voidshowDialog(java.lang.String message) + +
    +          Parses the sent message as HTML and displays the result in the Pane's dialog.
    + voidshowDialog(java.lang.String message, + java.lang.String messageName, + int x, + int y, + int w, + int h) + +
    +          Parses the sent message as HTML and displays the result in the Pane's dialog.
    + voidshowHTMLDocument(java.lang.String s) + +
    +          Formats and displays the specified String as an HTML document in the top level frame of the Pane.
    + voidshowHTMLDocument(java.lang.String s, + java.lang.String targetFrame) + +
    +          Formats and displays the specified String as an HTML document in the named + target frame.
    + voidshowHTMLDocument(java.net.URL url) + +
    +          Shows the contents of the specified URL in the top level frame of + the Pane.
    + voidshowHTMLDocument(java.net.URL url, + java.lang.String targetFrame, + boolean reload) + +
    +          Shows the contents of the specified URL in the named + target frame.
    + voidstopAll() + +
    +          Stops all processes within the Pane.
    +  + + + + + + + +
    Methods inherited from class javax.swing.JLayeredPane
    addImpl, +getAccessibleContext, +getComponentCountInLayer, +getComponentsInLayer, +getComponentToLayer, +getIndexOf, +getLayer, +getLayer, +getLayeredPaneAbove, +getObjectForLayer, +getPosition, +highestLayer, +insertIndexForLayer, +isOptimizedDrawingEnabled, +lowestLayer, +moveToBack, +moveToFront, +paint, +paramString, +putLayer, +remove, +setLayer, +setLayer, +setPosition
    +  + + + + + + + +
    Methods inherited from class javax.swing.JComponent
    addAncestorListener, +addNotify, +addPropertyChangeListener, +addVetoableChangeListener, +computeVisibleRect, +contains, +createToolTip, +firePropertyChange, +firePropertyChange, +firePropertyChange, +firePropertyChange, +firePropertyChange, +firePropertyChange, +firePropertyChange, +firePropertyChange, +firePropertyChange, +fireVetoableChange, +getActionForKeyStroke, +getAlignmentX, +getAlignmentY, +getAutoscrolls, +getBorder, +getBounds, +getClientProperty, +getComponentGraphics, +getConditionForKeyStroke, +getDebugGraphicsOptions, +getGraphics, +getHeight, +getInsets, +getInsets, +getLocation, +getMaximumSize, +getMinimumSize, +getNextFocusableComponent, +getPreferredSize, +getRegisteredKeyStrokes, +getRootPane, +getSize, +getToolTipLocation, +getToolTipText, +getToolTipText, +getTopLevelAncestor, +getUIClassID, +getVisibleRect, +getWidth, +getX, +getY, +grabFocus, +hasFocus, +isDoubleBuffered, +isFocusCycleRoot, +isLightweightComponent, +isOpaque, +isPaintingTile, +isRequestFocusEnabled, +isValidateRoot, +paintBorder, +paintChildren, +paintComponent, +paintImmediately, +paintImmediately, +processComponentKeyEvent, +processFocusEvent, +processKeyEvent, +processMouseMotionEvent, +putClientProperty, +registerKeyboardAction, +registerKeyboardAction, +removeAncestorListener, +removeNotify, +removePropertyChangeListener, +removeVetoableChangeListener, +repaint, +repaint, +requestDefaultFocus, +requestFocus, +resetKeyboardActions, +reshape, +revalidate, +scrollRectToVisible, +setAlignmentX, +setAlignmentY, +setAutoscrolls, +setBackground, +setBorder, +setDebugGraphicsOptions, +setDoubleBuffered, +setEnabled, +setFont, +setForeground, +setMaximumSize, +setMinimumSize, +setNextFocusableComponent, +setOpaque, +setPreferredSize, +setRequestFocusEnabled, +setToolTipText, +setUI, +setVisible, +unregisterKeyboardAction, +update, +updateUI
    +  + + + + + + + +
    Methods inherited from class java.awt.Container
    add, +add, +add, +add, +add, +addContainerListener, +countComponents, +deliverEvent, +doLayout, +findComponentAt, +findComponentAt, +getComponent, +getComponentAt, +getComponentAt, +getComponentCount, +getComponents, +getLayout, +insets, +invalidate, +isAncestorOf, +layout, +list, +list, +locate, +minimumSize, +paintComponents, +preferredSize, +print, +printComponents, +processContainerEvent, +processEvent, +remove, +removeAll, +removeContainerListener, +setLayout, +validate, +validateTree
    +  + + + + + + + +
    Methods inherited from class java.awt.Component
    action, +add, +addComponentListener, +addFocusListener, +addInputMethodListener, +addKeyListener, +addMouseListener, +addMouseMotionListener, +addPropertyChangeListener, +bounds, +checkImage, +checkImage, +coalesceEvents, +contains, +createImage, +createImage, +disable, +disableEvents, +dispatchEvent, +enable, +enable, +enableEvents, +enableInputMethods, +getBackground, +getBounds, +getColorModel, +getComponentOrientation, +getCursor, +getDropTarget, +getFont, +getFontMetrics, +getForeground, +getInputContext, +getInputMethodRequests, +getLocale, +getLocation, +getLocationOnScreen, +getName, +getParent, +getPeer, +getSize, +getToolkit, +getTreeLock, +gotFocus, +handleEvent, +hide, +imageUpdate, +inside, +isDisplayable, +isEnabled, +isLightweight, +isShowing, +isValid, +isVisible, +keyDown, +keyUp, +list, +list, +list, +location, +lostFocus, +mouseDown, +mouseDrag, +mouseEnter, +mouseExit, +mouseMove, +mouseUp, +move, +nextFocus, +paintAll, +postEvent, +prepareImage, +prepareImage, +printAll, +processComponentEvent, +processInputMethodEvent, +processMouseEvent, +remove, +removeComponentListener, +removeFocusListener, +removeInputMethodListener, +removeKeyListener, +removeMouseListener, +removeMouseMotionListener, +removePropertyChangeListener, +repaint, +repaint, +repaint, +resize, +resize, +setBounds, +setComponentOrientation, +setCursor, +setDropTarget, +setLocale, +setLocation, +setLocation, +setName, +setSize, +setSize, +show, +show, +size, +toString, +transferFocus
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +wait, +wait, +wait
    +  +

    + + + + + + + + + + + +
    +Constructor Detail
    + +

    +CalHTMLPane

    +
    +public CalHTMLPane()
    +
    +
    Constructs a CalHTMLPane with default CalHTMLPreferences, + a default CalHTMLObserver and default top-level frame name.
    +
    + +

    +CalHTMLPane

    +
    +public CalHTMLPane(CalHTMLPreferences prefs,
+                   CalHTMLObserver obs,
+                   java.lang.String name)
    +
    +
    Constucts a CalHTMLPane with the specified CalHTMLObserver, + CalHTMLPreferences and top-level frame name. If any of the arguments are + null then a default will be used.
    +
    Parameters:
    prefs - the CalHTMLPreferences which determines the Pane's behaviour.
    obs - the CalHTMLObserver that will receive updates from the Pane.
    name - the name of the Pane's top-level frame.
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setBounds

    +
    +public void setBounds(int x,
+                      int y,
+                      int w,
+                      int h)
    +
    +
    Public due to inheritance. Call super.setBounds(x, y, w, h) if you override + this method or the Pane may not function correctly.
    +
    Overrides:
    setBounds in class java.awt.Component
    +
    +
    +
    + +

    +showHTMLDocument

    +
    +public void showHTMLDocument(java.net.URL url)
    +
    +
    Shows the contents of the specified URL in the top level frame of + the Pane. A cached document will be used if one is available and caching is enabled.
    +
    Parameters:
    url - the URL of the document to be displayed.
    +
    +
    +
    + +

    +showHTMLDocument

    +
    +public void showHTMLDocument(java.net.URL url,
+                             java.lang.String targetFrame,
+                             boolean reload)
    +
    +
    Shows the contents of the specified URL in the named + target frame. If the target frame is null the document will be displayed in the top level + frame of the Pane. If the target frame is not a currently recognised frame: +
    • if handleNewFrames is enabled in the + CalHTMLPreferences controlling the Pane then a new CalHTMLPane + will be created to show the document. +
    • if handleNewFrames is not enabled + then a showNewFrameRequest will be sent to the Pane's resident + CalHTMLObserver. +
    +

    If reload is false a cached document will be used if one is + available and caching is enabled. Otherwise the document will be reloaded from the + specified URL.

    +
    Parameters:
    url - the URL of the document to be displayed.
    targetFrame - the HTML frame that the document should be displayed in.
    reload - if true forces the document to be reloaded even if a cached + version is available.
    +
    +
    +
    + +

    +showHTMLDocument

    +
    +public void showHTMLDocument(java.lang.String s)
    +
    +
    Formats and displays the specified String as an HTML document in the top level frame of the Pane.
    +
    Parameters:
    s - a String to be formatted as an HTML document.
    +
    +
    +
    + +

    +showHTMLDocument

    +
    +public void showHTMLDocument(java.lang.String s,
+                             java.lang.String targetFrame)
    +
    +
    Formats and displays the specified String as an HTML document in the named + target frame. If the target frame is null the document will be displayed in the top level + frame of the Pane. If the target frame is not a currently recognised frame: +
    • if handleNewFrames is enabled in the + CalHTMLPreferences controlling the Pane then a new CalHTMLPane + will be created to show the document. +
    • if handleNewFrames is not enabled + then a showNewFrameRequest will be sent to the Pane's resident + CalHTMLObserver. +
    +
    Parameters:
    s - a String to be formatted as an HTML document.
    targetFrame - the HTML frame that the document should be displayed in.
    +
    +
    +
    + +

    +scrollToReference

    +
    +public void scrollToReference(java.lang.String ref,
+                              java.lang.String targetFrame)
    +
    +
    Scrolls the document view to the specified anchor reference in the named target frame. + If the targetFrame argument is null then the reference will be + looked for in the document in the CalPane's top level frame. +

    This method has been incorporated to assist programmers who are displaying HTML Strings + and who wish to navigate to internal links in their String HTML documents. For example, if + there is an anchor in your String such as: <A name="contactinfo"> then you can call + this method with scrollToReference("contactinfo", null). +

    Note that you will need to ensure that the String document has been parsed/loaded before + attempting to navigate to anchors within it. Calling showHTMLDocument(String s) + and then immediately calling this method may fail because the String is still being asynchronously + parsed and the reference has not been encountered. You can use the CalHTMLObserver + class to determine when the String has been fully parsed, or you could set the CalPane's + loading policy to synchronous loading. +

    Programmers using URL documents need not use this method. They can create a new URL which + incorporates the anchor reference and call showHTMLDocument(URL) instead, which has + the advantage that no check need be made to see if the document has loaded - the CalPane will + automatically navigate to the anchor as soon as it is available.

    +
    Parameters:
    ref - a named anchor reference within a document.
    targetFrame - the HTML frame that contains the document with the anchor reference.
    +
    +
    +
    + +

    +goBack

    +
    +public void goBack()
    +
    +
    Show the previous document in the Pane's history list. If the Pane is already + at the bottom of its history then the call will be ignored.
    +
    +
    +
    +
    + +

    +goForward

    +
    +public void goForward()
    +
    +
    Show the next document in the Pane's history list. If the Pane is already + at the top of its history then the call will be ignored.
    +
    +
    +
    +
    + +

    +goHome

    +
    +public void goHome()
    +
    +
    Show the contents of the URL specified as homeURL + by CalHTMLPreferences in the top level frame of the Pane.
    +
    +
    +
    +
    + +

    +reloadDocument

    +
    +public void reloadDocument()
    +
    +
    Reloads the current document.
    +
    +
    +
    +
    + +

    +stopAll

    +
    +public void stopAll()
    +
    +
    Stops all processes within the Pane. In most cases cancellation of any current document loading will + be immediate. However, this call has a slightly different effect on a thread that is currently waiting + for image data, for this reason: +
    Some document authors do not specify widths and heights for images in their documents. + This presents a problem when parsing/loading. A temporary default image size could be used so that + the document could be displayed 'on the fly', but this means reformatting the whole document once the + true image size becomes available. This can considerably lengthen parsing time and is disconcerting + for the document reader. The alternative is to delay the display of the document until all image sizes + are known. +

    The latter policy is followed by the CalHTMLPane. On occasions however the image data fails + to arrive, and the parsing thread then becomes 'locked' as it waits for this data, even though the + rest of the document has been parsed and is ready to be formatted. + When this method is called (usually by the user pressing a 'STOP' button) a thread which is looping + in this way will be freed and document parsing will continue, with default sizes being used for + images with incomplete data.

    +
    +
    +
    +
    + +

    +setScrollBarPolicy

    +
    +public boolean setScrollBarPolicy(int n)
    +
    +
    Sets the scrollbar policy of the Pane. + The arguments which can be sent to this method are:

    +

    • CalCons.VIEWER (The default setting)
      +     Equivalent to ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS, + ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
      +
    • CalCons.V_YES
      +     Equivalent to ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS, + ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS
      +
    • CalCons.V_NO
      +     Equivalent to ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER, + ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER
      +
    • CalCons.V_AUTO
      +     Equivalent to ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED, + ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
      +
    +

    Note that unless scrolling policy is set to V_NO, documents will always be formatted + on the assumption that a vertical scrollbar is present, even if one is not currently visible. + This is due to the asynchronous loading of documents. When a Pane loads a document it cannot 'know' + whether or not a vertical scrollbar is going to be required, and adjusting for the sudden appearance + of one would necessitate a reformat of the whole document.

    +
    Parameters:
    n - a value which dictates the scrollbar policy for the Pane.
    Returns:
    true if a supported scrollbar policy was sent to this method
    +
    +
    +
    + +

    +isManagingFocus

    +
    +public boolean isManagingFocus()
    +
    +
    Overrides JComponent isManagingFocus(). Programmers are advised not to + override this method.
    +
    Overrides:
    isManagingFocus in class javax.swing.JComponent
    +
    +
    +
    + +

    +isFocusTraversable

    +
    +public boolean isFocusTraversable()
    +
    +
    Overrides JComponent isFocusTraversable(). Programmers are advised not to + override this method.
    +
    Overrides:
    isFocusTraversable in class javax.swing.JComponent
    +
    +
    +
    + +

    +keyPressed

    +
    +public void keyPressed(java.awt.event.KeyEvent e)
    +
    +
    Public due to implementation requirements. Programmers are advised not to + override this method.
    +
    Specified by:
    keyPressed in interface java.awt.event.KeyListener
    +
    +
    +
    + +

    +keyReleased

    +
    +public void keyReleased(java.awt.event.KeyEvent e)
    +
    +
    Public due to implementation requirements. Programmers are advised not to + override this method.
    +
    Specified by:
    keyReleased in interface java.awt.event.KeyListener
    +
    +
    +
    + +

    +keyTyped

    +
    +public void keyTyped(java.awt.event.KeyEvent e)
    +
    +
    Public due to implementation requirements. Programmers are advised not to + override this method.
    +
    Specified by:
    keyTyped in interface java.awt.event.KeyListener
    +
    +
    +
    + +

    +showDialog

    +
    +public void showDialog(java.lang.String message)
    +
    +
    Parses the sent message as HTML and displays the result in the Pane's dialog. See the + README.TXT file accompanying this documentation for more details regarding the Pane's dialog.
    +
    Parameters:
    message - a String to be formatted as HTML in the Pane's dialog.
    +
    +
    +
    + +

    +showDialog

    +
    +public void showDialog(java.lang.String message,
+                       java.lang.String messageName,
+                       int x,
+                       int y,
+                       int w,
+                       int h)
    +
    +
    Parses the sent message as HTML and displays the result in the Pane's dialog.
    + If a messageName is given the Pane will attempt to use a cached version of the message + which has already been parsed under the same name. The message sent to this method may be + null if the messageName is not null; +

    If x >= 0 the Pane will use this value as a guide to the left-horizontal coordinate + for setting the dialog's bounds. +
    If y >= 0 the Pane will use this value as a guide to the top-vertical coordinate + for setting the dialog's bounds. +
    If w > 0 the Pane will use this value as a guide to the width of the dialog. +
    If h > 0 the Pane will use this value as a guide to the height of the dialog. +

    The Pane will honour any sent bounds values where it can, but it will always try and ensure that + the dialog is fully visible and that the dialog's contents fit properly within its bounds. +

    See the README.TXT file accompanying this documentation for more + details on programming the Pane's dialog.

    +
    Parameters:
    message - a String to be formatted as HTML in the Pane's dialog.
    messageName - a name given to the message for caching purposes.
    x - the left-horizontal coordinate of the dialog's bounds.
    y - the top-vertical coordinate of the dialog's bounds.
    w - the width of the dialog.
    h - the height of the dialog.
    +
    +
    +
    + +

    +closeDialog

    +
    +public void closeDialog()
    +
    +
    Closes the Pane's dialog if it is currently visible. Any current parsing of a dialog message + will be halted. If the dialog is not visible this method call is ignored.
    +
    +
    +
    +
    + +

    +getIDComponents

    +
    +public java.util.Hashtable getIDComponents(java.lang.String targetFrame)
    +
    +
    Returns a Hashtable containing all components in the target frame which have the HTML 'id' attribute. + If the target frame is null then all id components within the CalPane are returned. +

    + An example component would be one created with the following HTML: +

    +    <INPUT type=text name=username id=username> +

    + The keys in the Hashtable are the id values of the components. + This method allows programmers to get handles to HTML components after they have been created, + either to monitor/manipulate their state or, for example, to programmatically fire a form submission. +

    Note that programmers should ensure that a document has finished loading before trying to access + any components within it, otherwise this method may return before the components have been created.

    +
    Parameters:
    targetFrame - the name of the frame containing the components, or all frames if null
    Returns:
    a Hashtable of components, with their HTML 'id' values as keys
    +
    +
    +
    + +

    +setLoadSynchronously

    +
    +public void setLoadSynchronously(boolean b)
    +
    +
    Enables/disables the synchronous loading of documents. + If loadSynchronously is enabled then showHTMLDocument() methods + will not return until a document has loaded. In addition documents + loading from activated hyperlinks will also load synchronously. +

    + Loading synchronously effectively blocks the current AWT thread + which will reduce the responsiveness of the CalHTMLPane (and will freeze the rest of + your application), but it can be useful + for programmers who want to be sure that a document has loaded before proceeding with another + operation. Generally it is better to use the callback methods in CalHTMLObserver + to determine when a document has finished loading. +

    The default policy is to load documents asynchronously.

    +
    +
    +
    +
    + +

    +isLoadSynchronouslyEnabled

    +
    +public boolean isLoadSynchronouslyEnabled()
    +
    +
    Returns whether documents will be loaded by the CalPane synchronously or asynchronously.
    +
    Returns:
    true if documents will load synchronously.
    See Also:
    setLoadSynchronously(boolean)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLPreferences.html b/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLPreferences.html new file mode 100644 index 0000000..f9072f5 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/calpa/html/CalHTMLPreferences.html @@ -0,0 +1,1319 @@ + + + + + + +: Class CalHTMLPreferences + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + +

    + +calpa.html +
    +Class CalHTMLPreferences

    +
    +java.lang.Object
+  |
+  +--calpa.html.CalHTMLPreferences
+
    +
    +
    +
    public class CalHTMLPreferences
    extends java.lang.Object
    implements calpa.html.CalCons
    + +

    +A class used to control the default operation and rendering methods + of a CalHTMLPane. The same CalHTMLPreferences + object can be used with multiple panes. During construction all fields of + the preferences object are set to default values. Individual fields + can then be modified through the access methods listed.

    Certain methods + can only modify fields before the preferences object has been passed to + a CalHTMLPane. Calling such methods after this point will not + throw an exception - the calls are simply ignored. +

    +

    +
    See Also:
    CalHTMLPane
    +
    + +

    + + + + + + + + + + + + + + + + +
    +Constructor Summary
    CalHTMLPreferences() + +
    +          Creates a new CalHTMLPreferences object which will have all fields + set to default values.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.awt.FontgetDefaultButtonFont(int displaySize) + +
    +          Returns a default font being used within THREEDEE and FLUSH + Buttons and ComboBoxes.
    + java.awt.ColorgetDefaultColor(int attributeType) + +
    +          Returns a default color used by a CalHTMLPane to render documents.
    + java.awt.FontgetDefaultFont(int displaySize) + +
    +          Returns a default font being used by a CalHTMLPane
    + java.awt.FontgetDefaultFormTextFont(int displaySize) + +
    +          Returns a default font being used within THREEDEE and FLUSH + Textfields, TextAreas and Lists.
    + intgetDefaultFrameSpacing() + +
    +          Returns the default spacing in pixels between frames within a Frameset document.
    + intgetDefaultMarginheight() + +
    +          Returns the default vertical margin of a document.
    + intgetDefaultMarginwidth() + +
    +          Returns the default horizontal margin of a document.
    + intgetFormRenderingStyle() + +
    +          Returns the default rendering style of FORM components within a + CalHTMLPane.
    + intgetFrameDisplayWidth(int displaySize) + +
    +          Returns the width for the specified displaySize at which point a CalHTMLPane will + start scaling its display if optimizeDisplay is enabled.
    + java.net.URLgetHomeURL() + +
    +          Returns the URL which will accessed if a CalHTMLPane's + goHome() method is called
    + intgetOptimizeDisplay() + +
    +          Returns whether a CalHTMLPane will + adjust display parameters based on frame size.
    + java.util.HashtablegetVisitedHash() + +
    +          Returns a Hashtable containing references to visited URLs.
    + booleanisAutomaticallyFollowHyperlinksEnabled() + +
    +          Returns whether a CalHTMLPane will automatically navigate activated hyperlinks.
    + booleanisDisplayErrorDialogsEnabled() + +
    +          Returns whether a CalHTMLPane will automatically display a dialog when + errors such as failed hyperlinks occur.
    + booleanisHandleFormSubmissionEnabled() + +
    +          Returns whether a CalHTMLPane will + automatically handle GET and POST form submissions.
    + booleanisHandleNewFramesEnabled() + +
    +          Returns whether a new CalHTMLPane will + automatically be created if specified by an HTML tag.
    + booleanisLoadImagesEnabled() + +
    +          Returns whether a CalHTMLPane will + automatically load images within documents.
    + booleanisRequestFocusOnMouseClickEnabled() + +
    +          Returns whether a CalHTMLPane will request keyboard focus if the mouse is + clicked within it.
    + booleanisShowHyperlinkOnMouseFocusEnabled() + +
    +          Returns whether a CalHTMLPane will only show a hyperlink when the link has mouse focus.
    + booleanisShowTestNavBarEnabled() + +
    +          Returns whether a CalHTMLPane will display a diagnostic navigation bar on startup.
    + booleanisShowWarningBeforePostEnabled() + +
    +          Returns whether a CalHTMLPane will show a warning to the user before a form POST + submission is made.
    + booleanisUnderlineLinksEnabled() + +
    +          Returns whether a CalHTMLPane will underline hyperlinks.
    + voidsetAutomaticallyFollowHyperlinks(boolean b) + +
    +          Enables/disables the automatic navigation of activated hyperlinks in a CalHTMLPane.
    + voidsetDefaultButtonFont(int displaySize, + java.awt.Font font) + +
    +          Sets a default font to be used within form Buttons and ComboBoxes.
    + voidsetDefaultColor(int attributeType, + java.awt.Color c) + +
    +          Sets a default color.
    + voidsetDefaultFont(int displaySize, + java.awt.Font font) + +
    +          Sets a default font to be used by a CalHTMLPane.
    + voidsetDefaultFont(int displaySize, + int fontFamily, + int sizeIndex) + +
    +          Deprecated. Use setDefaultFont(int, Font) which allows the setting of + system fonts.
    + voidsetDefaultFormTextFont(int displaySize, + java.awt.Font font) + +
    +          Sets a default font to be used within form TextFields, TextAreas and Lists.
    + voidsetDefaultFrameSpacing(int n) + +
    +          Sets the default spacing in pixels between frames within a Frameset document.
    + voidsetDefaultMarginheight(int n) + +
    +          Sets the default vertical margin of a document.
    + voidsetDefaultMarginwidth(int n) + +
    +          Sets the default horizontal margin of a document.
    + voidsetDisplayErrorDialogs(boolean b) + +
    +          Enables/disables the automatic display of error dialogs within a CalHTMLPane.
    + voidsetFormFont(int displaySize, + int fontFamily, + int fontStyle, + int sizeArrayIndex) + +
    +          Deprecated. Use either setDefaultButtonFont(int, Font) or + setDefaultFormTextFont(int, Font).
    + voidsetFormRenderingStyle(int style) + +
    +          Sets the rendering style of FORM components within a CalHTMLPane.
    + voidsetFrameDisplayWidth(int displaySize, + int width) + +
    +          Sets the width for the specified displaySize at which point a CalHTMLPane will + start scaling its display if optimizeDisplay is enabled.
    + voidsetHandleFormSubmission(boolean b) + +
    +          Enables/disables the automatic processing of GET and POST html forms + within a CalHTMLPane.
    + voidsetHandleNewFrames(boolean b) + +
    +          Enables/disables the automatic creation of a new CalHTMLPane if + specified by an HTML tag.
    + voidsetHomeURL(java.net.URL url) + +
    +          Sets the URL which will be accessed if a CalHTMLPane's + goHome() method is called.
    + voidsetLoadImages(boolean b) + +
    +          Enables/disables the automatic loading of images within a CalHTMLPane.
    + voidsetOptimizeDisplay(int optimizeLevel) + +
    +          Determines whether a CalHTMLPane will + adjust display parameters based on frame width.
    + voidsetRequestFocusOnMouseClick(boolean b) + +
    +          Determines whether a CalHTMLPane or one of its subframes will request keyboard focus + if the mouse is clicked within it.
    + voidsetShowHyperlinkOnMouseFocus(boolean b) + +
    +          Determines whether a hyperlink will only be marked as such when it has mouse focus.
    + voidsetShowTestNavBar(boolean b) + +
    +          Enables/disables the display of a diagnostic navigation bar.
    + voidsetShowWarningBeforePost(boolean b) + +
    +          Enables/disables the showing of a warning message before a form POST submission + is made.
    + voidsetUnderlineLinks(boolean b) + +
    +          Enables/disables the underlining of hyperlinks within a CalHTMLPane.
    + voidsetVisitedHash(java.util.Hashtable table) + +
    +          Sets the Hashtable containing references to URLs which + will be used by a CalHTMLPane to mark visited + hyperlinks.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
    +  +

    + + + + + + + + + + + +
    +Constructor Detail
    + +

    +CalHTMLPreferences

    +
    +public CalHTMLPreferences()
    +
    +
    Creates a new CalHTMLPreferences object which will have all fields + set to default values.
    + + + + + + + + +
    +Method Detail
    + +

    +getVisitedHash

    +
    +public java.util.Hashtable getVisitedHash()
    +
    +
    Returns a Hashtable containing references to visited URLs. + This hashtable can be passed into a new CalHTMLPreferences object + at a later date so that a user's visited links are persistent. The + method of storing the hashtable's contents outside of this class + is left to the programmer. +

    The keys within the hashtable are all Integer objects, + each representing a hashcode of a visited URL (note that this is + not the hashcode returned from the URL.hashcode() method). +
    The values within the hashtable are all Long objects + representing the System.currentTimeMillis() when the + link was last visited. The programmer may therefore remove 'old' + links if so desired.

    +
    Returns:
    a Hashtable recording visited document URLs
    See Also:
    setVisitedHash(java.util.Hashtable)
    +
    +
    +
    + +

    +setVisitedHash

    +
    +public void setVisitedHash(java.util.Hashtable table)
    +
    +
    Sets the Hashtable containing references to URLs which + will be used by a CalHTMLPane to mark visited + hyperlinks. Only pass in a hashtable which was previously + obtained from a CalHTMLPreferences object via the + getVisitedHash() method.
    +
    Parameters:
    table - a Hashtable containing Integer/Long pairs representing visited document URLs
    See Also:
    getVisitedHash()
    +
    +
    +
    + +

    +setOptimizeDisplay

    +
    +public void setOptimizeDisplay(int optimizeLevel)
    +
    +
    Determines whether a CalHTMLPane will + adjust display parameters based on frame width. + The arguments which can be sent to this method are:

    +

      +
    • CalCons.NO_OPTIMIZATION
      + No adjustments will be made for frame width. This is the default value. +
    • CalCons.OPTIMIZE_FONTS
      + Font size may be scaled based on frame width. +
    • CalCons.OPTIMIZE_ALL
      + In addition to font scaling, other parameters such as table cellspacing + and cellpadding may be adjusted in an attempt to fit the document into the current frame. +
    +

    See the README.TXT file accompanying this document for more details on optimizeDisplay.

    +
    Parameters:
    optimizeLevel - a value indicating the level (if any) of display optimization required
    See Also:
    setFrameDisplayWidth(int, int), +setDefaultFont(int, int, int)
    +
    +
    +
    + +

    +getOptimizeDisplay

    +
    +public int getOptimizeDisplay()
    +
    +
    Returns whether a CalHTMLPane will + adjust display parameters based on frame size. +

    See the README.TXT file accompanying this document for more details on optimizeDisplay.

    +
    Returns:
    a value indicating the current level of display optimization
    +
    +
    +
    + +

    +setFrameDisplayWidth

    +
    +public void setFrameDisplayWidth(int displaySize,
+                                 int width)
    +
    +
    Sets the width for the specified displaySize at which point a CalHTMLPane will + start scaling its display if optimizeDisplay is enabled. + The permitted displaySize arguments are:

    +

    • CalCons.S_SMALL
    • CalCons.S_MEDIUM
    +

    There is no need to set a width for displaySize CalCons.S_LARGE as a + CalHTMLPane will treat any width greater than the CalCons.S_MEDIUM + width as a large display. +

    Default values are: S_SMALL: 250 pixels, S_MEDIUM: 400 pixels +

    See the README.TXT file accompanying this document for more details on optimizeDisplay.

    +
    +
    +
    +
    + +

    +getFrameDisplayWidth

    +
    +public int getFrameDisplayWidth(int displaySize)
    +
    +
    Returns the width for the specified displaySize at which point a CalHTMLPane will + start scaling its display if optimizeDisplay is enabled. + The permitted displaySize arguments are:

    +

    • CalCons.S_SMALL +
    • CalCons.S_MEDIUM
    +
    +
    +
    +
    + +

    +setDefaultFont

    +
    +public void setDefaultFont(int displaySize,
+                           int fontFamily,
+                           int sizeIndex)
    +
    +
    Deprecated. Use setDefaultFont(int, Font) which allows the setting of + system fonts.
    +
    +
    +
    +
    + +

    +setDefaultFont

    +
    +public void setDefaultFont(int displaySize,
+                           java.awt.Font font)
    +
    +
    Sets a default font to be used by a CalHTMLPane. + This method takes three different size arguments: +
    • CalCons.S_SMALL +
    • CalCons.S_MEDIUM +
    • CalCons.S_LARGE

      +

    + In most cases you will call this method with the CalCons.S_LARGE argument. + The S_SMALL and S_MEDIUM arguments are used in special cases + relating to printing (which is not yet supported in the Java 2 version of CalPane) and + the optimizeDisplay feature of CalHTMLPane. +

    This method replaces the now deprecated + setDefaultFont(int displaySize, int fontFamily, int sizeIndex) method because + Java 2 allows access to system fonts, rather than just Java's logical fonts. +

    The font point sizes supported in CalPane are: 10, 11, 12, 13, 14, 16, 18, 20, 22, 24, 28, 36, 48 +

    If the size of the font sent to this method does not exactly match a supported size, then the + closest supported value will be used.

    +
    See Also:
    setOptimizeDisplay(int)
    +
    +
    +
    + +

    +getDefaultFont

    +
    +public java.awt.Font getDefaultFont(int displaySize)
    +
    +
    Returns a default font being used by a CalHTMLPane
    +
    See Also:
    setDefaultFont(int, java.awt.Font)
    +
    +
    +
    + +

    +setFormFont

    +
    +public void setFormFont(int displaySize,
+                        int fontFamily,
+                        int fontStyle,
+                        int sizeArrayIndex)
    +
    +
    Deprecated. Use either setDefaultButtonFont(int, Font) or + setDefaultFormTextFont(int, Font).
    +
    +
    +
    +
    + +

    +setDefaultButtonFont

    +
    +public void setDefaultButtonFont(int displaySize,
+                                 java.awt.Font font)
    +
    +
    Sets a default font to be used within form Buttons and ComboBoxes. This method only applies + to THREEDEE and FLUSH form components. LOOKANDFEEL + components will not be affected. + This method takes three different size arguments: +
    • CalCons.S_SMALL +
    • CalCons.S_MEDIUM +
    • CalCons.S_LARGE

      +

    + In most cases you will call this method with the CalCons.S_LARGE argument. + The S_SMALL and S_MEDIUM arguments are used in special cases + relating to the optimizeDisplay feature of CalHTMLPane. +

    The font point sizes supported in CalPane are: 10, 11, 12, 13, 14, 16, 18, 20, 22, 24, 28, 36, 48 +

    If the size of the font sent to this method does not exactly match a supported size, then the + closest supported value will be used.

    +
    See Also:
    setOptimizeDisplay(int)
    +
    +
    +
    + +

    +getDefaultButtonFont

    +
    +public java.awt.Font getDefaultButtonFont(int displaySize)
    +
    +
    Returns a default font being used within THREEDEE and FLUSH + Buttons and ComboBoxes.
    +
    See Also:
    setDefaultButtonFont(int, java.awt.Font)
    +
    +
    +
    + +

    +setDefaultFormTextFont

    +
    +public void setDefaultFormTextFont(int displaySize,
+                                   java.awt.Font font)
    +
    +
    Sets a default font to be used within form TextFields, TextAreas and Lists. This method only applies + to THREEDEE and FLUSH form components. LOOKANDFEEL + components will not be affected. + This method takes three different size arguments: +
    • CalCons.S_SMALL +
    • CalCons.S_MEDIUM +
    • CalCons.S_LARGE

      +

    + In most cases you will call this method with the CalCons.S_LARGE argument. + The S_SMALL and S_MEDIUM arguments are used in special cases + relating to the optimizeDisplay feature of CalHTMLPane. +

    The font point sizes supported in CalPane are: 10, 11, 12, 13, 14, 16, 18, 20, 22, 24, 28, 36, 48 +

    If the size of the font sent to this method does not exactly match a supported size, then the + closest supported value will be used.

    +
    See Also:
    setOptimizeDisplay(int)
    +
    +
    +
    + +

    +getDefaultFormTextFont

    +
    +public java.awt.Font getDefaultFormTextFont(int displaySize)
    +
    +
    Returns a default font being used within THREEDEE and FLUSH + Textfields, TextAreas and Lists.
    +
    See Also:
    setDefaultFormTextFont(int, java.awt.Font)
    +
    +
    +
    + +

    +setDefaultColor

    +
    +public void setDefaultColor(int attributeType,
+                            java.awt.Color c)
    +
    +
    Sets a default color. Permitted values are: +

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    attributeTypeDefaultDescription
    CalCons.A_BGCOLORColor.whiteDocument background color
    CalCons.A_TEXTColor.blackDocument text color
    CalCons.A_LINKColor(0xOOOOEA)Normal link color
    CalCons.A_VLINKColor(0x800080)Visited link color
    CalCons.A_ALINKColor.redActive link color
    CalCons.FORM_CONTROLUIControlControl color of form components
    CalCons.FORM_HIGHLIGHTUIHighlightHighlight color of form components
    CalCons.FORM_SHADOWUIShadowShadow color of form components
    CalCons.FORM_TEXT_BACKGROUNDColor.whiteBackground color within form components such + as textfields
    CalCons.FORM_TEXT_COLORColor.blackText color within form components such + as textfields
    CalCons.TAB_FOCUS_BACKGROUNDColor(0x300060)Background color of hyperlinks which have + keyboard focus
    CalCons.TAB_FOCUS_FOREGROUNDColor(0xFFFFD0)Foreground color of hyperlinks which have + keyboard focus
    +

    This method should be called prior to passing the + CalHTMLPreferences to a CalHTMLPane. Calls after this point + will be ignored.

    +
    +
    +
    +
    + +

    +getDefaultColor

    +
    +public java.awt.Color getDefaultColor(int attributeType)
    +
    +
    Returns a default color used by a CalHTMLPane to render documents. + See setDefaultColor() for allowed attributeTypes
    +
    See Also:
    setDefaultColor(int, java.awt.Color)
    +
    +
    +
    + +

    +setFormRenderingStyle

    +
    +public void setFormRenderingStyle(int style)
    +
    +
    Sets the rendering style of FORM components within a CalHTMLPane. + The permitted style values are:

    +

    • CalCons.USE_LOOK_AND_FEEL +
    • CalCons.USE_CALPA_THREEDEE +
    • CalCons.USE_CALPA_FLUSH +
    +

    The USE_LOOK_AND_FEEL argument will use standard Swing components based + on the currently installed Look&Feel. Generally these will provide an acceptable + display, but with certain document background colors these components lose + style features due to a clash between the background color of the document + and the control, shadow, and highlight color of the component. +

    The USE_CALPA_THREEDEE and USE_CALPA_FLUSH styles have + been incorporated to help overcome such a situation. These components support + author-specific color attributes which can be made to blend satisfactorily with + the surrounding document color. +

    Note that setting the default style via this method does not prevent the + document author from setting individual styles within the document itself. Styles + can be freely mixed by specifying style attributes within the relevant document + form tags. +

    Although this method can be called at any time during program execution, + existing form components will remain in their original style. +

    The default rendering style of form components is USE_CALPA_THREEDEE +

    See the README.TXT file accompanying this document for more details on form rendering.

    +
    Parameters:
    style - a value which determines the default rendering style of HTML form components
    +
    +
    +
    + +

    +getFormRenderingStyle

    +
    +public int getFormRenderingStyle()
    +
    +
    Returns the default rendering style of FORM components within a + CalHTMLPane.
    +
    Returns:
    a value indicating the default rendering style of HTML form components
    See Also:
    setFormRenderingStyle(int)
    +
    +
    +
    + +

    +setDefaultFrameSpacing

    +
    +public void setDefaultFrameSpacing(int n)
    +
    +
    Sets the default spacing in pixels between frames within a Frameset document. The default + setting is 4 pixels.
    +
    Parameters:
    n - the default spacing in pixels between HTML frames in a Frameset document
    +
    +
    +
    + +

    +getDefaultFrameSpacing

    +
    +public int getDefaultFrameSpacing()
    +
    +
    Returns the default spacing in pixels between frames within a Frameset document.
    +
    Returns:
    the default spacing in pixels between HTML frames in a Frameset document
    +
    +
    +
    + +

    +setDefaultMarginwidth

    +
    +public void setDefaultMarginwidth(int n)
    +
    +
    Sets the default horizontal margin of a document. The default setting is 6 pixels.
    +
    Parameters:
    n - the default horizontal margin in pixels between a document and the border of the frame it + resides in.
    +
    +
    +
    + +

    +getDefaultMarginwidth

    +
    +public int getDefaultMarginwidth()
    +
    +
    Returns the default horizontal margin of a document.
    +
    Returns:
    the default horizontal margin in pixels between a document and the border of the frame it + resides in.
    +
    +
    +
    + +

    +setDefaultMarginheight

    +
    +public void setDefaultMarginheight(int n)
    +
    +
    Sets the default vertical margin of a document. The default setting is 6 pixels.
    +
    Parameters:
    n - the default vertical margin in pixels between a document and the border of the frame it + resides in.
    +
    +
    +
    + +

    +getDefaultMarginheight

    +
    +public int getDefaultMarginheight()
    +
    +
    Returns the default vertical margin of a document.
    +
    Returns:
    the default vertical margin in pixels between a document and the border of the frame it + resides in.
    +
    +
    +
    + +

    +setHomeURL

    +
    +public void setHomeURL(java.net.URL url)
    +
    +
    Sets the URL which will be accessed if a CalHTMLPane's + goHome() method is called. The default setting is http://www.w3.org
    +
    Parameters:
    url - the default URL to be accessed.
    +
    +
    +
    + +

    +getHomeURL

    +
    +public java.net.URL getHomeURL()
    +
    +
    Returns the URL which will accessed if a CalHTMLPane's + goHome() method is called
    +
    Returns:
    the default URL which will be accessed.
    +
    +
    +
    + +

    +setUnderlineLinks

    +
    +public void setUnderlineLinks(boolean b)
    +
    +
    Enables/disables the underlining of hyperlinks within a CalHTMLPane. + The default value is true.
    +
    Parameters:
    b - a flag indicating whether hyperlinks should be underlined
    +
    +
    +
    + +

    +isUnderlineLinksEnabled

    +
    +public boolean isUnderlineLinksEnabled()
    +
    +
    Returns whether a CalHTMLPane will underline hyperlinks.
    +
    Returns:
    true if hyperlinks will be underlined
    +
    +
    +
    + +

    +setShowHyperlinkOnMouseFocus

    +
    +public void setShowHyperlinkOnMouseFocus(boolean b)
    +
    +
    Determines whether a hyperlink will only be marked as such when it has mouse focus. This is + commonly used in help systems where it is obvious that all text is a hyperlink entry, and users + only need to know which hyperlink is currently active. + The default value is false.
    +
    Parameters:
    b - a flag indicating whether hyperlinks will only be marked as such if they have mouse focus
    +
    +
    +
    + +

    +isShowHyperlinkOnMouseFocusEnabled

    +
    +public boolean isShowHyperlinkOnMouseFocusEnabled()
    +
    +
    Returns whether a CalHTMLPane will only show a hyperlink when the link has mouse focus.
    +
    Returns:
    true if a hyperlink will only be marked as such when it has mouse focus
    +
    +
    +
    + +

    +setLoadImages

    +
    +public void setLoadImages(boolean b)
    +
    +
    Enables/disables the automatic loading of images within a CalHTMLPane. + The default value is true.
    +
    Parameters:
    b - a flag indicating whether images within documents should be loaded and displayed
    +
    +
    +
    + +

    +isLoadImagesEnabled

    +
    +public boolean isLoadImagesEnabled()
    +
    +
    Returns whether a CalHTMLPane will + automatically load images within documents.
    +
    Returns:
    true if images within documents will be loaded and displayed
    +
    +
    +
    + +

    +setDisplayErrorDialogs

    +
    +public void setDisplayErrorDialogs(boolean b)
    +
    +
    Enables/disables the automatic display of error dialogs within a CalHTMLPane. + At present such errors will most commonly arise from a failure to navigate to a + selected URL. The default value is true. If set to false, errors will not be displayed + to the screen but will still be passed to the resident CalHTMLObserver
    +
    Parameters:
    b - a flag indicating whether an dialog should be displayed if an error occurs within a Pane.
    +
    +
    +
    + +

    +isDisplayErrorDialogsEnabled

    +
    +public boolean isDisplayErrorDialogsEnabled()
    +
    +
    Returns whether a CalHTMLPane will automatically display a dialog when + errors such as failed hyperlinks occur.
    +
    Returns:
    true if an error dialog will be displayed if an error occurs within a Pane.
    +
    +
    +
    + +

    +setShowTestNavBar

    +
    +public void setShowTestNavBar(boolean b)
    +
    +
    Enables/disables the display of a diagnostic navigation bar. The default value is false. +

    The navigation bar is a legacy of testing the component and is very basic, + but it has not been removed as it can be useful at times. + It is expected that users will implement their own custom navigation controls if required. +

    The NavBar operates independently of the CalHTMLObserver monitoring the + Pane, and will not interfere with updates to that object. Note also that the NavBar controls do not + receive keyboard focus when tabbing. +

    This method should be called prior to passing the + CalHTMLPreferences to a CalHTMLPane. Calls after this point + will be ignored.

    +
    Parameters:
    b - a flag indicating whether a CalHTMLPane's test navigation controls should be + displayed.
    +
    +
    +
    + +

    +isShowTestNavBarEnabled

    +
    +public boolean isShowTestNavBarEnabled()
    +
    +
    Returns whether a CalHTMLPane will display a diagnostic navigation bar on startup.
    +
    Returns:
    true if a CalHTMLPane will display test navigation controls.
    +
    +
    +
    + +

    +setAutomaticallyFollowHyperlinks

    +
    +public void setAutomaticallyFollowHyperlinks(boolean b)
    +
    +
    Enables/disables the automatic navigation of activated hyperlinks in a CalHTMLPane. + The default value is true. If set to false, activated hyperlinks will not be followed + but the event will still be passed to the resident CalHTMLObserver
    +
    Parameters:
    b - a flag indicating whether hyperlinks should be followed if activated by mouse or keyboard.
    +
    +
    +
    + +

    +isAutomaticallyFollowHyperlinksEnabled

    +
    +public boolean isAutomaticallyFollowHyperlinksEnabled()
    +
    +
    Returns whether a CalHTMLPane will automatically navigate activated hyperlinks.
    +
    Returns:
    true if hyperlinks should be followed if activated by keyboard or mouse.
    +
    +
    +
    + +

    +setHandleFormSubmission

    +
    +public void setHandleFormSubmission(boolean b)
    +
    +
    Enables/disables the automatic processing of GET and POST html forms + within a CalHTMLPane. The default value is true. If set to false, + form submissions will still be passed to the resident CalHTMLObserver
    +
    Parameters:
    b - a flag indicating whether http GET and POST form submissions should be handled automatically + by a CalHTMLPane
    +
    +
    +
    + +

    +isHandleFormSubmissionEnabled

    +
    +public boolean isHandleFormSubmissionEnabled()
    +
    +
    Returns whether a CalHTMLPane will + automatically handle GET and POST form submissions.
    +
    Returns:
    true if http GET and POST form submissions will be handled automatically + by a CalHTMLPane
    +
    +
    +
    + +

    +setShowWarningBeforePost

    +
    +public void setShowWarningBeforePost(boolean b)
    +
    +
    Enables/disables the showing of a warning message before a form POST submission + is made. The default value is true. This setting only has any meaning if the Pane is + handling form submissions.
    +
    Parameters:
    b - a flag indicating whether a warning message will displayed before an http form POST + submission
    +
    +
    +
    + +

    +isShowWarningBeforePostEnabled

    +
    +public boolean isShowWarningBeforePostEnabled()
    +
    +
    Returns whether a CalHTMLPane will show a warning to the user before a form POST + submission is made.
    +
    Returns:
    true if a warning message will displayed before an http form POST + submission
    +
    +
    +
    + +

    +setHandleNewFrames

    +
    +public void setHandleNewFrames(boolean b)
    +
    +
    Enables/disables the automatic creation of a new CalHTMLPane if + specified by an HTML tag. The default value is true. If set to false, a request + for a new frame will be sent to the resident CalHTMLObserver
    +
    Parameters:
    b - a flag indicating whether a new CalHTMLPane should automatically be + displayed if specified by an HTML tag.
    +
    +
    +
    + +

    +isHandleNewFramesEnabled

    +
    +public boolean isHandleNewFramesEnabled()
    +
    +
    Returns whether a new CalHTMLPane will + automatically be created if specified by an HTML tag.
    +
    Returns:
    true if a new CalHTMLPane will automatically be + displayed if specified by an HTML tag.
    +
    +
    +
    + +

    +setRequestFocusOnMouseClick

    +
    +public void setRequestFocusOnMouseClick(boolean b)
    +
    +
    Determines whether a CalHTMLPane or one of its subframes will request keyboard focus + if the mouse is clicked within it. The default value is false.
    +
    Parameters:
    b - a flag indicating whether a CalHTMLPane frame should call + requestFocus() if the mouse is clicked within it.
    +
    +
    +
    + +

    +isRequestFocusOnMouseClickEnabled

    +
    +public boolean isRequestFocusOnMouseClickEnabled()
    +
    +
    Returns whether a CalHTMLPane will request keyboard focus if the mouse is + clicked within it.
    +
    Returns:
    true if a CalHTMLPane frame will call + requestFocus() if the mouse is clicked within it.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/calpa/html/DefaultCalHTMLObserver.html b/extensions/calpa/Docs/javadoc/calpa/html/DefaultCalHTMLObserver.html new file mode 100644 index 0000000..92bcce1 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/calpa/html/DefaultCalHTMLObserver.html @@ -0,0 +1,346 @@ + + + + + + +: Class DefaultCalHTMLObserver + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + +

    + +calpa.html +
    +Class DefaultCalHTMLObserver

    +
    +java.lang.Object
+  |
+  +--calpa.html.DefaultCalHTMLObserver
+
    +
    +
    +
    public class DefaultCalHTMLObserver
    extends java.lang.Object
    implements CalHTMLObserver
    + +

    +A default implementation of the CalHTMLObserver interface. + All methods in this class are null-ops. Users of this class need only + override those methods of interest. +

    +

    +
    See Also:
    CalHTMLObserver
    +
    + +

    + + + + + + + + + + + + + + + + +
    +Constructor Summary
    DefaultCalHTMLObserver() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidformSubmitUpdate(CalHTMLPane pane, + java.net.URL docBaseURL, + int method, + java.lang.String action, + java.lang.String data) + +
    +           
    + voidhistoryUpdate(CalHTMLPane pane, + int position) + +
    +           
    + voidlinkActivatedUpdate(CalHTMLPane pane, + java.net.URL url, + java.lang.String targetFrame, + java.lang.String jName) + +
    +           
    + voidlinkFocusedUpdate(CalHTMLPane pane, + java.net.URL url) + +
    +           
    + voidshowNewFrameRequest(CalHTMLPane pane, + java.lang.String targetFrame, + java.net.URL url) + +
    +           
    + voidstatusUpdate(CalHTMLPane pane, + int status, + java.net.URL url, + int value, + java.lang.String message) + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, +equals, +finalize, +getClass, +hashCode, +notify, +notifyAll, +toString, +wait, +wait, +wait
    +  +

    + + + + + + + + + + + +
    +Constructor Detail
    + +

    +DefaultCalHTMLObserver

    +
    +public DefaultCalHTMLObserver()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +linkActivatedUpdate

    +
    +public void linkActivatedUpdate(CalHTMLPane pane,
+                                java.net.URL url,
+                                java.lang.String targetFrame,
+                                java.lang.String jName)
    +
    +
    +
    Specified by:
    linkActivatedUpdate in interface CalHTMLObserver
    +
    +
    +
    + +

    +linkFocusedUpdate

    +
    +public void linkFocusedUpdate(CalHTMLPane pane,
+                              java.net.URL url)
    +
    +
    +
    Specified by:
    linkFocusedUpdate in interface CalHTMLObserver
    +
    +
    +
    + +

    +statusUpdate

    +
    +public void statusUpdate(CalHTMLPane pane,
+                         int status,
+                         java.net.URL url,
+                         int value,
+                         java.lang.String message)
    +
    +
    +
    Specified by:
    statusUpdate in interface CalHTMLObserver
    +
    +
    +
    + +

    +formSubmitUpdate

    +
    +public void formSubmitUpdate(CalHTMLPane pane,
+                             java.net.URL docBaseURL,
+                             int method,
+                             java.lang.String action,
+                             java.lang.String data)
    +
    +
    +
    Specified by:
    formSubmitUpdate in interface CalHTMLObserver
    +
    +
    +
    + +

    +historyUpdate

    +
    +public void historyUpdate(CalHTMLPane pane,
+                          int position)
    +
    +
    +
    Specified by:
    historyUpdate in interface CalHTMLObserver
    +
    +
    +
    + +

    +showNewFrameRequest

    +
    +public void showNewFrameRequest(CalHTMLPane pane,
+                                java.lang.String targetFrame,
+                                java.net.URL url)
    +
    +
    +
    Specified by:
    showNewFrameRequest in interface CalHTMLObserver
    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/deprecated-list.html b/extensions/calpa/Docs/javadoc/deprecated-list.html new file mode 100644 index 0000000..dd7e4b3 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/deprecated-list.html @@ -0,0 +1,108 @@ + + + + + + +: Deprecated List + + + + + + + + + + + + + + + + + +
    + +
    + + +
    +
    +

    +Deprecated API

    +
    + + + + + + + + + + + +
    +Deprecated Methods
    calpa.html.CalHTMLPreferences.setDefaultFont(int, int, int) +
    +          Use setDefaultFont(int, Font) which allows the setting of + system fonts. 
    calpa.html.CalHTMLPreferences.setFormFont(int, int, int, int) +
    +          Use either setDefaultButtonFont(int, Font) or + setDefaultFormTextFont(int, Font). 
    +  +

    +

    + + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/help-doc.html b/extensions/calpa/Docs/javadoc/help-doc.html new file mode 100644 index 0000000..f5ab828 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/help-doc.html @@ -0,0 +1,136 @@ + + + + + + +: API Help + + + + + + + + + + + + + + + + + +
    + +
    + + +
    +
    +

    +How This API Document Is Organized

    +
    +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    +Package

    +
    + +

    +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

      +
    • Interfaces (italic)
    • Classes
    • Exceptions
    • Errors
    +
    +

    +Class/Interface

    +
    + +

    +Each class, interface, inner class and inner interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
    • Class inheritance diagram
    • Direct Subclasses
    • All Known Subinterfaces
    • All Known Implementing Classes
    • Class/interface declaration
    • Class/interface description +

      +

    • Inner Class Summary
    • Field Summary
    • Constructor Summary
    • Method Summary +

      +

    • Field Detail
    • Constructor Detail
    • Method Detail
    +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    +

    +Tree (Class Hierarchy)

    +
    +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    +
    +

    +Deprecated API

    +
    +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    +

    +Index

    +
    +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    +

    +Prev/Next

    +These links take you to the next or previous class, interface, package, or related page.

    +Frames/No Frames

    +These links show and hide the HTML frames. All pages are available with or without frames. +

    +

    +Serialized Form

    +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

    + + +This help file applies to API documentation generated using the standard doclet. + +
    +

    + + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/index-all.html b/extensions/calpa/Docs/javadoc/index-all.html new file mode 100644 index 0000000..3fb336d --- /dev/null +++ b/extensions/calpa/Docs/javadoc/index-all.html @@ -0,0 +1,482 @@ + + + + + + +: Index + + + + + + + + + + + + + + + + + +
    + +
    + + +A C D E F G H I K L R S
    +

    +A

    +
    +
    addUserComponent(JComponent) - +Static method in class calpa.html.CalHTMLManager +
    Adds a JComponent to the Manager's component cache. +
    addUserComponentArray(JComponent[], String) - +Static method in class calpa.html.CalHTMLManager +
    Adds an array of JComponents to the Manager's component cache. +
    addUserImage(Image, String) - +Static method in class calpa.html.CalHTMLManager +
    Adds an Image to the Manager's image cache. +
    +
    +

    +C

    +
    +
    CalHTMLManager - class calpa.html.CalHTMLManager.
    A class with static members and methods which primarily controls the caching of data + which will be available to all current instances of CalHTMLPane.
    CalHTMLObserver - interface calpa.html.CalHTMLObserver.
    A class implementing this interface can be passed to a CalHTMLPane at + construction time and will thereafter receive notification of events which have occured within the Pane.
    CalHTMLPane - class calpa.html.CalHTMLPane.
    A component class which has the capacity to display HTML-formatted content.
    CalHTMLPane() - +Constructor for class calpa.html.CalHTMLPane +
    Constructs a CalHTMLPane with default CalHTMLPreferences, + a default CalHTMLObserver and default top-level frame name. +
    CalHTMLPane(CalHTMLPreferences, CalHTMLObserver, String) - +Constructor for class calpa.html.CalHTMLPane +
    Constucts a CalHTMLPane with the specified CalHTMLObserver, + CalHTMLPreferences and top-level frame name. +
    CalHTMLPreferences - class calpa.html.CalHTMLPreferences.
    A class used to control the default operation and rendering methods + of a CalHTMLPane.
    CalHTMLPreferences() - +Constructor for class calpa.html.CalHTMLPreferences +
    Creates a new CalHTMLPreferences object which will have all fields + set to default values. +
    closeDialog() - +Method in class calpa.html.CalHTMLPane +
    Closes the Pane's dialog if it is currently visible. +
    +
    +

    +D

    +
    +
    DefaultCalHTMLObserver - class calpa.html.DefaultCalHTMLObserver.
    A default implementation of the CalHTMLObserver interface.
    DefaultCalHTMLObserver() - +Constructor for class calpa.html.DefaultCalHTMLObserver +
      +
    +
    +

    +E

    +
    +
    emptyDocumentCache() - +Static method in class calpa.html.CalHTMLManager +
    Empties the Manager's document cache. +
    +
    +

    +F

    +
    +
    formSubmitUpdate(CalHTMLPane, URL, int, String, String) - +Method in interface calpa.html.CalHTMLObserver +
    Notification that a form submission has been initiated. +
    formSubmitUpdate(CalHTMLPane, URL, int, String, String) - +Method in class calpa.html.DefaultCalHTMLObserver +
      +
    +
    +

    +G

    +
    +
    getDefaultButtonFont(int) - +Method in class calpa.html.CalHTMLPreferences +
    Returns a default font being used within THREEDEE and FLUSH + Buttons and ComboBoxes. +
    getDefaultColor(int) - +Method in class calpa.html.CalHTMLPreferences +
    Returns a default color used by a CalHTMLPane to render documents. +
    getDefaultFont(int) - +Method in class calpa.html.CalHTMLPreferences +
    Returns a default font being used by a CalHTMLPane +
    getDefaultFormTextFont(int) - +Method in class calpa.html.CalHTMLPreferences +
    Returns a default font being used within THREEDEE and FLUSH + Textfields, TextAreas and Lists. +
    getDefaultFrameSpacing() - +Method in class calpa.html.CalHTMLPreferences +
    Returns the default spacing in pixels between frames within a Frameset document. +
    getDefaultMarginheight() - +Method in class calpa.html.CalHTMLPreferences +
    Returns the default vertical margin of a document. +
    getDefaultMarginwidth() - +Method in class calpa.html.CalHTMLPreferences +
    Returns the default horizontal margin of a document. +
    getDocumentCacheCurrentSize() - +Static method in class calpa.html.CalHTMLManager +
    Returns the Manager's estimate of the current memory being taken up by cached documents. +
    getDocumentCacheMaximumSize() - +Static method in class calpa.html.CalHTMLManager +
    Returns the max size of the document cache used by the Manager. +
    getFormRenderingStyle() - +Method in class calpa.html.CalHTMLPreferences +
    Returns the default rendering style of FORM components within a + CalHTMLPane. +
    getFrameDisplayWidth(int) - +Method in class calpa.html.CalHTMLPreferences +
    Returns the width for the specified displaySize at which point a CalHTMLPane will + start scaling its display if optimizeDisplay is enabled. +
    getHomeURL() - +Method in class calpa.html.CalHTMLPreferences +
    Returns the URL which will accessed if a CalHTMLPane's + goHome() method is called +
    getIDComponents(String) - +Method in class calpa.html.CalHTMLPane +
    Returns a Hashtable containing all components in the target frame which have the HTML 'id' attribute. +
    getOptimizeDisplay() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will + adjust display parameters based on frame size. +
    getUserComponent(String, String) - +Static method in class calpa.html.CalHTMLManager +
    Retrieves a JComponent from the Manager's component cache. +
    getUserImage(String) - +Static method in class calpa.html.CalHTMLManager +
    Retrieves an Image from the Manager's image cache. +
    getVisitedHash() - +Method in class calpa.html.CalHTMLPreferences +
    Returns a Hashtable containing references to visited URLs. +
    goBack() - +Method in class calpa.html.CalHTMLPane +
    Show the previous document in the Pane's history list. +
    goForward() - +Method in class calpa.html.CalHTMLPane +
    Show the next document in the Pane's history list. +
    goHome() - +Method in class calpa.html.CalHTMLPane +
    Show the contents of the URL specified as homeURL + by CalHTMLPreferences in the top level frame of the Pane. +
    +
    +

    +H

    +
    +
    historyUpdate(CalHTMLPane, int) - +Method in interface calpa.html.CalHTMLObserver +
    Notification of a change in position within the Pane's document history. +
    historyUpdate(CalHTMLPane, int) - +Method in class calpa.html.DefaultCalHTMLObserver +
      +
    +
    +

    +I

    +
    +
    isAutomaticallyFollowHyperlinksEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will automatically navigate activated hyperlinks. +
    isCacheDocumentsEnabled() - +Static method in class calpa.html.CalHTMLManager +
    Indicates whether document caching is currently enabled. +
    isCalFocusManagerEnabled() - +Static method in class calpa.html.CalHTMLManager +
    Indicates whether a CalFocusManager is currently enabled. +
    isDisplayErrorDialogsEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will automatically display a dialog when + errors such as failed hyperlinks occur. +
    isFocusTraversable() - +Method in class calpa.html.CalHTMLPane +
    Overrides JComponent isFocusTraversable(). +
    isHandleFormSubmissionEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will + automatically handle GET and POST form submissions. +
    isHandleNewFramesEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a new CalHTMLPane will + automatically be created if specified by an HTML tag. +
    isLoadImagesEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will + automatically load images within documents. +
    isLoadSynchronouslyEnabled() - +Method in class calpa.html.CalHTMLPane +
    Returns whether documents will be loaded by the CalPane synchronously or asynchronously. +
    isManagingFocus() - +Method in class calpa.html.CalHTMLPane +
    Overrides JComponent isManagingFocus(). +
    isRequestFocusOnMouseClickEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will request keyboard focus if the mouse is + clicked within it. +
    isShowHyperlinkOnMouseFocusEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will only show a hyperlink when the link has mouse focus. +
    isShowTestNavBarEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will display a diagnostic navigation bar on startup. +
    isShowWarningBeforePostEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will show a warning to the user before a form POST + submission is made. +
    isUnderlineLinksEnabled() - +Method in class calpa.html.CalHTMLPreferences +
    Returns whether a CalHTMLPane will underline hyperlinks. +
    +
    +

    +K

    +
    +
    keyPressed(KeyEvent) - +Method in class calpa.html.CalHTMLPane +
    Public due to implementation requirements. +
    keyReleased(KeyEvent) - +Method in class calpa.html.CalHTMLPane +
    Public due to implementation requirements. +
    keyTyped(KeyEvent) - +Method in class calpa.html.CalHTMLPane +
    Public due to implementation requirements. +
    +
    +

    +L

    +
    +
    linkActivatedUpdate(CalHTMLPane, URL, String, String) - +Method in interface calpa.html.CalHTMLObserver +
    Notification that a hyperlink has been activated via the keyboard or mouse. +
    linkActivatedUpdate(CalHTMLPane, URL, String, String) - +Method in class calpa.html.DefaultCalHTMLObserver +
      +
    linkFocusedUpdate(CalHTMLPane, URL) - +Method in interface calpa.html.CalHTMLObserver +
    Notification that a hyperlink has received or lost keyboard/mouse focus. +
    linkFocusedUpdate(CalHTMLPane, URL) - +Method in class calpa.html.DefaultCalHTMLObserver +
      +
    +
    +

    +R

    +
    +
    reloadDocument() - +Method in class calpa.html.CalHTMLPane +
    Reloads the current document. +
    removeOldestDocumentFromCache() - +Static method in class calpa.html.CalHTMLManager +
    Removes the oldest document from the Manager's document cache. +
    removeUserComponent(String) - +Static method in class calpa.html.CalHTMLManager +
    Removes a JComponent from the Manager's component cache. +
    removeUserComponentArray(String) - +Static method in class calpa.html.CalHTMLManager +
    Removes a JComponent array from the Manager's component cache. +
    removeUserImage(String) - +Static method in class calpa.html.CalHTMLManager +
    Removes an Image from the Manager's image cache. +
    +
    +

    +S

    +
    +
    scrollToReference(String, String) - +Method in class calpa.html.CalHTMLPane +
    Scrolls the document view to the specified anchor reference in the named target frame. +
    setAutomaticallyFollowHyperlinks(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Enables/disables the automatic navigation of activated hyperlinks in a CalHTMLPane. +
    setBounds(int, int, int, int) - +Method in class calpa.html.CalHTMLPane +
    Public due to inheritance. +
    setCacheDocuments(boolean) - +Static method in class calpa.html.CalHTMLManager +
    Enables or disables the caching of documents by the Manager. +
    setCalFocusManagerEnabled(boolean) - +Static method in class calpa.html.CalHTMLManager +
    Enables or disables the CalFocusManager. +
    setDefaultButtonFont(int, Font) - +Method in class calpa.html.CalHTMLPreferences +
    Sets a default font to be used within form Buttons and ComboBoxes. +
    setDefaultColor(int, Color) - +Method in class calpa.html.CalHTMLPreferences +
    Sets a default color. +
    setDefaultFont(int, Font) - +Method in class calpa.html.CalHTMLPreferences +
    Sets a default font to be used by a CalHTMLPane. +
    setDefaultFont(int, int, int) - +Method in class calpa.html.CalHTMLPreferences +
    Deprecated. Use setDefaultFont(int, Font) which allows the setting of + system fonts. +
    setDefaultFormTextFont(int, Font) - +Method in class calpa.html.CalHTMLPreferences +
    Sets a default font to be used within form TextFields, TextAreas and Lists. +
    setDefaultFrameSpacing(int) - +Method in class calpa.html.CalHTMLPreferences +
    Sets the default spacing in pixels between frames within a Frameset document. +
    setDefaultMarginheight(int) - +Method in class calpa.html.CalHTMLPreferences +
    Sets the default vertical margin of a document. +
    setDefaultMarginwidth(int) - +Method in class calpa.html.CalHTMLPreferences +
    Sets the default horizontal margin of a document. +
    setDisplayErrorDialogs(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Enables/disables the automatic display of error dialogs within a CalHTMLPane. +
    setDocumentCacheMaximumSize(int) - +Static method in class calpa.html.CalHTMLManager +
    Sets the size of the document cache used by the Manager. +
    setFormFont(int, int, int, int) - +Method in class calpa.html.CalHTMLPreferences +
    Deprecated. Use either setDefaultButtonFont(int, Font) or + setDefaultFormTextFont(int, Font). +
    setFormRenderingStyle(int) - +Method in class calpa.html.CalHTMLPreferences +
    Sets the rendering style of FORM components within a CalHTMLPane. +
    setFrameDisplayWidth(int, int) - +Method in class calpa.html.CalHTMLPreferences +
    Sets the width for the specified displaySize at which point a CalHTMLPane will + start scaling its display if optimizeDisplay is enabled. +
    setHandleFormSubmission(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Enables/disables the automatic processing of GET and POST html forms + within a CalHTMLPane. +
    setHandleNewFrames(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Enables/disables the automatic creation of a new CalHTMLPane if + specified by an HTML tag. +
    setHomeURL(URL) - +Method in class calpa.html.CalHTMLPreferences +
    Sets the URL which will be accessed if a CalHTMLPane's + goHome() method is called. +
    setLoadImages(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Enables/disables the automatic loading of images within a CalHTMLPane. +
    setLoadSynchronously(boolean) - +Method in class calpa.html.CalHTMLPane +
    Enables/disables the synchronous loading of documents. +
    setOptimizeDisplay(int) - +Method in class calpa.html.CalHTMLPreferences +
    Determines whether a CalHTMLPane will + adjust display parameters based on frame width. +
    setRequestFocusOnMouseClick(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Determines whether a CalHTMLPane or one of its subframes will request keyboard focus + if the mouse is clicked within it. +
    setScrollBarPolicy(int) - +Method in class calpa.html.CalHTMLPane +
    Sets the scrollbar policy of the Pane. +
    setShowHyperlinkOnMouseFocus(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Determines whether a hyperlink will only be marked as such when it has mouse focus. +
    setShowTestNavBar(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Enables/disables the display of a diagnostic navigation bar. +
    setShowWarningBeforePost(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Enables/disables the showing of a warning message before a form POST submission + is made. +
    setUnderlineLinks(boolean) - +Method in class calpa.html.CalHTMLPreferences +
    Enables/disables the underlining of hyperlinks within a CalHTMLPane. +
    setVisitedHash(Hashtable) - +Method in class calpa.html.CalHTMLPreferences +
    Sets the Hashtable containing references to URLs which + will be used by a CalHTMLPane to mark visited + hyperlinks. +
    showDialog(String) - +Method in class calpa.html.CalHTMLPane +
    Parses the sent message as HTML and displays the result in the Pane's dialog. +
    showDialog(String, String, int, int, int, int) - +Method in class calpa.html.CalHTMLPane +
    Parses the sent message as HTML and displays the result in the Pane's dialog. +
    showHTMLDocument(String) - +Method in class calpa.html.CalHTMLPane +
    Formats and displays the specified String as an HTML document in the top level frame of the Pane. +
    showHTMLDocument(String, String) - +Method in class calpa.html.CalHTMLPane +
    Formats and displays the specified String as an HTML document in the named + target frame. +
    showHTMLDocument(URL) - +Method in class calpa.html.CalHTMLPane +
    Shows the contents of the specified URL in the top level frame of + the Pane. +
    showHTMLDocument(URL, String, boolean) - +Method in class calpa.html.CalHTMLPane +
    Shows the contents of the specified URL in the named + target frame. +
    showNewFrameRequest(CalHTMLPane, String, URL) - +Method in interface calpa.html.CalHTMLObserver +
    Notification for a new CalHTMLPane to be created with + the specified top-level frame name and showing the specified document. +
    showNewFrameRequest(CalHTMLPane, String, URL) - +Method in class calpa.html.DefaultCalHTMLObserver +
      +
    statusUpdate(CalHTMLPane, int, URL, int, String) - +Method in interface calpa.html.CalHTMLObserver +
    Gives general notifications of events or errors which are occuring within the Pane. +
    statusUpdate(CalHTMLPane, int, URL, int, String) - +Method in class calpa.html.DefaultCalHTMLObserver +
      +
    stopAll() - +Method in class calpa.html.CalHTMLPane +
    Stops all processes within the Pane. +
    +
    +A C D E F G H I K L R S + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/index.html b/extensions/calpa/Docs/javadoc/index.html new file mode 100644 index 0000000..4b4e402 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/index.html @@ -0,0 +1,22 @@ + + + + + + +Generated Documentation (Untitled) + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to <A HREF="calpa/html/CalHTMLManager.html">Non-frame version.</A> + diff --git a/extensions/calpa/Docs/javadoc/overview-tree.html b/extensions/calpa/Docs/javadoc/overview-tree.html new file mode 100644 index 0000000..2918699 --- /dev/null +++ b/extensions/calpa/Docs/javadoc/overview-tree.html @@ -0,0 +1,113 @@ + + + + + + +: Class Hierarchy + + + + + + + + + + + + + + + + + +
    + +
    + + +
    +
    +

    +Hierarchy For All Packages

    +
    +

    +Class Hierarchy +

    +
      +
    • class java.lang.Object
        +
      • class calpa.html.CalHTMLManager
      • class calpa.html.CalHTMLPreferences (implements calpa.html.CalCons) +
      • class java.awt.Component (implements java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable) +
          +
        • class java.awt.Container
            +
          • class javax.swing.JComponent (implements java.io.Serializable) +
              +
            • class javax.swing.JLayeredPane (implements javax.accessibility.Accessible) +
                +
              • class calpa.html.CalHTMLPane (implements calpa.html.CalCons, java.awt.event.KeyListener) +
              +
            +
          +
        +
      • class calpa.html.DefaultCalHTMLObserver (implements calpa.html.CalHTMLObserver) +
      +
    +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + +
    + +
    + + +
    + + + diff --git a/extensions/calpa/Docs/javadoc/stylesheet.css b/extensions/calpa/Docs/javadoc/stylesheet.css new file mode 100644 index 0000000..539689f --- /dev/null +++ b/extensions/calpa/Docs/javadoc/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF } + +/* Table colors */ +#TableHeadingColor { background: #CCCCFF } /* Dark mauve */ +#TableSubHeadingColor { background: #EEEEFF } /* Light mauve */ +#TableRowColor { background: #FFFFFF } /* White */ + +/* Font used in left-hand frame lists */ +#FrameTitleFont { font-size: normal; font-family: normal } +#FrameHeadingFont { font-size: normal; font-family: normal } +#FrameItemFont { font-size: normal; font-family: normal } + +/* Example of smaller, sans-serif font in frames */ +/* #FrameItemFont { font-size: 10pt; font-family: Helvetica, Arial, sans-serif } */ + +/* Navigation bar fonts and colors */ +#NavBarCell1 { background-color:#EEEEFF;}/* Light mauve */ +#NavBarCell1Rev { background-color:#00008B;}/* Dark Blue */ +#NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;} +#NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;} + +#NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} +#NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} + diff --git a/extensions/calpa/LICENSE.txt b/extensions/calpa/LICENSE.txt new file mode 100644 index 0000000..2ea7a81 --- /dev/null +++ b/extensions/calpa/LICENSE.txt @@ -0,0 +1,114 @@ + + + Binary Code License + + calpa.html Java package + + Version 2.021 + +This binary code license ("License") contains rights and +restrictions associated with use of the accompanying class files +of the Version 2.021 calpa.html Java package (the "Software") +and documentation (the "Documentation"). You should read the +License carefully before using the Software. By using the Software +you agree to the terms and conditions of this License. + +1. Limited Nonexclusive License + +You acknowledge that you are acquiring only a limited nonexclusive +license to use the Software and Documentation. Andrew Moulden of +82A Queens Road, Leicester, United Kingdom (the "Author") remains +the owner of all right, title, and interest in the Software and +Documentation, and in any copies of either. + +You agree not to engage in nor to permit the decompilation, +disassembly, or other reverse engineering of the Software. + + +2. Distribution outside software applications + +Where the Software is not being used within a Java or other software +application the License permits you to make multiple copies of the +Software and Documentation, and distribute it to others (including +transmission via electronic networks) provided that: + + (a) all copyright notices and this License are included with the + distribution. + + (b) no modification is made to the Software or Documentation. + + (c) no charge is made for the Software or Documentation. + + +3. Use within Java or other applications + +The License permits you, without fee to the Author, to make multiple +copies of the Software and include it within your own software +application provided that: + + (a) a copyright notice acknowledging the Author's ownership of the + Software is included with your application. + + (b) no modification is made to the Software. + + (c) the Software is used: + + (i) within a non-commercial application. + + or: + + (ii) to assist in the display of Help, Support, or Tutorial + documentation within your application and where the + prime function of your application is not the display + of Help, Support or Tutorial documentation. + + or: + + (iii) to assist in the display of Advertising or Promotional + material relating to your application, organization or + business. + + +Where your application does not qualify under the above provisions +you are permitted under this License to use the Software within +a single copy of your application for evaluation purposes. Under no +circumstances are you permitted to distribute the Software with your +application. + + +4. No incidental or consequential damages + +IN NO EVENT WILL THE AUTHOR BE LIABLE TO YOU FOR ANY INCIDENTAL, +SPECIAL, PUNITIVE, EXEMPLARY, OR CONSEQUENTIAL DAMAGES ARISING FROM +OR CONNECTED WITH THIS AGREEMENT OR YOUR USE OF THE SOFTWARE OR +DOCUMENTATION regardless of whether the Author knows or has reason +to know of the possibility of such damages. + + +5. Your indemnity to the Author + +Independent of the foregoing provisions, you agree to defend and +indemnify the Author against, and hold the Author harmless from, +any and all claims, damages, losses, and expenses of any kind arising +from or connected with the operation of your business. + + +6. Disclaimer of Warranty + +The Software and Documentation is provided "AS IS," without a +warranty of any kind. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND +WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. + + +7. Termination + +If you materially breach this License argreement, the Author may +terminate your right to use the Software by notice to you. + + +8. Governing Law + +Any action related to this License will be governed by the laws +of the United Kingdom of Great Britain & Northern Ireland. + diff --git a/extensions/calpa/README.txt b/extensions/calpa/README.txt new file mode 100644 index 0000000..4730c55 --- /dev/null +++ b/extensions/calpa/README.txt @@ -0,0 +1,1309 @@ + README + + CalHTMLPane 2.021 + + +----------------------------------------------------------------------- +CONTENTS + + - Overview + - License for use + - Requirements + - Using a CalPane + - Adding your own components and images + - Intercepting events from within a document + - Supported tags and attributes + - Form components + - The Pane's Dialog + - The Pane's Focus Manager + - Optimize Display + - Viewing Web pages + - Bug reports + - Known problems + - Contacting the author + + +----------------------------------------------------------------------- + OVERVIEW +----------------------------------------------------------------------- + +This is version 2.021 of the CalHTMLPane ('CalPane' or 'Pane'). + +The CalHTMLPane is a sub-component of a Java development package +named Calpa, and was built to provide two main services to the package: + + -Instantly accessible HTML Help documentation without the need to + start up a native Web browser. + -The display of HTML documents dynamically authored from online + databases. + +A CalHTMLPane allows Java application builders to incorporate HTML +documents into a GUI display. It supports a wide range of HTML3.2 and +HTML4.0 tags so that documents can be authored with popular HTML +editors and immediately displayed within a Java application. HTML form +components can be included in these documents in the normal way, and a +programming API is provided to enable the controlling Java application +to interact with those components, and to enable programmers to +customize the component within their own applications. The Pane also +contains caching and history features which remove much of the burden +of document management. Keyboard support is provided, including +tabbing between and activating hyperlinks via the keyboard. + +The Pane can be used to display Web pages from within an application, +and Web browsing capabilities can be built around it. It can +automatically handle basic form submissions, with more complex server +interaction being dealt with by the programmer if so desired. +However the Pane cannot be expected to handle documents which +incorporate inline scripts. That is not the purpose of its design. + +This document gives the class user a general introduction to the +CalHTMLPane's API and discusses certain aspects of its implementation. +It is not necessary to read all of the sections below to begin using +a CalPane, but following the first five examples will give the reader +a good insight into how the calpa.html public classes relate to one +another. + +Additional documentation is also provided: JavaDoc for the CalPane's +public classes, and HTML documentation giving examples of tag and +attribute usage. The HTML documents need to be viewed within a +running CalPane, not a normal Web browser, as they demonstrate +aspects of the component's form rendering styles as well as other +features specific to a CalPane. 'CalGuide.html' is the main index +of this documentation. + +The rest of these notes presume a certain level of Java programming +experience on the part of the reader, and strong familiarity with the +Swing package. + +----------------------------------------------------------------------- + LICENSE FOR USE +----------------------------------------------------------------------- + +You must read the license that accompanies the calp.html package class +files before you may use them. Briefly, however, and without prejudice +to the terms of the license, you are permitted to use the class files: + + -for non-commercial use. + + -for commercial use, provided that you are only using the class + files to show either : + + (a) Help, Support or Tutorial documentation within your + application, and provided that the use of the classes + is incidental to the main function of that application. + or: + + (b) Advertising or Promotional material relating to your + application or business. + +For other commercial uses you should email the copyright holder at +the following address stating the desired use of the classes, and +consideration will be given to the grant of a commercial license. + +Contact: + + Andrew J. Moulden + offshore@netcomuk.co.uk + + +----------------------------------------------------------------------- + REQUIREMENTS +----------------------------------------------------------------------- + +Version 2.0 of the CalHTMLPane requires a Java 2 Virtual Machine, and +the classes have not been tested against any version of the Java +Development Kit before 1.2 Final. + +This component was built and tested on a Win32 machine running +Windows95. It is believed to be written in 100% Java using Sun's JDK +tools and should perform identically elsewhere. + +It is best to give an increased amount of memory to the JVM running a +CalPane. The first instantiation of the Pane (including its static +support classes) uses 300K - 400K of memory, but it is the HTML +documents which take up space. As a general guide (assuming you are +caching documents) : + + -For showing fairly simple Help documentation 2MB of system memory + should be sufficient. + -For more complex documentation such as the JDK API, 4MB min is + recommended if 50+ documents will be viewed and cached. + -For viewing the sort of documents found on commercial Web sites + consider 8MB+. The images within such pages can consume a great + deal of memory. + +The amount of memory given to the JVM can be set by using the -ms +switch when a program is run. To give an application 8MB of RAM the +command would be: + + java -ms8m MyApplication + +Memory specification is not mandatory however. The VM will allocate +memory on an as-needed basis, though this may slow document loading. + +The caching of documents is programmable, and the CalPane's Manager +will start removing the oldest documents from the cache when it gets +full. Caching of images is left to the JVM. + +If the CalHTMLPane is run in conjunction with a Just-In-Time (JIT) +compiler, the first two or three documents will load quite slowly +and the mouse cursor may not focus hyperlinks for a brief moment. +However there should be a significant performance boost thereafter. +On many machines parsing matches or even surpasses that of a native +Web browser, allowing the disabling of caching if documents are +being loaded from a local file system. + + +----------------------------------------------------------------------- + USING A CALPANE +----------------------------------------------------------------------- +The CalHTMLPane is a Swing JComponent. Specifically it extends the +JLayeredPane class. It is therefore recommended that the component be +used in a 'lightweight' Swing environment rather than mixing it with +'heavyweight' AWT components. + +The JAR file containing the CalPane classes (calpahtml.jar) needs to +be in your classpath. The following code should then load and display +an HTML document of your choosing: + +---------------------------------------- +import java.net.*; +import java.awt.*; +import javax.swing.*; +import calpa.html.*; + +public class MyFirstCalPaneApplication { + + public static void main(String args[]) { + + URL url = null; + try { + //This is an example URL. You need to format your own. + //If you use an http URL you'll need an open http connection + url = new URL("file:///c:/jdk1.2/docs/api/overview-summary.html"); + } catch (MalformedURLException e) { + System.err.println("Malformed URL"); + System.exit(1); + } + + JFrame f = new JFrame(); + CalHTMLPane pane = new CalHTMLPane(); + f.getContentPane().add(pane, "Center"); + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + if (url != null) { + pane.showHTMLDocument(url); + pane.requestFocus(); + } + } +} +---------------------------------------- +Assuming the document has displayed correctly you should find that you +can navigate any hyperlinks. Any links which can't be followed +will result in an error dialog appearing. This dialog will be +discussed later. + +Keyboard navigation should be avaialable within the document. We +called requestFocus() for the Pane, and pressing the TAB key should +move focus to the next hyperlink or form control if either exist. + + -SHIFT-TAB will move backwards through the focus cycle. + -ENTER will activate a hyperlink if one has focus. + -CURSOR-DOWN or SPACE will scroll the Pane downward if the + document is long enough. + -CURSOR-UP or SHIFT_SPACE will scroll upward. + -CURSOR_LEFT, CURSOR_RIGHT scroll left and right. + -PAGE_UP and PAGE_DOWN scroll up and down a page at at time + +If there is a Frameset document on screen it is possible to tab +between frames by pressing CTRL-TAB (which also gets the user out +of the Pane completely if there are other controls in the +application which can accept keyboard focus). + + * * * + +The CalPane is a component, not an application, and so it is left +to the class user to create customized navigation buttons such +as 'back' and 'forward'. However, the Pane has an internal navigation +bar which is useful for testing purposes, and in the next example we +will make this visible. + +This introduces another of the calpa.html public classes - +CalHTMLPreferences. A CalHTMLPreferences ('CalPref') object controls +aspects of a CalPane's behaviour and rendering policy - whether to +underline hyperlinks, handle form submission etc. Every Pane has a +controlling CalHTMLPreferences object, and when the first example +above was run, a default CalPref was used. The programmer can +create an instance of CalHTMLPreferences, modify selected values by +using its access methods, and then pass it to a CalPane constructor. +It is possible to change certain preferences after the Pane has been +constructed, but only before construction can *all* preferences be +set. Note also that a single CalPref can control any number of +CalPanes. + +So, in the following slightly modified version of the first example we +will create a CalHTMLPreferences object and use one of its public +methods to get the CalPane's test navigation bar showing: + +---------------------------------------- +import java.net.*; +import java.awt.*; +import javax.swing.*; +import calpa.html.*; + +public class MySecondCalPaneApplication { + + public static void main(String args[]) { + + URL url = null; + try { + url = new URL("file:///c:/jdk1.2/docs/api/overview-summary.html"); + } catch (MalformedURLException e) { + System.err.println("Malformed URL"); + System.exit(1); + } + + JFrame f = new JFrame(); + + //create a Preferences object + CalHTMLPreferences pref = new CalHTMLPreferences(); + + //use one of its methods to enable the test navbar + pref.setShowTestNavBar(true); + + //now pass the pref object to the Pane's constructor + CalHTMLPane pane = new CalHTMLPane(pref, null, null); + f.getContentPane().add(pane, "Center"); + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + if (url != null) { + pane.showHTMLDocument(url); + } + } +} +---------------------------------------- + +You should see a rather unexciting navigation bar when you run the +program, but at least it is now possible to traverse the CalPane's +history, reload a document, stop any processes if necessary, navigate +by entering a URL in the textfield, and get some status information +on document loading. Note that this navbar is actually *within* the +Pane and is ignored by the Pane's focus manager. You cannot tab to the +controls because they do not exist as far as the Pane is concerned. + +(The textfield will accept a single name as an argument. If you type +'amazon' for example it will treat this as 'http://www.amazon.com') + + * * * + +Designing your own custom controls for a CalHTMLPane is very +straightforward, as demonstrated in Example 3. We will create some +external buttons ('Back', 'Forward', 'Reload' and 'Stop') to +demonstrate how controls can easily be added. + +[ Dean Jones' icon collection at: + + http://webart.javalobby.org/jlicons/ + + contains a number of icons which are well-suited for buttons to + control a CalHTMLPane. Dean has generously made these free + for use within Java applications. +] + + +---------------------------------------- +import java.net.*; +import java.awt.*; +import java.awt.event.*; +import javax.swing.*; +import calpa.html.*; + +public class MyThirdCalPaneApplication { + + public static void main(String args[]) { + + URL url = null; + try { + url = new URL("file:///c:/jdk1.2/docs/api/overview-summary.html"); + } catch (MalformedURLException e) { + System.err.println("Malformed URL"); + System.exit(1); + } + + JFrame f = new JFrame(); + CalHTMLPane pane = new CalHTMLPane(); + f.getContentPane().add(pane, "Center"); + + //create a panel, add buttons, and add a listener to the buttons + JPanel p = new JPanel(); + MyListener ml = new MyListener(pane); + String[] s = {"Reload", "Back", "Forward", "Stop"}; + JButton b; + for (int i=0; i<4; i++) { + b = new JButton(s[i]); + b.addActionListener(ml); + p.add(b); + } + f.getContentPane().add(p, "South"); + + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + if (url != null) { + pane.showHTMLDocument(url); + } + } + + + private static class MyListener implements ActionListener { + + CalHTMLPane pane; + + public MyListener(CalHTMLPane pane) { + + this.pane = pane; + } + + public void actionPerformed(ActionEvent e) { + + String s = e.getActionCommand(); + + if (("Reload").equals(s)) { + pane.reloadDocument(); + } else if (("Back").equals(s)) { + pane.goBack(); + } else if (("Forward").equals(s)) { + pane.goForward(); + } else if (("Stop").equals(s)) { + pane.stopAll(); + } + } + } +} +---------------------------------------- + +The JavaDoc included in the download gives details regarding the methods +which can be used to directly control a CalHTMLPane. The reader may be +wondering however how the buttons on the test navbar in example 2 'knew' +when to turn on and off. This introduces a third calpa.html public class +- CalHTMLObserver ('CalObs' or 'Observer'). In the same way a Pane always +has a resident Preferences object, it also always has an Observer. Once +again a default CalHTMLObserver is used if one is not passed to the +Pane's constructor. + +CalHTMLObserver is an interface, and an Observer can be created for a +CalHTMLPane in one of two ways: + + -by implementing CalHTMLObserver in a class. This means + implementing all methods of the interface. + + -by extending the public DefaultCalHTMLObserver class. This class + implements all the methods of CalHTMLObserver as null-ops, so + only those methods of interest need be overridden. + +The methods of CalHTMLObserver are basically all update methods. When +certain events occur within a CalHTMLPane (e.g. a form submit button is +pressed, a hyperlink gets focus, a document has finished loading) the +Pane will pass information about the event to its resident CalObs, and +from these updates the programmer can determine whether buttons should +be on or off, what the title of the current document is, and so on. + +A single CalObs can listen to any number of CalPanes, and centralising +events into this single interface is far more efficient than using +normal AWT event firing, additionally avoiding potentially dangerous +synchronization problems. Event multicasting is not normally required +in a component of this type, but if this is necessary the programmer +can maintain listener lists within the CalHTMLObserver implementation. + +In the next example we instantiate a CalHTMLPane as before, and this +time add a single label at the bottom in place of the buttons in the +previous example. We create our own CalHTMLObserver by extending +DefaultCalHTMLObserver, and override a single method which allows us +to get updates on focused hyperlinks. We then show the URL of the link +in the label. + +---------------------------------------- +import java.net.*; +import java.awt.*; +import javax.swing.*; +import calpa.html.*; + +public class MyFourthCalPaneApplication { + + public static void main(String args[]) { + + URL url = null; + try { + url = new URL("file:///c:/jdk1.2/docs/api/overview-summary.html"); + } catch (MalformedURLException e) { + System.err.println("Malformed URL"); + System.exit(1); + } + + JFrame f = new JFrame(); + JLabel label = new JLabel("0"); + label.setBorder(BorderFactory.createEmptyBorder(2, 8, 2, 8)); + label.setPreferredSize(label.getPreferredSize()); + label.setText(""); + CalHTMLPane pane = new CalHTMLPane(null, new MyCalHTMLObserver(label), null); + f.getContentPane().add(pane, "Center"); + f.getContentPane().add(label, "South"); + Dimension d = Toolkit.getDefaultToolkit().getScreenSize(); + f.setSize(new Dimension(Math.min(d.width - 10, 800), Math.min(d.height - 40, 600))); + f.setVisible(true); + if (url != null) { + pane.showHTMLDocument(url); + } + } + + + private static class MyCalHTMLObserver extends DefaultCalHTMLObserver { + + JLabel label; + + public MyCalHTMLObserver(JLabel label) { + + super(); + this.label = label; + } + + public void linkFocusedUpdate(CalHTMLPane p, URL url) { + + label.setText((url == null) ? "" : url.toExternalForm()); + } + } +} +---------------------------------------- + +When the above example is run, links which get either mouse or +keyboard focus should be shown at the bottom of the frame. When no link +has focus the label's text will be blank (actually, the label does not +clear itself when you go from one document to another, but that would +mean using another update method which would complicate the example). + +The example is in fact a little flawed. In the linkFocusedUpdate() +method there is no check made to ensure that the CalHTMLPane sending +the update is the one we originally instantiated. Although it seems +obvious that the CalHTMLPane sending the updates to the CalObserver +*must* be the Pane we created earlier, this is not necessarily so. +HTML allows the author to specify a target frame in hyperlinks, and +if the target is called '_blank' or is not the name of a currently +visible frame, then a new frame should be created to show the linked +document. By default a CalHTMLPane will create a new CalPane if it +comes across a link like this, and this could have happened when the +above example was run. + +In most cases the programmer will want a customized version of the +CalHTMLPane to appear in circumstances such as this, and the automatic +opening of new frames can be disabled through a method in +CalHTMLPreferences. When so disabled, the CalPane will call an update +method in CalHTMLObserver requesting the programmer to create a new +CalHTMLPane. + + +----------------------------------------------------------------------- + ADDING YOUR OWN COMPONENTS AND IMAGES TO A CALPANE +----------------------------------------------------------------------- + +There is just one more public calpa.html class that needs to be +discussed - CalHTMLManager ('Manager'). This class consists of a number +of static fields and methods and basically acts as a storage point for +all the CalPanes running in an application. The Manager caches documents +and imagemaps, and performs some other behind-the-scenes +housekeeping functions. + +There are also some public methods in CalHTMLManager which allow the +programmer to store JComponents and Images (i.e. instances of +java.awt.Image) with the Manager. Once these are cached with the Manager +they can be incorporated into HTML documents simply by naming them within +a relevant tag. A component or image can be referenced and reused in any +number of documents, and shown in any running CalPane (though of course, +a component can only be in one place at a time). + +The ability to add images in this manner was put into the Calpa package +because there are times when it is desirable to display an image which +the class user can be *sure* is available and fully loaded. A document +may for example contain form controls created with the new HTML4.0 +