wt.clients.dndMicroApplet
Interface DnDMicroAppletConstants

All Known Implementing Classes:

DnDMicroApplet

public interface DnDMicroAppletConstants

Defines all applet parameter name used by DnDMicroApplet.

Supported API: true

Extendable: true

Field Summary

static String	BG_COLOR_PARAM Name of the applet parameter which specifies the background color to be used by the applet.
static String	DOUBLE_CLICK_JS_PARAM Name of the applet parameter which specifies the JavaScript function to be called upon a double-click.
static String	DOUBLE_CLICK_URL_PARAM Name of the applet parameter which specifies the URL to use with AppletContext.showDocument() when the user double-clicks upon the applet.
static String	DOWNLOAD_FROM_DRAG_URL_PARAM Name of the applet parameter which specifies whether file list drag source data originating from this applet (as per DRAG_DATA_URL_PARAM) should be created as a hyperlink to the URL or to its downloaded contents.
static String	DRAG_DATA_FILE_NAME Name of the applet parameter which specifies the (leaf) name of the file which should be supplied as file list drag source data (see DRAG_DATA_URL_PARAM).
static String	DRAG_DATA_GET_STRING_JS_PARAM Name of the applet parameter which specifies a JavaScript function which determines the string/textual drag data for the given applet at a given moment.
static String	DRAG_DATA_HAS_STRING_JS_PARAM Name of the applet parameter which specifies a JavaScript function which determines whether there is currently string/textual drag data for the given applet at a given moment.
static String	DRAG_DATA_STRING_PARAM Name of the applet parameter which specifies a text string which the applet should provide as string/textual drag source data.
static String	DRAG_DATA_URL_PARAM Name of the applet parameter which specifies the URL which the applet should provide as file list drag source data.
static String	DRAG_ICON_PARAM Name of the applet parameter which specifies the URL of the icon the applet will display instead of ICON_PARAM when acceptable data is being dragged over the applet.
static String	DROP_POST_URL_PARAM Name of the applet parameter which specifies the URL to which drop data is posted if the drop data is determined to be too large to be handled via a GET request.
static String	ENCODING_NEEDED Name of the applet parameter which specifies whether the String arguments sent to the Javascript functions should be escaped or not.
static String	FILE_DROP_ACCEPT_DIRS_PARAM Name of the applet parameter which specifies whether the applet should forward directories (as opposed to normal files only) to the URL specified by FILE_DROP_URL_PARAM when files are dropped on the applet.
static String	FILE_DROP_JS_PARAM Name of the applet parameter which specifies the JavaScript function to be called upon file list data being dropped upon the applet.
static String	FILE_DROP_URL_PARAM Name of the applet parameter which specifies the URL to which the applet should send lists of files which are dropped onto the applet.
static String	ICON_GLYPH_PARAM Name of the applet parameter which specifies the URL of the icon that the applet will display on top of those specified by ICON_PARAM and DRAG_ICON_PARAM (i.e.
static String	ICON_PARAM Name of the applet parameter which specifies the URL of the icon the applet will display (at its origin coordinates).
static String	ID_PARAM Name of the applet parameter which specifies the "id" of the applet.
static String	JS_FILE_DELIM_PARAM Name of the applet parameter which specifies a string (which can consist of multiple characters) to be used to delimit files within the file list string passed to the JavaScript function specified by FILE_DROP_JS_PARAM.
static String	LOCALE_PARAM Name of the applet parameter which specifies the locale the applet should use.
static String	RETURN_URL_PARAM Name of the applet parameter which specifies the URL to pass along to URL requests when handling drop events (see STRING_DROP_URL_PARAM and FILE_DROP_URL_PARAM) as a "return address".
static String	STRING_DROP_JS_PARAM Name of the applet parameter which specifies a JavaScript function to be called upon string/text data being dropped upon the applet.
static String	STRING_DROP_URL_PARAM Name of the applet parameter which specifies the URL to which the applet should send string/textual data which is dropped onto the applet.
static String	TOOL_TIP_TEXT_PARAM Name of the applet parameter which specifies the tool tip text for the applet.
static String	URL_BASE_PARAM Name of the applet parameter which specifies the base URL from which the applet will resolve other parameters containing relative URLs.
static String	USE_JSOBJECT_CALL_FOR_VOID_CALLS_PARAM Name of the applet parameter which specifies whether JSObject.call() is used to call JavaScript functions even when the return value is not needed (i.e.

Field Detail

URL_BASE_PARAM

public static final String URL_BASE_PARAM

Name of the applet parameter which specifies the base URL from which the applet will resolve other parameters containing relative URLs. If this parameter is unspecified, Applet.getCodeBase() will be used by default.

Supported API: true

See Also:

Constant Field Values

ID_PARAM

public static final String ID_PARAM

Name of the applet parameter which specifies the "id" of the applet. This parameter is used in conjunction with STRING_DROP_JS_PARAM, FILE_DROP_JS_PARAM, and DOUBLE_CLICK_JS_PARAM. It also provides a default value for DRAG_DATA_STRING_PARAM if no value is specified for it.

Supported API: true

See Also:

Constant Field Values

BG_COLOR_PARAM

public static final String BG_COLOR_PARAM

Name of the applet parameter which specifies the background color to be used by the applet. The format of this parameter must be one which can be decoded by Color.decode(), e.g. the #RRGGBB format frequently used in CSS. Note that the color names, ala "fuschia" used in CSS are not accepted. If this parameter is omitted, the background color of the applet is left unspecified and defaults as per the JDK.

Supported API: true

See Also:

Constant Field Values

ICON_PARAM

public static final String ICON_PARAM

Name of the applet parameter which specifies the URL of the icon the applet will display (at its origin coordinates). This parameter will almost always be specified.

Supported API: true

See Also:

Constant Field Values

DRAG_ICON_PARAM

public static final String DRAG_ICON_PARAM

Name of the applet parameter which specifies the URL of the icon the applet will display instead of ICON_PARAM when acceptable data is being dragged over the applet.

Supported API: true

See Also:

Constant Field Values

ICON_GLYPH_PARAM

public static final String ICON_GLYPH_PARAM

Name of the applet parameter which specifies the URL of the icon that the applet will display on top of those specified by ICON_PARAM and DRAG_ICON_PARAM (i.e. it will be drawn after either of these and also at the applet origin). This parameter is optional and is used primarily to adorn base icons with decorative modifiers.

Supported API: true

See Also:

Constant Field Values

STRING_DROP_JS_PARAM

public static final String STRING_DROP_JS_PARAM

Name of the applet parameter which specifies a JavaScript function to be called upon string/text data being dropped upon the applet. The function will be called given the value of ID_PARAM as its first arg, the drop action as the second arg (as the string value of the integer), and the string drop data as the final arg. If neither this parameter nor STRING_DROP_URL_PARAM is specified string/textual data drops will not be accepted. If both are specified, the value of this parameter will be used.

Note that unlike FILE_DROP_JS_PARAM, the applet does not do any escaping of the string data before sending it to the specified JavaScript function. It is the applet user's responsibility to escape any string data themselves (and unescape it as necessary in the JavaScript function). [Thus this is not intended to handle any old string data, but rather string data provided by programmatic drag sources, e.g. other instances of DnDMicroApplet.]

Supported API: true

See Also:

Constant Field Values

STRING_DROP_URL_PARAM

public static final String STRING_DROP_URL_PARAM

Name of the applet parameter which specifies the URL to which the applet should send string/textual data which is dropped onto the applet. The drop data will be sent to the given URL as per HTTPParameterConstants. The current browser page will be replaced by this URL via AppletContext.showDocument(). If neither this parameter nor STRING_DROP_JS_PARAM is specified string/textual data drops will not be accepted. Also see notes on DROP_POST_URL_PARAM. If both are specified, the value of STRING_DROP_JS_PARAM will be used.

Supported API: true

See Also:

Constant Field Values

FILE_DROP_JS_PARAM

public static final String FILE_DROP_JS_PARAM

Name of the applet parameter which specifies the JavaScript function to be called upon file list data being dropped upon the applet. The function will be called given the value of ID_PARAM as its first arg, the drop action as the second arg (as the string value of the integer), and the file list drop data as the third arg.

Unless a value is specified for JS_FILE_DELIM_PARAM, the file list is passed as a single string with the first character being the separator character between all subsequent entries. See JS_FILE_DELIM_PARAM for more information on behavior when it is specified.

The fourth arg is a string beginning with the platform file separator character. The remaining characters are indeterminate due to a bug in Netscape. The platform file separator character is passed since all backslashes are replaced by forward slashes in the file list string (unless the browser is Microsoft Internet Explorer) to work around Netscape bugs, and thus passing this string allows one to know when to convert forward slashes to back slashes. Additionally, any and all single quote (apostrophe) character occurences (which are common in French file names) in the file paths are replaced by greater-than characters (as these are not valid file path characters at least on Windows -- and again this is not done if the browser is Microsoft Internet Explorer).

If neither this parameter nor FILE_DROP_URL_PARAM is specified file drops will not be accepted. If both are specified, the value of this parameter will be used. Also see notes on FILE_DROP_ACCEPT_DIRS_PARAM.

Supported API: true

See Also:

Constant Field Values

JS_FILE_DELIM_PARAM

public static final String JS_FILE_DELIM_PARAM

Name of the applet parameter which specifies a string (which can consist of multiple characters) to be used to delimit files within the file list string passed to the JavaScript function specified by FILE_DROP_JS_PARAM. If this parameter is not specified, then the default behavior specified for FILE_DROP_JS_PARAM will be followed. If this parameter is specified, however, its string value will be used as a delimiter between file path strings. Note that in this case there will be no leading occurence of the delimiter, as there is with default delimiting of FILE_DROP_JS_PARAM.

Supported API: true

See Also:

Constant Field Values

FILE_DROP_URL_PARAM

public static final String FILE_DROP_URL_PARAM

Name of the applet parameter which specifies the URL to which the applet should send lists of files which are dropped onto the applet. The drop data will be sent to the given URL as per HTTPParameterConstants. The current browser page will be replaced by this URL via AppletContext.showDocument(). If neither this parameter nor FILE_DROP_JS_PARAM is specified file drops will not be accepted. If both are specified, the value of FILE_DROP_JS_PARAM will be used. Also see notes on DROP_POST_URL_PARAM and FILE_DROP_ACCEPT_DIRS_PARAM.

Supported API: true

See Also:

Constant Field Values

FILE_DROP_ACCEPT_DIRS_PARAM

public static final String FILE_DROP_ACCEPT_DIRS_PARAM

Name of the applet parameter which specifies whether the applet should forward directories (as opposed to normal files only) to the URL specified by FILE_DROP_URL_PARAM when files are dropped on the applet. This parameter is interpreted as being 'true' whenever its value string is "true" or the parameter is left unspecified.

Supported API: true

See Also:

Constant Field Values

DRAG_DATA_URL_PARAM

public static final String DRAG_DATA_URL_PARAM

Name of the applet parameter which specifies the URL which the applet should provide as file list drag source data. The file list will contain a single (newly created) hyperlink (.url) file pointing to either the given URL or a (newly created) file containing the downloaded contents of the given URL, depending on the setting of DOWNLOAD_FROM_DRAG_URL_PARAM. If DRAG_DATA_URL_PARAM is left unspecified, then the applet will not provide file list drag source data.

Supported API: true

See Also:

Constant Field Values

DRAG_DATA_FILE_NAME

public static final String DRAG_DATA_FILE_NAME

Name of the applet parameter which specifies the (leaf) name of the file which should be supplied as file list drag source data (see DRAG_DATA_URL_PARAM). If this parameter is not specified a default name will be generated. Note that the filename specified will be used if no other files of the given name exist in the temporary directory, else a new, unique filename will be generated from the specified filename.

Supported API: true

See Also:

Constant Field Values

DRAG_DATA_STRING_PARAM

public static final String DRAG_DATA_STRING_PARAM

Name of the applet parameter which specifies a text string which the applet should provide as string/textual drag source data. If this parameter is left unspecified, then the applet will use the values of DRAG_DATA_HAS_STRING_JS_PARAM and DRAG_DATA_GET_STRING_JS_PARAM to provide string/textual drag source data if both are specified (see the descriptions for these parameters for more information. If DRAG_DATA_STRING_PARAM is not specified and either DRAG_DATA_HAS_STRING_JS_PARAM or DRAG_DATA_GET_STRING_JS_PARAM is not specified, then the value of ID_PARAM will be used if it is specified. If this parameter is left unspecified as well, then string/textual drags will be disabled for the given applet.

Note that one may provide a zero-length string for this parameter to ensure that the applet does not provide string/textual drag source data regardless of ID_PARAM value.

Supported API: true

See Also:

Constant Field Values

DRAG_DATA_HAS_STRING_JS_PARAM

public static final String DRAG_DATA_HAS_STRING_JS_PARAM

Name of the applet parameter which specifies a JavaScript function which determines whether there is currently string/textual drag data for the given applet at a given moment. The JavaScript function is passed a single argument, the value specified for ID_PARAM, and is expected to return (the string) "true" if there is currently string/textual drag data (i.e. if the function specified for DRAG_DATA_GET_STRING_JS_PARAM will return any appropriate data).

Supported API: true

See Also:

Constant Field Values

DRAG_DATA_GET_STRING_JS_PARAM

public static final String DRAG_DATA_GET_STRING_JS_PARAM

Name of the applet parameter which specifies a JavaScript function which determines the string/textual drag data for the given applet at a given moment. TO_DO

Supported API: true

See Also:

Constant Field Values

DOUBLE_CLICK_JS_PARAM

public static final String DOUBLE_CLICK_JS_PARAM

Name of the applet parameter which specifies the JavaScript function to be called upon a double-click. The functoin will be called with the value of ID_PARAM as its only argument. If neither this parameter nor DOUBLE_CLICK_URL_PARAM nor DRAG_DATA_URL_PARAM is specified, the applet will do nothing upon a double-click event. If a value is specified for this parameter, then DOUBLE_CLICK_URL_PARAM is ignored.

Supported API: true

See Also:

Constant Field Values

DOUBLE_CLICK_URL_PARAM

public static final String DOUBLE_CLICK_URL_PARAM

Name of the applet parameter which specifies the URL to use with AppletContext.showDocument() when the user double-clicks upon the applet. If this parameter is left unspecified, the applet will use the URL specified for the DRAG_DATA_URL_PARAM parameter. If that too is unspecified, the applet do nothing upon a double-click event. This parameter (including default values thereof) is ignored if DOUBLE_CLICK_JS_PARAM is specified.

Supported API: true

See Also:

Constant Field Values

RETURN_URL_PARAM

public static final String RETURN_URL_PARAM

Name of the applet parameter which specifies the URL to pass along to URL requests when handling drop events (see STRING_DROP_URL_PARAM and FILE_DROP_URL_PARAM) as a "return address". This URL is intended to serve as a place to "return to" upon completion of handling the drop. The manner by which this data is passed to the URL requests is specified by HTTPParameterConstants. If this parameter is left unspecified, the applet will attempt to determine the URL of the current page via JSObject and use it.

Supported API: true

See Also:

Constant Field Values

DROP_POST_URL_PARAM

public static final String DROP_POST_URL_PARAM

Name of the applet parameter which specifies the URL to which drop data is posted if the drop data is determined to be too large to be handled via a GET request. In the case that the data is too large, the data will be sent to this URL via a POST request. The result of this POST request will then be forwarded to a GET request to the originally specified GET URL via AppletContext.showDocument via an HTTP request parameter. See HTTPParameterConstants for more information.

Supported API: true

See Also:

Constant Field Values

DOWNLOAD_FROM_DRAG_URL_PARAM

public static final String DOWNLOAD_FROM_DRAG_URL_PARAM

Name of the applet parameter which specifies whether file list drag source data originating from this applet (as per DRAG_DATA_URL_PARAM) should be created as a hyperlink to the URL or to its downloaded contents. See DRAG_DATA_URL_PARAM. This parameter is considered 'false' unless the parameter is specified with a string value of "true".

Supported API: true

See Also:

Constant Field Values

LOCALE_PARAM

public static final String LOCALE_PARAM

Name of the applet parameter which specifies the locale the applet should use. Note that the name has been selected for consistency with existing Windchill code. If this is not specified, the default locale will be used.

The format for this string follows standard conventions, i.e. xx, xx_YY or xx_YY_zZz, where xx is the language code, YY is the country code, and zZz is a (non-standardized) variant or dialect.

Supported API: true

See Also:

Constant Field Values

ENCODING_NEEDED

public static final String ENCODING_NEEDED

Name of the applet parameter which specifies whether the String arguments sent to the Javascript functions should be escaped or not. This will be needed for Netscape 4.7x family of browsers where the Liveconnect fails for Multibyte characters.

This is not a Mandatory parameter. If it is present and true, the values sent to Javascript will be escaped using unicodeToAscii method. Unicode characters (except the range of 0x00 - 0x7F) are represented with uxxxx escape sequences. xxxx is a four digit hexadecimal integer

Supported API: true

See Also:

Constant Field Values

USE_JSOBJECT_CALL_FOR_VOID_CALLS_PARAM

public static final String USE_JSOBJECT_CALL_FOR_VOID_CALLS_PARAM

Name of the applet parameter which specifies whether JSObject.call() is used to call JavaScript functions even when the return value is not needed (i.e. even for drop- and double-click callbacks). JSObject.call() is always used in cases where the return value is needed as calling via 'javascript:' URLs does not provide a return value. JSObject.call() is also called by default when the browser is detected to be Microsoft Internet Explorer (where a Microsoft hotfix can render JavaScript URLs from the Java Plug-In unusable) or where encodingNeeded is specified (in which case JSObject.call() is used for all JavaScript function calls by for compatility reasons). Specifying this parameter explicitly will override this default logic.

Note that calling JavaScript functions via other means than JSObject.call() is new behavior and is done primarily because later Netscape and Mozilla browser versions started refusing to implicitly convert java.lang.String objects into JavaScript String objects where necessary (though previous Netscape and Mozilla versions and all MSIE versions handle this just fine). Netscape documents this as "correct" behavior in their JavaScript 1.5 documentation and states that one should concatenate "" onto Java String variables via the + operator to force this conversion! This thus broke virtually all existing JavaScript callbacks of this applet in the affected browsers.

If a case is found where the new approach is used and does not work for whatever reason, one can specify a value of 'true' for this parameter to use JSObject.call() instead. Just be sure to workaround the Netscape/Mozilla issue as per above.

Supported API: true

See Also:

Constant Field Values

TOOL_TIP_TEXT_PARAM

public static final String TOOL_TIP_TEXT_PARAM

Name of the applet parameter which specifies the tool tip text for the applet. If this is not specified or is an empty string, then the applet will not have a tool tip.

Supported API: true

See Also:

Constant Field Values