com.arsdigita.bebop.form
Class DHTMLEditor

java.lang.Object
  extended bycom.arsdigita.bebop.Completable
      extended bycom.arsdigita.bebop.SimpleComponent
          extended bycom.arsdigita.bebop.TextStylable
              extended bycom.arsdigita.bebop.BlockStylable
                  extended bycom.arsdigita.bebop.form.Widget
                      extended bycom.arsdigita.bebop.form.TextArea
                          extended bycom.arsdigita.bebop.form.DHTMLEditor
All Implemented Interfaces:
BebopConstants, Cloneable, Component, Lockable

public class DHTMLEditor
extends TextArea

Displays and manages a WYSIWYG HTML editor that takes advantage of DHTML scripting features. This class uses the open source HTMLArea editor: http://women.cs.uiuc.edu/htmlarea/.

Version:
$Id: //core-platform/dev/src/com/arsdigita/bebop/form/DHTMLEditor.java#11 $
Author:
Jim Parsons, Richard Li

Nested Class Summary
static class DHTMLEditor.Config
           
 
Nested classes inherited from class com.arsdigita.bebop.form.Widget
Widget.ValidationGuard
 
Field Summary
static int HARD
          Constant for specifying HARD value for the WRAP attribute of this image input.
static int OFF
          Constant for specifying OFF value for the WRAP attribute of this image input.
static int SOFT
          Constant for specifying SOFT value for the WRAP attribute of this image input.
static String versionId
           
 
Fields inherited from class com.arsdigita.bebop.BlockStylable
ABSBOTTOM, ABSMIDDLE, BASELINE, BOTTOM, CENTER, FULL_WIDTH, INSERT, LEFT, MIDDLE, RIGHT, TEXTTOP, TOP
 
Fields inherited from class com.arsdigita.bebop.SimpleComponent
m_attr
 
Fields inherited from interface com.arsdigita.bebop.util.BebopConstants
BEBOP_BORDER, BEBOP_BOXPANEL, BEBOP_CELL, BEBOP_CHECKBOX, BEBOP_CHECKBOXGROUP, BEBOP_COLUMNPANEL, BEBOP_DATE, BEBOP_DATETIME, BEBOP_DHTMLEDITOR, BEBOP_FORMERRORS, BEBOP_FORMWIDGET, BEBOP_GRIDPANEL, BEBOP_LIST, BEBOP_MULTISELECT, BEBOP_OPTION, BEBOP_PAD, BEBOP_PADFRAME, BEBOP_PANELROW, BEBOP_PORTAL, BEBOP_PORTLET, BEBOP_RADIO, BEBOP_RADIOGROUP, BEBOP_SEG_BODY, BEBOP_SEG_HEADER, BEBOP_SEG_PANEL, BEBOP_SEGMENT, BEBOP_SELECT, BEBOP_TABLE, BEBOP_TABLEBODY, BEBOP_TABLEROW, BEBOP_TEXTAREA
 
Fields inherited from interface com.arsdigita.bebop.Component
BEBOP_XML_NS, CLASS, ID, ON_CLICK, STYLE
 
Constructor Summary
DHTMLEditor(ParameterModel model)
           
DHTMLEditor(ParameterModel model, DHTMLEditor.Config config)
           
DHTMLEditor(String name)
           
 
Method Summary
 void addPlugin(String name)
           
 void generateWidget(PageState state, Element parent)
          Generates the DOM for the DHTML editor widget
protected  String getElementTag()
          The XML tag.
 String getType()
          Returns a string naming the type of this widget.
 void setCols(int cols)
          Sets the COLS attribute for the TEXTAREA tag.
 void setConfig(String config)
           
 void setRows(int rows)
          Sets the ROWS attribute for the TEXTAREA tag.
 void setWrap(int wrap)
          Sets the COLS attribute for the TEXTAREA tag.
 
Methods inherited from class com.arsdigita.bebop.form.TextArea
isCompound, setValue
 
Methods inherited from class com.arsdigita.bebop.form.Widget
addError, addError, addPrintListener, addValidationListener, clone, createParameterListener, firePrintEvent, fireValidation, generateErrors, generateXML, getDefaultValue, getErrors, getForm, getName, getParameterData, getParameterModel, getValue, isPassIn, register, removePrintListener, removeValidationListener, respond, setDefaultValue, setDisabled, setForm, setHint, setOnBlur, setOnChange, setOnFocus, setOnKeyUp, setOnSelect, setParameterModel, setPassIn, setPrintListener, setReadOnly, setValidateInvisible, setValidationGuard, setValue, toString, validateInvisible
 
Methods inherited from class com.arsdigita.bebop.BlockStylable
setBorder, setBorder, setBorderColor, setHorizontalAlignment, setMargin, setMargin, setPadding, setPadding, setVerticalAlignment
 
Methods inherited from class com.arsdigita.bebop.TextStylable
setBackgroundColor, setColor
 
Methods inherited from class com.arsdigita.bebop.SimpleComponent
children, exportAttributes, getAttribute, getClassAttr, getIdAttr, getKey, getMetaDataAttribute, getStyleAttr, hasAttributes, isLocked, isVisible, lock, register, setAttribute, setClassAttr, setIdAttr, setKey, setMetaDataAttribute, setStyleAttr, setVisible
 
Methods inherited from class com.arsdigita.bebop.Completable
addCompletionListener, fireCompletionEvent
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

OFF

public static final int OFF
Constant for specifying OFF value for the WRAP attribute of this image input. See here for a description of what this attribute does.

See Also:
Constant Field Values

HARD

public static final int HARD
Constant for specifying HARD value for the WRAP attribute of this image input. * See here for a description of what this attribute does.

See Also:
Constant Field Values

SOFT

public static final int SOFT
Constant for specifying SOFT value for the WRAP attribute of this image input. See here for a description of what this attribute does.

See Also:
Constant Field Values
Constructor Detail

DHTMLEditor

public DHTMLEditor(String name)

DHTMLEditor

public DHTMLEditor(ParameterModel model)

DHTMLEditor

public DHTMLEditor(ParameterModel model,
                   DHTMLEditor.Config config)
Method Detail

getType

public String getType()
Returns a string naming the type of this widget.

Overrides:
getType in class TextArea

setConfig

public void setConfig(String config)

addPlugin

public void addPlugin(String name)

setRows

public void setRows(int rows)
Sets the ROWS attribute for the TEXTAREA tag.

Overrides:
setRows in class TextArea

setCols

public void setCols(int cols)
Sets the COLS attribute for the TEXTAREA tag.

Overrides:
setCols in class TextArea

setWrap

public void setWrap(int wrap)
Sets the COLS attribute for the TEXTAREA tag.

Overrides:
setWrap in class TextArea

getElementTag

protected String getElementTag()
The XML tag.

Overrides:
getElementTag in class TextArea
Returns:
The tag to be used for the top level DOM element generated for this type of Widget.

generateWidget

public void generateWidget(PageState state,
                           Element parent)
Generates the DOM for the DHTML editor widget

Generates DOM fragment:

<bebop:dhtmleditor name=... value=... [onXXX=...]/>

Overrides:
generateWidget in class TextArea


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC