Kafenio.editor Applet Parameters


The Kafenio Editor applet takes the following applet parameters:
NameTypeDescription
BASE64 optional if this parameter is "true" the content loaded from the "DOCUMENT" tag is decoded as base64 string.
BGCOLOR optional default is Color.light_grey. the background-color of the applet. NOTE: this does not affect the background color of the editor panel! the background-color for the editor panel is set using stylesheets
BUTTONS optional specifies the buttons to be displayed on the first toolbar. a list of space separated button-names.
BUTTONS2 optional specifies the buttons to be displayed on the second toolbar. a list of space separated button-names.
CODEBASE mandatory the applet's codebase and at the same time the base directory for relative image paths
CONTENTPARAMETER mandatory mandatory if postcontenturl is defined. this is the parameter-name that contains the content of the edited html document between the <body> tags.
DEBUG optional if "true" the applet runs in debug mode. default is "false".
DOCUMENT optional parameter that takes either base64 or urlencoded html-content that is displayed on startup. NOTE: if the "BASE64" parameter is "true" the content in this tag must be base64 encoded, if the "BASE64 parameter is not "true" the content must be urlencoded html-content.
FILEDIR optional if servletmode is set to "java" this parameter defines the relative path to server files on a cms server
IMAGEDIR optional if servletmode is set to "java" this parameter defines the relative path to the image-directory on a cms server.
LANGCODE optional if this parameter is not set, the default language settings apply.
LANGCOUNTRY optional if this parameter is not set, the default language settings apply.
MENUBAR mandatory if this parameter is "true", the menubar is shown in the applet. if false, the menubar will not be displayed.
MENUICONS mandatory if set to "true" icons for are displayed for some menuitems in the menubar.
MENUITEMS optional specifies the top-level menuitems to be displayed. a list of space separated item names.
OUTPUTMODE mandatory can be either "off", "normal" or "base64". this parameter defines if and how the content is posted to the url specified in "POSTCONTENTURL" is encoded. if OUTPUTMODE is set to "base64", the document body is encoded using base64. if OUTPUTMODE is set to "normal" the document body will be urlencoeded. if set to "off", no content will be posted at all.
POSTCONTENTURL optional the url to wich content is posted when pressing the "save content" button.
SERVLETMODE mandatory this parameter defines wich interface is used for parsing server-side data. the value can be either "cgi" or "java".
SERVLETURL mandatory only mandatory if servletmode is set to "java". not needed otherwise. it is used to identify the applet on the server.
SOURCEVIEW optional parameter that defines if the sourcecode-view of the html is shown on startup or not.
STYLESHEET optional zero or more URLs of stylesheet files to be loaded. separate more than one filename with a comma.
SYSTEMID optional system id that defines the system on the server side.
TOOLBAR mandatory if this parameter is "true", the first toolbar is shown in the applet. the buttons to show on this toolbar are defined in the "BUTTONS" parameter.
TOOLBAR2 mandatory if this parameter is "true", the second toolbar is shown in the applet. the buttons to show on this toolbar are defined in the "BUTTONS2" parameter.
UNICODE optional if this parameter is "true" the text that exportet from the html-document is using unicode characters instead of html-entities. this feature allows to save a file and edit in other editors without wondering about what the html-entity means. NOTE: exporting unicode-characters makes the html-code incompatible with browsers that do not support the unicode characters (most browsers will show question marks instead of the correct character.)


Possible Values for the "BUTTONS" and "BUTTONS2" parameters:
NameDescription
ANCHOR button to add a hyperlink to the selected text
BOLD button to format selected text bold / normal
CENTER button to align current paragraph centered
CLEARFORMATS button to clear all formattings on the selected text
COLOR button that opens a colorpicker dialog to set the selected text's foreground color
COPY button to copy selected text to the clipboard
CUT button to cut selected text and store it in the clipboard
DEINDENT button to de-indent the current paragraph
DETACHFRAME button that pops the editor applet out of the browser into a separate window and back.
FIND button to open the search dialog
IMAGE button to open the insert image from server dialog
INDENT button to indent the current paragraph
INSERTCHARACTER button to open the insert special character dialog.
ITALIC button to format selected text italic / normal
JUSTIFY button to align current paragraph justified
LEFT button to align current paragraph on the left
NEW button to create a new document
OLIST button to create a new ordered list
OPEN button to open a local document from the filechooser
PASTE button to paste content from the clipboard into the editor
RIGHT button to align current paragraph on the right
SAVE button to open the save file dialog
SAVECONTENT button that saves the content between the <body> tags to the url defined in "POSTCONTENTURL" parameter
SEPARATOR adds a separator between two buttons.
STRIKE button to format the selected text striked through / normal
STYLESELECT combobox that formats the selected text using the selected css-style
SUBSCRIPT button to subscript the selected text
SUPERSCRIPT button to superscript the selected text
TABLE button to open a create table dialog
ULIST button to create a new unordered list
UNDERLINE button to format the selected text underlined / normal
VIEWSOURCE button to switch between wysiwyg and html-sourcecode view.


Possible Values for the "MENUITEMS" parameter:
NameDescription
DEBUG show debug menu
EDIT show edit menu
FILE show file menu
FONT show font menu
FORMAT show format menu
FORMS show html-forms menu
HELP show help menu
INSERT show insert menu
SEARCH show search menu
TABLE show insert new table menu
TOOLS show tools menu
VIEW show view menu