OpenSymphony - RichTextEditor (WebWork API

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.opensymphony.webwork.components
Class RichTextEditor

java.lang.Object
  com.opensymphony.webwork.components.Component
      com.opensymphony.webwork.components.UIBean
          com.opensymphony.webwork.components.RichTextEditor

public class RichTextEditor
extends UIBean
extends UIBean

Create a Rich Text Editor based on FCK editor (www.fckeditor.net).

 
 
 <ww:richtexteditor 
                        toolbarCanCollapse="false"
                        width="700"
                        label="Description 1" 
                        name="description1" 
                        value="Some Content I keyed In In The Tag Itself"
                        />

It is possible to have a rich text editor do server side browsing when for example the image button is clicked. To integrate this functionality with webwork, one need to defined the following action definition typically in xwork.xml

   <package name="richtexteditor-browse" extends="webwork-default" 
   namespace="/webwork/richtexteditor/editor/filemanager/browser/default/connectors/jsp">
        <action name="connector" 
      class="com.opensymphony.webwork.components.DefaultRichtexteditorConnector" 
      method="browse">
                <result name="getFolders" type="richtexteditorGetFolders" />
                <result name="getFoldersAndFiles" type="richtexteditorGetFoldersAndFiles" />
                <result name="createFolder" type="richtexteditorCreateFolder" />
                <result name="fileUpload" type="richtexteditorFileUpload" />
        </action>
   </package>

By default whenever a browse command is triggered (eg. by clicking on the 'image' button and then 'browse server' button, the url '/webwork/static/richtexteditor/editor/filemanager/browser/default/browser.html?&Type=Image&Connector=connectors/jsp/connector.action'. The page browser.html which comes with FCK Editor will trigger the url '/webwork/richtexteditor/editor/filemanager/browser/default/connectors/jsp/connector.action' which will caused the webwork's DefaultRichtexteditorConnector to be executed. The trigerring url could be changed by altering the 'imageBrowseURL'. There 3 types of such related url, namely 'imageBrowseURL', 'linkBrowseURL' and 'flashBrowseURL'. It is recomended that the default one being used. One could change the Connector parameter instead. For example

 /webwork/static/richtexteditor/editor/filemanager/browser/default/browser.html?
 &Type=Image&Connector=connectors/jsp/connector.action

could be changed to

 /webwork/static/richtexteditor/editor/filemanager/browser/default/browser.html?
 &Type=Image&Connector=myLittlePath/myConnector.action

In this case the action will need to have a namespace of '/webwork/richtexteditor/editor/filemanager/browser/default/myLittlePath' and action name of 'myConnector'

By default the action method that needs to be defined in xwork.xml needs to be 'browse'. If this needs to be something else say, myBrowse, the following could be used

   public String myBrowse() {
       browse();
   }

It is possible for the richtexteditor to do server side uploading as well. For example when clicking on the 'Image' button and then the 'Upload' tab and then selecting a file from client local machine and the clicking 'Send it to the server'. To integrate this functionality with webwork, one need to defined the following action definition typically in xwork.xml

   <package name="richtexteditor-upload" extends="webwork-default" 
   namespace="/webwork/richtexteditor/editor/filemanager/upload">
                <action name="uploader" 
       class="com.opensymphony.webwork.components.DefaultRichtexteditorConnector" 
       method="upload">
                        <result name="richtexteditorFileUpload" />
                </action>    
   </package>

By default whenever an upload command is triggered, a '/webwork/static/richtexteditor/editor/filemanager/upload/uploader.action?Type=Image' will be issued. This could be changed by setting the imageUploadURL attribute of the tag. When this link is issued, the webwork action will get executed. There's 3 such related upload url namely, 'imageUploadURL', 'linkUploadURL' and 'flashUploadURL'. It is recomended that the default one being used. However one could change the url, but need to include the Type parameter. For example

 /webwork/static/richtexteditor/editor/filemanager/upload/uploader.action?Type=Image

could be changed to

 /webwork/static/richtexteditor/editor/filemanager/upload/aDifferentUploader.action?Type=Image

In this case the action will need to have a namespace of '/webwork/static/richtexteditor/editor/filemanager/upload' and action name of 'aDifferentUploader' By default the action method that needs to be defined in xwork.xml needs to be 'upload'. If this needs to be something else say, myUpload, the following could be used

   public String myUpload() {
       upload();
   }

The webwork action that handles the server-side browsing and uploading needs to extends from AbstractRichtexteditorConnector. There are four abstract methods need to be implemented, namely

  protected abstract String calculateServerPath(String serverPath, String folderPath, 
        String type) throws Exception;
  protected abstract Folder[] getFolders(String virtualFolderPath, String type) 
        throws Exception;
  protected abstract FoldersAndFiles getFoldersAndFiles(String virtualFolderPath, 
        String type) throws Exception;
  protected abstract CreateFolderResult createFolder(String virtualFolderPath, 
        String type, String newFolderName) throws Exception;
  protected abstract FileUploadResult fileUpload(String virtualFolderPath, 
        String type, String filename, String contentType, java.io.File newFile) 
        throws Exception;
  protected abstract void unknownCommand(String command, String virtualFolderPath, 
        String type, String filename, String contentType, java.io.File newFile) 
        throws Exception;

Version:: $Date: 2006/03/18 15:45:33 $ $Id: RichTextEditor.java,v 1.9 2006/03/18 15:45:33 rgielen Exp $
Author:: tm_jee
See Also:: AbstractRichtexteditorConnector

Field Summary

static String TEMPLATE


Fields inherited from class com.opensymphony.webwork.components.UIBean

accesskey, cssClass, cssStyle, disabled, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateSuffix, theme, title, tooltip, tooltipConfig, value

Fields inherited from class com.opensymphony.webwork.components.Component

COMPONENT_STACK, id, parameters, stack

Constructor Summary

RichTextEditor(OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response)


Method Summary

protected void evaluateExtraParams()


String getAllowFlashBrowse()


String getAllowFlashUpload()


String getAllowImageBrowse()


String getAllowImageUpload()


String getAllowLinkBrowse()


String getAllowLinkUpload()


String getAutoDetectLanguage()


String getBaseHref()


String getBasePath()


String getCheckBrowser()


String getContentLangDirection()


String getCustomConfigurationsPath()


String getDebug()


String getDefaultLanguage()


protected String getDefaultTemplate()
 A contract that requires each concrete UI Tag to specify which template should be used as a default.

String getDisplayError()


String getEditorAreaCSS()


String getEnableSourceXHTML()


String getEnableXHTML()


String getFillEmptyBlocks()


String getFlashBrowserURL()


String getFlashUploadAllowedExtension()


String getFlashUploadDeniedExtension()


String getFlashUploadURL()


String getFontColors()


String getFontFormats()


String getFontNames()


String getFontSizes()


String getForcePasteAsPlainText()


String getForceSimpleAmpersand()


String getFormatIndentator()


String getFormatOutput()


String getFormatSource()


String getFullPage()


String getGeckoUseSPAN()


String getHeight()


String getImageBrowserURL()


String getImageUploadAllowedExtension()


String getImageUploadDeniedExtension()


String getImageUploadURL()


String getLinkBrowserURL()


String getLinkUploadAllowedExtension()


String getLinkUploadDeniedExtension()


String getLinkUploadURL()


String getPluginsPath()


protected String getRichTextEditorJsLang()


String getSkinPath()


String getSmileyImages()


String getSmileyPath()


String getStartupFocus()


String getStylesXmlPath()


String getTabSpaces()


String getTemplatesXmlPath()


String getToolbarCanCollapse()


String getToolbarSet()


String getToolbarStartExpanded()


String getUseBROnCarriageReturn()


String getWidth()


void setAllowFlashBrowse(String allowFlashBrowse)
 determine if to allow flash browsing

void setAllowFlashUpload(String allowFlashUpload)
 determine if to allow flash upload

void setAllowImageBrowse(String allowImageBrowse)
 determine if to allow image browsing

void setAllowImageUpload(String allowImageUpload)
 determine if to allow image uploading

void setAllowLinkBrowse(String allowLinkBrowse)
 determine if to allow link browsing

void setAllowLinkUpload(String allowLinkUpload)
 determine if to allow link uploading

void setAutoDetectLanguage(String autoDetectLanguage)
 Tells the editor to automatically detect the user language preferences to adapt its interface language.

void setBaseHref(String baseHref)
 Base URL used to resolve links (on images, links, styles, etc.).

void setBasePath(String basePath)
 Set the dir where the FCKeditor files reside on the server

void setCheckBrowser(String checkBrowser)
 Whether the rich text editor should check for browser compatibility when rendering its toolbar

void setContentLangDirection(String contentLangDirection)
 Sets the direction of the editor area contents.

void setCustomConfigurationsPath(String customConfigurationsPath)
 Set the path of a custom file that can override some configurations.

void setDebug(String debug)
 Enables the debug window to be shown when calling the FCKDebug.Output() function.

void setDefaultLanguage(String defaultLanguage)
 Sets the default language used for the editor's interface localization.

void setDisplayError(String displayError)
 Whether should the rich text editor display error when it fails to render etc.

void setEditorAreaCSS(String editorAreaCSS)
 Set the CSS styles file to be used in the editing area.

void setEnableSourceXHTML(String enableSourceXHTML)
 Tells the editor to process the HTML source to XHTML when switching from WYSIWYG to Source view

void setEnableXHTML(String enableXHTML)
 Tells the editor to process the HTML source to XHTML on form post.

void setFillEmptyBlocks(String fillEmptyBlocks)
 Block elements (like P, DIV, H1, PRE, etc...) are forced to have content (a  ).

void setFlashBrowserURL(String flashBrowserURL)
 Sets the URL of the page called when the user clicks the 'Browse Server' button in the "Flash" dialog window.

void setFlashUploadAllowedExtension(String flashUploadAllowedExtension)
 regexp for allowed flash upload file format

void setFlashUploadDeniedExtension(String flashUploadDeniedExtension)
 regexp for deinied flash upload file format

void setFlashUploadURL(String flashUploadURL)
 Sets the URL of the upload handler called when the user clicks the 'Send it to server' button in the "Flash" dialog window.

void setFontColors(String fontColors)
 Sets the colors that must be shown in the colors panels (in the toolbar).

void setFontFormats(String fontFormats)
 Sets the list of formats to be shown in the "Format" toolbar command.

void setFontNames(String fontNames)
 Sets the list of fonts to be shown in the "Font" toolbar command.

void setFontSizes(String fontSizes)
 Sets the list of font sizes to be shown in the "Size" toolbar command.

void setForcePasteAsPlainText(String forcePasteAsPlainText)
 Converts the clipboard contents to pure text on pasting operations

void setForceSimpleAmpersand(String forceSimpleAmpersand)
 Forces the ampersands (&) on tags attributes to not be converted to '&' This conversion is a W3C requirement for XHTML, so it is recommended to leave this option to 'false'.

void setFormatIndentator(String formatIndentator)
 Sets the characters to be used when indenting the HTML source when formatting it.

void setFormatOutput(String formatOutput)
 The output HTML generated by the editor will be processed and formatted.

void setFormatSource(String formatSource)
 The HTML shown by the editor, while switching from WYSIWYG to Source views, will be processed and formatted

void setFullPage(String fullPage)
 Enables full page editing (from <HTML> to </HTML>).

void setGeckoUseSPAN(String geckoUseSPAN)
 Tells Gecko browsers to use SPAN instead of , and for bold, italic an underline

void setHeight(String height)
 Set the height of the rich text editor

void setImageBrowserURL(String imageBrowserURL)
 Sets the URL of the page called when the user clicks the 'Browse Server' button in the 'Image' dialog window.

void setImageUploadAllowedExtension(String imageUploadAllowedExtension)
 regexp for allowed image upload file format

void setImageUploadDeniedExtension(String imageUploadDeniedExtension)
 regexp for denied image upload file format

void setImageUploadURL(String imageUploadURL)
 Sets the URL of the upload handler called when the user clicks the 'Send it to server' button in the 'Image' dialog window.

void setLinkBrowserURL(String linkBrowserURL)
 Sets the URL of the page called when the user clicks the 'Browse Server' button in the 'Link' dialog window.

void setLinkUploadAllowedExtension(String linkUploadAllowedExtension)
 regexp for allowed link upload file format

void setLinkUploadDeniedExtension(String linkUploadDeniedExtension)
 regexp for denied link upload file format

void setLinkUploadURL(String linkUploadURL)
 Sets the URL of the upload handler called when the user clicks the 'Send it to server' button in the 'Link' dialog window.

void setPluginsPath(String pluginsPath)
 Sets the base path used when looking for registered plugins.

void setSkinPath(String skinPath)
 Sets the path to the skin (graphical interface settings) to be used by the editor.

void setSmileyImages(String smileyImages)
 js array of smilies files to be included

void setSmileyPath(String smileyPath)
 path where smilies are located

void setStartupFocus(String startupFocus)
 Forces the editor to get the keyboard input focus on startup (page load)

void setStylesXmlPath(String stylesXmlPath)
 Sets the path to the XML file that has the definitions and rules of the styles used by the 'Style' toolbar command

void setTabSpaces(String tabSpaces)
 Set the number of spaces (&nbsp) to be inserted when the user hits the 'tab' key.

void setTemplatesXmlPath(String templatesXmlPath)


void setToolbarCanCollapse(String toolbarCanCollapse)
 Tells the editor that the toolbar can be Collapsed/Expanded by the user when clicking the vertical bar placed on the left of it (on the right for 'rtl' languages).

void setToolbarSet(String toolbarSet)
 Set the name of the toolbar to display

void setToolbarStartExpanded(String toolbarStartExpanded)
 Decide if the toolbar should be expanded when the rich text editor is loaded

void setUseBROnCarriageReturn(String useBROnCarriageReturn)
 Decide if a should be used in place of the occurence of a carriage return

void setWidth(String width)
 set the width of the rich text editor

Methods inherited from class com.opensymphony.webwork.components.UIBean

addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateNameValue, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, setLabelposition, setLabelPosition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTheme, setTitle, setTooltip, setTooltipConfig, setValue

Methods inherited from class com.opensymphony.webwork.components.Component

addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, start, toString, usesBody

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEMPLATE

public static final String TEMPLATE

See Also:: Constant Field Values

Constructor Detail

RichTextEditor

public RichTextEditor(OgnlValueStack stack,
                      HttpServletRequest request,
                      HttpServletResponse response)

Method Detail

getDefaultTemplate

protected String getDefaultTemplate()

Description copied from class: UIBean

A contract that requires each concrete UI Tag to specify which template should be used as a default. For example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value not begin with a '/' unless you intend to make the path absolute rather than relative to the current theme.

Specified by:: getDefaultTemplate in class UIBean

Returns:: The name of the template to be used as the default.

evaluateExtraParams

protected void evaluateExtraParams()

Overrides:: evaluateExtraParams in class UIBean

getRichTextEditorJsLang

protected String getRichTextEditorJsLang()

getCheckBrowser

public String getCheckBrowser()

setCheckBrowser

public void setCheckBrowser(String checkBrowser)

Whether the rich text editor should check for browser compatibility when rendering its toolbar

getDisplayError

public String getDisplayError()

setDisplayError

public void setDisplayError(String displayError)

Whether should the rich text editor display error when it fails to render etc.

getAutoDetectLanguage

public String getAutoDetectLanguage()

setAutoDetectLanguage

public void setAutoDetectLanguage(String autoDetectLanguage)

Tells the editor to automatically detect the user language preferences to adapt its interface language. With Internet Explorer, the language configured in the Windows Control Panel is used. With Firefox, the browser language is used

getBaseHref

public String getBaseHref()

setBaseHref

public void setBaseHref(String baseHref)

Base URL used to resolve links (on images, links, styles, etc.). For example, if BaseHref is set to 'http://www.fredck.com', an image that points to "/images/Logo.gif" will be interpreted by the editor as "http://www.fredck.com/images/Logo.gif", without touching the "src" attribute of the image.

getBasePath

public String getBasePath()

setBasePath

public void setBasePath(String basePath)

Set the dir where the FCKeditor files reside on the server

getContentLangDirection

public String getContentLangDirection()

setContentLangDirection

public void setContentLangDirection(String contentLangDirection)

Sets the direction of the editor area contents. Either ltr or rtl

getCustomConfigurationsPath

public String getCustomConfigurationsPath()

setCustomConfigurationsPath

public void setCustomConfigurationsPath(String customConfigurationsPath)

Set the path of a custom file that can override some configurations. It is recommended to use absolute paths (starting with /), like /myfckconfig.js.

getDebug

public String getDebug()

setDebug

public void setDebug(String debug)

Enables the debug window to be shown when calling the FCKDebug.Output() function.

getDefaultLanguage

public String getDefaultLanguage()

setDefaultLanguage

public void setDefaultLanguage(String defaultLanguage)

Sets the default language used for the editor's interface localization. The default language is used when the AutoDetectLanguage options is disabled or when the user language is not available.

getEditorAreaCSS

public String getEditorAreaCSS()

setEditorAreaCSS

public void setEditorAreaCSS(String editorAreaCSS)

Set the CSS styles file to be used in the editing area. In this way you can point to a file that reflects your web site styles

getEnableSourceXHTML

public String getEnableSourceXHTML()

setEnableSourceXHTML

public void setEnableSourceXHTML(String enableSourceXHTML)

Tells the editor to process the HTML source to XHTML when switching from WYSIWYG to Source view

getEnableXHTML

public String getEnableXHTML()

setEnableXHTML

public void setEnableXHTML(String enableXHTML)

Tells the editor to process the HTML source to XHTML on form post.

getFillEmptyBlocks

public String getFillEmptyBlocks()

setFillEmptyBlocks

public void setFillEmptyBlocks(String fillEmptyBlocks)

Block elements (like P, DIV, H1, PRE, etc...) are forced to have content (a  ). Empty blocks are "collapsed" by while browsing, so a empty is not visible. While editing, the editor "expand" empty blocks so you can insert content inside then. Setting this option to "true" results useful to reflect the same output when browsing and editing.

getFlashBrowserURL

public String getFlashBrowserURL()

setFlashBrowserURL

public void setFlashBrowserURL(String flashBrowserURL)

Sets the URL of the page called when the user clicks the 'Browse Server' button in the "Flash" dialog window. In this way, you can create your custom Flash Browser that is well integrated with your system.

getFlashUploadURL

public String getFlashUploadURL()

setFlashUploadURL

public void setFlashUploadURL(String flashUploadURL)

Sets the URL of the upload handler called when the user clicks the 'Send it to server' button in the "Flash" dialog window. In this way, you can create your custom Flash Uploader that is well integrated with your system.

getFontColors

public String getFontColors()

setFontColors

public void setFontColors(String fontColors)

Sets the colors that must be shown in the colors panels (in the toolbar).

getFontFormats

public String getFontFormats()

setFontFormats

public void setFontFormats(String fontFormats)

Sets the list of formats to be shown in the "Format" toolbar command.

getFontNames

public String getFontNames()

setFontNames

public void setFontNames(String fontNames)

Sets the list of fonts to be shown in the "Font" toolbar command.

getFontSizes

public String getFontSizes()

setFontSizes

public void setFontSizes(String fontSizes)

Sets the list of font sizes to be shown in the "Size" toolbar command.

getForcePasteAsPlainText

public String getForcePasteAsPlainText()

setForcePasteAsPlainText

public void setForcePasteAsPlainText(String forcePasteAsPlainText)

Converts the clipboard contents to pure text on pasting operations

getForceSimpleAmpersand

public String getForceSimpleAmpersand()

setForceSimpleAmpersand

public void setForceSimpleAmpersand(String forceSimpleAmpersand)

Forces the ampersands (&) on tags attributes to not be converted to '&' This conversion is a W3C requirement for XHTML, so it is recommended to leave this option to 'false'.

getFormatIndentator

public String getFormatIndentator()

setFormatIndentator

public void setFormatIndentator(String formatIndentator)

Sets the characters to be used when indenting the HTML source when formatting it. Useful values are a sequence of spaces (' ') or a tab char ('\t').

getFormatOutput

public String getFormatOutput()

setFormatOutput

public void setFormatOutput(String formatOutput)

The output HTML generated by the editor will be processed and formatted.

getFormatSource

public String getFormatSource()

setFormatSource

public void setFormatSource(String formatSource)

The HTML shown by the editor, while switching from WYSIWYG to Source views, will be processed and formatted

getFullPage

public String getFullPage()

setFullPage

public void setFullPage(String fullPage)

Enables full page editing (from <HTML> to </HTML>). It also enables the 'Page Properties' toolbar button.

getGeckoUseSPAN

public String getGeckoUseSPAN()

setGeckoUseSPAN

public void setGeckoUseSPAN(String geckoUseSPAN)

Tells Gecko browsers to use SPAN instead of , and for bold, italic an underline

getHeight

public String getHeight()

setHeight

public void setHeight(String height)

Set the height of the rich text editor

getImageBrowserURL

public String getImageBrowserURL()

setImageBrowserURL

public void setImageBrowserURL(String imageBrowserURL)

Sets the URL of the page called when the user clicks the 'Browse Server' button in the 'Image' dialog window. In this way, you can create your custom Image Browser that is well integrated with your system.

getImageUploadURL

public String getImageUploadURL()

setImageUploadURL

public void setImageUploadURL(String imageUploadURL)

Sets the URL of the upload handler called when the user clicks the 'Send it to server' button in the 'Image' dialog window. In this way, you can create your custom Image Uploader that is well integrated with your system.

getLinkBrowserURL

public String getLinkBrowserURL()

setLinkBrowserURL

public void setLinkBrowserURL(String linkBrowserURL)

Sets the URL of the page called when the user clicks the 'Browse Server' button in the 'Link' dialog window. In this way, you can create your custom File Browser that is well integrated with your system.

getLinkUploadURL

public String getLinkUploadURL()

setLinkUploadURL

public void setLinkUploadURL(String linkUploadURL)

Sets the URL of the upload handler called when the user clicks the 'Send it to server' button in the 'Link' dialog window. In this way, you can create your custom Link Uploader that is well integrated with your system.

getPluginsPath

public String getPluginsPath()

setPluginsPath

public void setPluginsPath(String pluginsPath)

Sets the base path used when looking for registered plugins.

getSkinPath

public String getSkinPath()

setSkinPath

public void setSkinPath(String skinPath)

Sets the path to the skin (graphical interface settings) to be used by the editor.

getStartupFocus

public String getStartupFocus()

setStartupFocus

public void setStartupFocus(String startupFocus)

Forces the editor to get the keyboard input focus on startup (page load)

getStylesXmlPath

public String getStylesXmlPath()

setStylesXmlPath

public void setStylesXmlPath(String stylesXmlPath)

Sets the path to the XML file that has the definitions and rules of the styles used by the 'Style' toolbar command

getTabSpaces

public String getTabSpaces()

setTabSpaces

public void setTabSpaces(String tabSpaces)

Set the number of spaces (&nbsp) to be inserted when the user hits the 'tab' key. This is an Internet Explorer only feature. Other browsers insert spaces automatically by default.

getToolbarCanCollapse

public String getToolbarCanCollapse()

setToolbarCanCollapse

public void setToolbarCanCollapse(String toolbarCanCollapse)

Tells the editor that the toolbar can be Collapsed/Expanded by the user when clicking the vertical bar placed on the left of it (on the right for 'rtl' languages).

getToolbarSet

public String getToolbarSet()

setToolbarSet

public void setToolbarSet(String toolbarSet)

Set the name of the toolbar to display

getToolbarStartExpanded

public String getToolbarStartExpanded()

setToolbarStartExpanded

public void setToolbarStartExpanded(String toolbarStartExpanded)

Decide if the toolbar should be expanded when the rich text editor is loaded

getUseBROnCarriageReturn

public String getUseBROnCarriageReturn()

setUseBROnCarriageReturn

public void setUseBROnCarriageReturn(String useBROnCarriageReturn)

Decide if a should be used in place of the occurence of a carriage return

getWidth

public String getWidth()

setWidth

public void setWidth(String width)

set the width of the rich text editor

getAllowFlashBrowse

public String getAllowFlashBrowse()

setAllowFlashBrowse

public void setAllowFlashBrowse(String allowFlashBrowse)

determine if to allow flash browsing

getAllowFlashUpload

public String getAllowFlashUpload()

setAllowFlashUpload

public void setAllowFlashUpload(String allowFlashUpload)

determine if to allow flash upload

getAllowImageBrowse

public String getAllowImageBrowse()

setAllowImageBrowse

public void setAllowImageBrowse(String allowImageBrowse)

determine if to allow image browsing

getAllowImageUpload

public String getAllowImageUpload()

setAllowImageUpload

public void setAllowImageUpload(String allowImageUpload)

determine if to allow image uploading

getAllowLinkBrowse

public String getAllowLinkBrowse()

setAllowLinkBrowse

public void setAllowLinkBrowse(String allowLinkBrowse)

determine if to allow link browsing

getAllowLinkUpload

public String getAllowLinkUpload()

setAllowLinkUpload

public void setAllowLinkUpload(String allowLinkUpload)

determine if to allow link uploading

getFlashUploadAllowedExtension

public String getFlashUploadAllowedExtension()

setFlashUploadAllowedExtension

public void setFlashUploadAllowedExtension(String flashUploadAllowedExtension)

regexp for allowed flash upload file format

getFlashUploadDeniedExtension

public String getFlashUploadDeniedExtension()

setFlashUploadDeniedExtension

public void setFlashUploadDeniedExtension(String flashUploadDeniedExtension)

regexp for deinied flash upload file format

getImageUploadAllowedExtension

public String getImageUploadAllowedExtension()

setImageUploadAllowedExtension

public void setImageUploadAllowedExtension(String imageUploadAllowedExtension)

regexp for allowed image upload file format

getImageUploadDeniedExtension

public String getImageUploadDeniedExtension()

setImageUploadDeniedExtension

public void setImageUploadDeniedExtension(String imageUploadDeniedExtension)

regexp for denied image upload file format

getLinkUploadAllowedExtension

public String getLinkUploadAllowedExtension()

setLinkUploadAllowedExtension

public void setLinkUploadAllowedExtension(String linkUploadAllowedExtension)

regexp for allowed link upload file format

getLinkUploadDeniedExtension

public String getLinkUploadDeniedExtension()

setLinkUploadDeniedExtension

public void setLinkUploadDeniedExtension(String linkUploadDeniedExtension)

regexp for denied link upload file format

getSmileyImages

public String getSmileyImages()

setSmileyImages

public void setSmileyImages(String smileyImages)

js array of smilies files to be included

getSmileyPath

public String getSmileyPath()

setSmileyPath

public void setSmileyPath(String smileyPath)

path where smilies are located

getTemplatesXmlPath

public String getTemplatesXmlPath()

setTemplatesXmlPath

public void setTemplatesXmlPath(String templatesXmlPath)