Package wt.clients.util

Class JFileChooserApplet

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Panel
java.applet.Applet
wt.clients.util.JFileChooserApplet
Record Components:
java_code - value="wt/clients/util/JFileChooserApplet" filepath from codebase to applet class
java_codebase - value="" URL for codebase, can obtain value by calling the createCodebase method in wt.htmlutil.HtmlUtil
java_archive - value="wt/security/security.jar" filepath from codebase to security.jar
cabinets - value="wt/security/security.cab" filepath from codebase to security.cab
type - value="application/x-java-applet;version=1.3" automatically generated by wt.taglib.util.PluginTagGenerator createPluginTag method
cache_archive - value="content.jar" filepath from codebase to Java archive JAR file
cache_option - value="Plugin" makes the Java archive JAR file get cached by the Plugin
wt - .context.locale value="" locale that the applet should be displaying in, can obtain by calling the createLocale method in wt.htmlutil.HtmlUtil
SCRIPTABLE - value="true" needed for applet-JavaScript interaction in IE
MAYSCRIPT - value="true" needed for applet-JavaScript interaction in Netscape The following parameters are not strictly required but are strongly recommended for appearance, behavior and performance reasons:
bgcolor - value="" to make applet look like it's part of the page, make the bgcolor the same as the bgcolor of the area that the applet is being displayed in. If the bgcolor is hard-coded in the page, can be hard-coded in applet tags as well. Otherwise, if page bgcolor is defined by stylesheet, obtain value by calling wt.enterprise.BasicTemplateProcessor getWCColorDec method with the CSS styleClass name that applies to the location of the applet (styleClass entries that will be referenced by the applet need to have matching entries in the Solution's .css file and the Solution's wt.properties file), defaults to light grey if no value provided
buttonLabel - value="" typically will be the localized version of "Browse..." retrieved from wt.clients.util.http.HTTPUtilRB, UPDN_BROWSE_LABEL entry. If no value is provided, applet will make a server hit to retrieve the wt.clients.util.http.HTTPUtilRB.UPDN_BROWSE_LABEL value, which slows down the initialization and display of the applet. The following parameters are totally optional and have intelligent defaults so you don't need to set them unless you want to change the default behavior.
debug - value="<true|false>" Defaults to false. Setting it to true will produce a lot of informative chatter in the Java Console. Typically set by retrieving the wt.clients.debug value from wt.properties
multiSelect - value="<true|false>" Defaults to false (single-select). Setting it to true will change file chooser from single-select to multi-select. If setting multiSelect to true, should also provide a delim parameter value to make sure that the applet is using the same delim string as the page.
delim - value="" If multiSelect=true, should provide a delim string which will be used by the applet to separate the filepaths if more than one file is chosen. Defaults to ";;;qqq". Typically set for file chooser applet tags, drag-and-drop target applet tags, filepath-handling JavaScript, and processing server code, all by retrieving the wt.doc.hiddenFieldDelimiter value from wt.properties.
actionLabel - value="" If no actionLabel value is provided, the file chooser window title and action button will be "Save". If actionLabel is provided, window title and action button will use the actionLabel value string.
jsSetMethod - value="" If no jsSetMethod value is specified, file chooser output will be used to invoke the JavaScript method setPath( newValue, fileSep ). The jsSetMethod param is specified in order to send the output to a different methodname. The method must accept two and only two arguments: a String which consists of the selected filepath (or multiple paths separated by delim string), and a String which is the file separator character used by the local filesystem.

Supported API:true

Extendable:false
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
public class JFileChooserApplet extends Applet
Applet used to select files (actually, filepath strings), requires Java plugin. This applet is used in HTML pages to launch a Java file dialog and return the the selected filepath(s) to the HTML page. Visible portion of applet is a button that typically says "Browse..." When the applet button is clicked, a file chooser dialog is launched. The user uses the file dialog to selects file(s) and clicks "Save" (or custom label) button. The filepath (or multiple concatenated filepaths) string is provided to the page by the applet calling the JavaScript method setPath() (or jsSetMethod-specified custom method). Used in single-select mode for selecting primary content files for FormatContentHolder objects (such as WTDocuments), typically in conjunction with an HTML text field to emulate an HTML file input (looks the same, but has much more intelligence). Used in multi-select mode for selecting secondary content of FormatContentHolder objects, and attachments for ContentHolder objects (such as change objects).
See Also: