net.fckeditor
Class FCKeditor

java.lang.Object
  extended by net.fckeditor.FCKeditor

public class FCKeditor
extends java.lang.Object

FCKeditor control class.
It creates the html code for the FCKeditor based on the following things:

Version:
$Id: FCKeditor.java 1682 2008-03-05 17:27:06Z th-schwarz $

Constructor Summary
FCKeditor(javax.servlet.http.HttpServletRequest request, java.lang.String instanceName)
          Just a wrapper to FCKeditor.
FCKeditor(javax.servlet.http.HttpServletRequest request, java.lang.String instanceName, java.lang.String width, java.lang.String height, java.lang.String toolbarSet, java.lang.String value, java.lang.String basePath)
          Main constructor.
All important settings are done here and will be preset by there defaults taken from PropertiesLoader.
 
Method Summary
 java.lang.String create()
          Minimum implementation, see ticket #27 for detailed information.
 java.lang.String createHtml()
          Generate the HTML Code for the editor.
 FCKeditorConfig getConfig()
          Get the advanced configuation set.
Adding element to this collection you can override the settings specified in the config.js file.
 void setBasePath(java.lang.String value)
          Set the dir where the FCKeditor files reside on the server.
Remarks:
Avoid using relative paths.
 void setConfig(FCKeditorConfig value)
          Set the advanced configuation set.
 void setHeight(java.lang.String value)
          Set the height of the textarea
 void setInstanceName(java.lang.String value)
          Set the unique name of the editor
 void setToolbarSet(java.lang.String value)
          Set the name of the toolbar to display
 void setValue(java.lang.String value)
          Set the initial value to be edited.
In HTML code
 void setWidth(java.lang.String value)
          Set the width of the textarea
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FCKeditor

public FCKeditor(javax.servlet.http.HttpServletRequest request,
                 java.lang.String instanceName,
                 java.lang.String width,
                 java.lang.String height,
                 java.lang.String toolbarSet,
                 java.lang.String value,
                 java.lang.String basePath)
Main constructor.
All important settings are done here and will be preset by there defaults taken from PropertiesLoader.

Parameters:
request - request object
instanceName - unique name
width - width
height - height
toolbarSet - toolbarSet name

FCKeditor

public FCKeditor(javax.servlet.http.HttpServletRequest request,
                 java.lang.String instanceName)
Just a wrapper to FCKeditor.

Parameters:
request - request object
instanceName - unique name
Method Detail

setInstanceName

public void setInstanceName(java.lang.String value)
Set the unique name of the editor

Parameters:
value - name

setValue

public void setValue(java.lang.String value)
Set the initial value to be edited.
In HTML code

Parameters:
value - value

setBasePath

public void setBasePath(java.lang.String value)
Set the dir where the FCKeditor files reside on the server.
Remarks:
Avoid using relative paths. It is preferable to set the base path starting from the root (/).
Always finish the path with a slash (/).

Parameters:
value - path

setToolbarSet

public void setToolbarSet(java.lang.String value)
Set the name of the toolbar to display

Parameters:
value - toolbar name

setWidth

public void setWidth(java.lang.String value)
Set the width of the textarea

Parameters:
value - width

setHeight

public void setHeight(java.lang.String value)
Set the height of the textarea

Parameters:
value - height

getConfig

public FCKeditorConfig getConfig()
Get the advanced configuation set.
Adding element to this collection you can override the settings specified in the config.js file.

Returns:
configuration collection

setConfig

public void setConfig(FCKeditorConfig value)
Set the advanced configuation set.

Parameters:
value - configuration collection

create

public java.lang.String create()
Minimum implementation, see ticket #27 for detailed information.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

createHtml

public java.lang.String createHtml()
Generate the HTML Code for the editor.
Evalute the browser capabilities and generate the editor if compatible, or a simple textarea otherwise.

Returns:
html code


Copyright © 2004-2008 Frederico Caldeira Knabben. All Rights Reserved.