com.arsdigita.bebop.form
Class TextArea

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
All Implemented Interfaces:
BebopConstants, Cloneable, Component, Lockable
Direct Known Subclasses:
DHTMLEditor

public class TextArea
extends Widget
implements BebopConstants

A class representing a textarea field in an HTML form.

Version:
$Id: //core-platform/dev/src/com/arsdigita/bebop/form/TextArea.java#8 $
Author:
Karl Goldstein, Uday Mathur, Rory Solomon, Michael Pih

Nested Class Summary
 
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
TextArea(ParameterModel model)
           
TextArea(ParameterModel model, int rows, int cols, int wrap)
          Convenience constructor
TextArea(String name)
           
TextArea(String name, int rows, int cols, int wrap)
          Convenience constructor
 
Method Summary
 void generateWidget(PageState state, Element parent)
          Generates the DOM for the textarea widget
protected  String getElementTag()
          The XML tag.
 String getType()
          Returns a string naming the type of this widget.
 boolean isCompound()
          Is this a compound widget?
 void setCols(int cols)
          Sets the COLS attribute for the TEXTAREA tag.
 void setRows(int rows)
          Sets the ROWS attribute for the TEXTAREA tag.
 void setValue(String text)
          Deprecated. [since 17Aug2001] use Widget.setDefaultValue(Object)
 void setWrap(int wrap)
          Sets the COLS attribute for the TEXTAREA tag.
 
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

TextArea

public TextArea(String name)

TextArea

public TextArea(ParameterModel model)

TextArea

public TextArea(String name,
                int rows,
                int cols,
                int wrap)
Convenience constructor


TextArea

public TextArea(ParameterModel model,
                int rows,
                int cols,
                int wrap)
Convenience constructor

Method Detail

getType

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

Specified by:
getType in class Widget

setRows

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


setCols

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


setWrap

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


setValue

public void setValue(String text)
Deprecated. [since 17Aug2001] use Widget.setDefaultValue(Object)

Set the default value (text)


isCompound

public boolean isCompound()
Is this a compound widget?

Specified by:
isCompound in class Widget
Returns:
false

getElementTag

protected String getElementTag()
The XML tag.

Overrides:
getElementTag in class Widget
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 textarea widget

Generates DOM fragment:

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

Overrides:
generateWidget in class Widget


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