|
Applet Parameters
<PARAM NAME = "saveURL" VALUE="http://yourhost.com/your_script"> - Specifies the URL of the script which will receive the content of the HTMLEditor when the user presses the "Save remote" button on the File menu. It will do nothing if this variable is not specified. It sends all the content of the editor using the POST method.
<PARAM NAME = "variableName" VALUE="html_content"> - Specifies the name of the variable to be used for the content of the editor when using the POST method. If not specified the default name is html_content
<PARAM NAME = "parametersToSend" VALUE="Var1=1&Var2=2"> - Specifies any additional variables to be sent along the content of the editor if your server-side script may need any.
<PARAM NAME="addJavascriptButtons" VALUE="shortcutToolbar,helloFromJavascript(),null,Hello there|shortcutToolbar,helloFromJavascript2(),null,Hello here"> - Using this parameter can be added multiple javascript buttons using the delimiter "|" for the buttons and "," for the button parameters. See addJavascriptButtons() javascript function for parameter details.
(Enterprise Edition Only) <PARAM NAME = "sourceCodeModeOnly" VALUE="true|false"> - Specifies whether the editor should run only in source code editor mode or not. If true, the editor will display only the HTML source code editor with syntax highlighting.
<PARAM NAME = "wrapNewLineIntoBR" VALUE="true|false"> - Specifies whether the Enter key should generate new paragraph or a line break. The default value is false and pressing the Enter key new paragraph is generated. The default key assignments are as follows
If wrapNewLineIntoBR is set to true then the Enter will generate line break <br> and for new paragraphs should be used Ctrl + Enter
<PARAM NAME ="absoluteDocumentTranslationURL" VALUE="http://yourhost/your_htmlfiles/"> - Specifies the translation path to be used to resolve the relative URLs of images, hyperlinks etc, if the content of the editor is set using javascript and the editor resides in a different directory than the one in which the edited documents are located. If this parameter is missing or not specified correctly some images may not be visualized correctly. If you need to specify only resolving of images inserted through the RemoteFileDialog, please consider for this the parameter remoteFileDialogAbsoluteImageTranslationURL which has the same functionality, but applies only for the remote file dialog.
<PARAM NAME ="remoteFileDialogAbsoluteImageTranslationURL " VALUE="http://yourhost/your_htmlfiles/"> - Specifies the translation path to be used to resolve the relative URLs of images, hyperlinks etc, inserted through the RemoteFileDialog. For difference from the absoluteDocumentTranslationURL this parameter will not affect the entire document, but only elements inserted through the RemoteFileDialog.
<PARAM NAME ="initialURL" VALUE="http://yourhost/anypage.htm"> - Specifies the initial page opened inside the editor if needed. If this parameter is not specified than blank page is created.
<PARAM NAME ="initialContent" VALUE="Hello, this is the initial content"> - Specifies simple initial content of the editor when the editor is started. If this parameter is not specified than blank page is created. For complex documents use initialURL instead of this one.
<PARAM NAME ="initialURLEncodedContent" VALUE="Hello%2c+this+is+the+initial+content"> - Specifies the initial content of the editor when the editor is started- it should be URLEncoded. The editor will decode it and visualize it for editing. This permits the loading of even very complicated pages, since all the tags are encoded and there is no interference with the rest of the page. This approach is very useful for loading of the initial content simply without javascripts etc.
<PARAM NAME ="uploadContentAsMultipartFormData" VALUE="true|false"> - if true, the content of the editor will be posted as multipart form data to the server when used the "Save Remote" menu item or the javascript function public boolean uploadMultipartContent(String saveLocation, boolean entireFile) . This will include all images, hyperlink targets etc. and everything will be packed and uploaded to the server. If this parameter is used in conjunction with uploadedObjectsTranslationPath the URLs of the images and hyperlinks will be converted automatically in order to be displayed correctly after uploading. See the javascript functions for major details on how to upload content to the server through javascript.
<PARAM NAME ="restrictedFontsList" VALUE="Sans Serif,Verdana,Arial,Comic Sans,Tahoma,..."> - Should contain a comma separated values of the fonts to be used. If specified, instead of using all system font, only the fonts specified by this parameter will be used.
<PARAM NAME ="defaultInitialFont" VALUE="Verdana"> - If specified the the editor will use this font as default font to be applied automatically upon typing.
<PARAM NAME ="fontSizes" VALUE="8,10,12,14,..."> - If specified the the editor will use this font sizes instead of the standard ones.
When the applet runs as a separate window version you can specify with the parameters below the appearance of the button which launches the editor window:
<PARAM NAME ="buttonBgColor" VALUE="0xFFFFFF"> - Specifies the background color of the button
<PARAM NAME ="buttonFgColor" VALUE="0x000000"> - Specifies the background color of the button
<PARAM NAME ="buttonText" VALUE="Start the Visual Editor"> - Specifies the text on the button
If the applet runs in the embedded mode this parameters are simply ignored.
<PARAM NAME ="supressRemoteFileDialog" VALUE="true|false"> - Indicates whether the RemoteFileDialog should be disabled. If "true" the dialog will be disabled, if false the dialog will be active and will try to load the page indicated with the parameter remoteBrowseLocation. Must pay attention on the security restrictions when indicating the URL to load if not granted the additional privileges requested at startup.
<PARAM NAME ="supressLocalFileDialog" VALUE="true|false"> - Indicates whether the LocalFileDialog should be disabled. If "true" the dialog will be disabled, if false the dialog will be active and will be available for browsing local files if the security restrictions permit this. The signed applet will request additional privileges upon loading and if granted will be possible to open/browse/save files on the local machine.
<PARAM NAME ="remoteBrowseLocation" VALUE="http://yourhost.com/YourFileBrowserScript"> - Indicates the URL of the page that should be loaded when using remote file browsing. If you want to be able to select and insert files through the remote file browser dialog, the output from the server should complain with only few requirements: There is absolutely no obligation of the type of the server side script since the editor display any page sent by the server inside the RemoteFileDialog. The only requirement for select & insert capability is that the links to the files are in the following format:
<input type="submit" name="anyName" value="files/taxi-3.jpg"> - that means that all buttons on the page passed will be treated as file entries and the value contains the URL of the image that should be inserted or the target for hyperlink depending on which operation we are executing - insert image, insert hyperlink or open file. You can see the example page here. You can find on-line demo demonstrating the remote file browsing in action here: http://www.sferyx.com/htmleditorapplet. If you encounter any difficulties to accomplish this task you can contact support@sferyx.com for assistance.
<PARAM NAME ="remoteLinksBrowseLocation" VALUE="http://yourhost.com/YourHyperlinkBrowserScript"> - Indicates the URL of the page that should be loaded when using remote hypelink browsing. If you want to be able to hyperlinks through the remote file browser dialog, the output from the server should complain with only few requirements: There is absolutely no obligation of the type of the server side script since the editor display any page sent by the server inside the RemoteFileDialog. The only requirement for select & insert capability is that the links to the files are in the following format:
<input type="submit" name="anyName" value="files/taxi-3.jpg"> - that means that all buttons on the page passed will be treated as file entries and the value contains the URL of the image that should be inserted or the target for hyperlink depending on which operation we are executing - insert image, insert hyperlink or open file.
<PARAM NAME ="externalStyleSheetLocation" VALUE="http://yourhost/YourStyleSheetFile.css"> - Indicates the URL of the style sheet file (css) to be loaded. If this parameter is indicated, then the style sheet will be loaded and added to the document. All the class names will be parsed and will be available for browsing through the style combo boxes on all property dialogs. See the following CSS file format guidelines:
In order to achieve best rendering results please use only separate selectors such as the following:
body {color: #000; font-size: 10px; font-family: Verdana, Arial, Helvetica, sans-serif; text-decoration: none }
td {color: #000; font-size: 10px; font-family: Verdana, Arial, Helvetica, sans-serif; text-decoration: none }
p {fcolor: #000; font-size: 10px; font-family: Verdana, Arial, Helvetica, sans-serif; text-decoration: none }
.text {color: #000; font-size: 10px;}
(Enterprise Edition Only) <PARAM NAME ="externalDictionary" VALUE="http://yourhost/dictionary.dict"> - Indicates the URL of the dictionary to be used for spell checking. The dictionary should be plain text in the following semicolon delimited format
A=;aa;aaaa;aaaaaa;.....etc;
B=;bb;bbb;bbbbb;bbbbbbb;......;
C=;ccc;cccc;ccccc;ccccc;....;
Each line contains all words for a given letter, for example the first line contains all the words beginning with A, the second with B etc.
All the words should be in lower case, note the initial and end delimiters. There shouldn't be any white spaces
| 
