e4s.html.input.extended
Class TEXTAREA

java.lang.Object
  e4s.util.E4Object
      e4s.html.E4HtmlObject
          e4s.html.E4HtmlElementGeneral
              e4s.html.input.extended.E4FieldsetLayout
                  e4s.html.input.extended.E4InputField
                      e4s.html.input.extended.TEXTFIELD
                          e4s.html.input.extended.TEXTAREA

All Implemented Interfaces:

E4FieldsetLayout_Intf, E4HtmlElement_Intf, E4InputField_Intf

public class TEXTAREA
extends TEXTFIELD
implements E4InputField_Intf

An input field (for <FORM>) elements representing a multi line text input value.

Example_InputForm.java

Since:

JDK 1.4

See Also:

TEXTFIELD, DATEFIELD, LONGFIELD, FLOATFIELD, FORM

Nested Class Summary

static class

TEXTAREA.OPTIMALSIZE Holds the optimal size for a TEXTAREA.

Nested classes/interfaces inherited from class e4s.html.input.extended.E4InputField

E4InputField.A_PICK

Field Summary

static int

TEXTAREA_MAXLENGTH This is the maximum size for an textarea, when the setLengthMax() has been called.

Fields inherited from class e4s.html.input.extended.TEXTFIELD

m_displaylength, m_inputlength, m_uppercase

Fields inherited from class e4s.html.input.extended.E4InputField

BGCOLOR_READONLY, HTML_TAG, m_helpid, m_label, m_multiple_tablerows_id, m_name, m_pickup_ref, m_readonly, m_show_label, m_style_active, m_style_inactive, m_validation_object, m_validationmessage, m_value, m_visible, ms_help_image, PICKUP_IMAGE_NAME_PREFIX

Fields inherited from class e4s.html.E4HtmlElementGeneral

m_elements, m_needed_scripts

Fields inherited from class e4s.html.E4HtmlObject

m_parent_e4sID

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

TEXTAREA(E4ID parent_id, E4DBColumnInfo name, E4Label_Intf label)
Construct a multi line text input field (<TEXTAREA>).

TEXTAREA(E4ID parent_id, E4DBColumnInfo name, java.lang.String label)
Construct a multi line text input field (<TEXTAREA>).

TEXTAREA(E4ID parent_id, E4InputFieldName_Intf name, E4Label_Intf label, int cols, int rows)
Construct a multi line text input field (<TEXTAREA>).

TEXTAREA(E4ID parent_id, E4InputFieldName_Intf name, java.lang.String label, int cols, int rows)
Construct a multi line text input field (<TEXTAREA>).

TEXTAREA(TEXTAREA field)

Method Summary

static java.lang.String	_getSVNVersionString() Get version info string from subversion.
E4InputField_Intf	duplicate()
int	getCols() Get the number of cols.
int	getLength() Get the display length.
int	getLengthDisplay() Same as getLength()
int	getLengthMaxInput() Same as getLength()
static TEXTAREA.OPTIMALSIZE	getOPTIMALSIZE(int field_len) Find best fitting size, near or less than length.
int	getRows() Get the number of rows.
void	setCols(int cols) Set the number of cols.
void	setLength(int limit) Normally, the number of characters will be validated against getRows() x getCols(), except when this function was called.
void	setLengthLayout() Validate the maximum numbers of characters to the layout lengthm getRows() x getCols().
void	setLengthMax() Normally, the number of characters will be validated against getRows() x getCols(), except when this function was called.
void	setRows(int rows) Set the number of rows.
void	toHtml(E4StringBufferHtml buf, E4ServletImplementation_Intf servlet) Create the HTML output for this element.
boolean	validate() If a validation function is declared, then it is called and any String result returning from this validation function indicates that something with the field went wrong, and the return value will be false.

Methods inherited from class e4s.html.input.extended.TEXTFIELD

addAjaxChanger, getValue_native, getValue, setToUppercase

Methods inherited from class e4s.html.input.extended.E4InputField

addElement, AppendValidationE4Message, changeColumnName, collectStylesForEditing, collectTranslationsForEditing, debugToString, definePickupList, definePickupList, definePickupList, definePickupList, definePickupList, definePickupList, definePickupList, display_simpleReport, E4ID, equalsIgnoreCase, eventHandlers, getCanChangeLayout, getColumnName, getErrorMessage, getEventHandlers, getHelpId, getHtmlParamName, getLabel, getMultipleTablerowsId, getPersistant, getPersistantLayout, getPickupList, getReadOnly, getSTYLE, getSTYLE, getValidator, hideLabel, HtmlEncode, isHiddenField, isMandatory, isVisible, onChange, onChange, onChange, onClick, removePickupList, resetValidation, setCanChangeLayout, setErrorMessage, setErrorMessage, setEventHandler, setHelpId, setHelpImage, setLabel, setMultipleTablerowsId, setReadOnly, setReadOnly, setReadOnly, setSTYLE, setSTYLE, setValidation, setValidator, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVisible, toHIDDENFIELD, toHtml_drawSimpleReport, toHtml_drawSimpleReport, toHtml_drawSimpleReport, toHtml_hidden, toHtml, toString, updatePersistantLayout, validate, validate

Methods inherited from class e4s.html.input.extended.E4FieldsetLayout

isNextRow, layoutToNextRow

Methods inherited from class e4s.html.E4HtmlElementGeneral

addScript, addScript, addScript, addStyleForEditing, addTranslationForEditing, buildStyleAttribute, buildStyleClassReference, collectScripts, collectStylesForEditing, collectStylesForEditing, collectTranslationsForEditing, createScript, createScript, findElement, findElement, findElement, findElement, getElements, getElementsVec, getField, getId, getLastElement, getStringContent, getStyle, getStyle, hasScripts, hasSTYLE, isContentClass, isE4InputField_Intf, openTag, removeAll, removeElementById, removeElements, removeElements, removeStyle, setId, setStyle, setStyle, setSTYLE, Style, Style

Methods inherited from class e4s.html.E4HtmlObject

E4ID, set_e4sID

Methods inherited from class e4s.util.E4Object

Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait

Methods inherited from class java.lang.Object

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

Methods inherited from interface e4s.html.input.extended.E4InputField_Intf

changeColumnName, definePickupList, definePickupList, display_simpleReport, equalsIgnoreCase, eventHandlers, getCanChangeLayout, getColumnName, getErrorMessage, getHtmlParamName, getLabel, getMultipleTablerowsId, getPickupList, getReadOnly, getValue_native, hideLabel, isHiddenField, isMandatory, isVisible, resetValidation, setCanChangeLayout, setErrorMessage, setErrorMessage, setEventHandler, setHelpId, setLabel, setMultipleTablerowsId, setReadOnly, setReadOnly, setValidator, setValue, setValue, setValue, setValue, setValue, setVisible, toHIDDENFIELD, toHtml_drawSimpleReport, toHtml_drawSimpleReport, validate

Methods inherited from interface e4s.html.E4FieldsetLayout_Intf

isNextRow, layoutToNextRow

Methods inherited from interface e4s.html.E4HtmlElement_Intf

addScript, addScript, addScript, collectScripts, collectStylesForEditing, collectTranslationsForEditing, debugToString, findElement, findElement, getElements, getElementsVec, getField, getId, getStringContent, isContentClass, removeAll, removeElementById, removeElements, set_e4sID, setId, toHtml_hidden, validate

Field Detail

TEXTAREA_MAXLENGTH

public static int TEXTAREA_MAXLENGTH

This is the maximum size for an textarea, when the setLengthMax() has been called. The limitation might be relevant for some databases or to avoid exceeding large data blocks. You might change this value in your application, but please note that such a change would also effect all other TEXTAREA inputs used in the e4s system environment. We recommend no change at this point.

Constructor Detail

TEXTAREA

public TEXTAREA(E4ID parent_id,
                E4InputFieldName_Intf name,
                java.lang.String label,
                int cols,
                int rows)

Construct a multi line text input field (<TEXTAREA>). Note: input is limited to 255 characters

Parameters:

name - HTML (CGI) name of the input field. The input field is treatened by this name, and a value can be retrieved throught the E4CgiParams class using this name.

label - E4Label to be displayed on the screen during input

cols - the number of columns (>= 1)

rows - the number of rows (>= 1)

TEXTAREA

public TEXTAREA(TEXTAREA field)

TEXTAREA

public TEXTAREA(E4ID parent_id,
                E4InputFieldName_Intf name,
                E4Label_Intf label,
                int cols,
                int rows)

Construct a multi line text input field (<TEXTAREA>). Note: input is limited to 255 characters

Parameters:

name - HTML (CGI) name of the input field. The input field is treatened by this name, and a value can be retrieved throught the E4CgiParams class using this name.

label - E4Label to be displayed on the screen during input

cols - the number of columns (>= 1)

rows - the number of rows (>= 1)

TEXTAREA

public TEXTAREA(E4ID parent_id,
                E4DBColumnInfo name,
                java.lang.String label)

Construct a multi line text input field (<TEXTAREA>).

Parameters:

name - a column information object, containing the name of the field, datatype and length.

label - E4Label to be displayed on the screen during input

TEXTAREA

public TEXTAREA(E4ID parent_id,
                E4DBColumnInfo name,
                E4Label_Intf label)

Construct a multi line text input field (<TEXTAREA>).

Parameters:

name - a column information object, containing the name of the field, datatype and length.

label - E4Label to be displayed on the screen during input

Method Detail

toHtml

public void toHtml(E4StringBufferHtml buf,
                   E4ServletImplementation_Intf servlet)
            throws java.lang.Exception

Description copied from interface: E4HtmlElement_Intf

Create the HTML output for this element. Also run throught all child elements, and call their E4HtmlElement_Intf.toHtml(e4s.util.E4StringBufferHtml, e4s.servlet.E4ServletImplementation_Intf) function to generate output of those objects which becomes appended. Normally, there is no need to call this function anyway, and this also might result in side effects of too-early relasing of objects in some cases. This function is called by E4ServletImplementation_Intf.write(e4s.html.E4HtmlElement) on the top level HTML element (common this is a HTML or BODY element) and branches down to all child elements.

Specified by:

toHtml in interface E4HtmlElement_Intf

Specified by:

toHtml in interface E4InputField_Intf

Overrides:

toHtml in class TEXTFIELD

servlet - the servlet environment currently running in

Throws:

java.lang.Exception

validate

public boolean validate()
                 throws java.lang.Exception

Description copied from class: E4InputField

If a validation function is declared, then it is called and any String result returning from this validation function indicates that something with the field went wrong, and the return value will be false. This indication is stored in the m_validationmessage variable for further use. Only visible fields are validated (see E4InputField.isVisible()).

Specified by:

validate in interface E4InputField_Intf

Overrides:

validate in class E4InputField

Returns:

true, if everything is o.k.

Throws:

java.lang.Exception

See Also:

#setValidation(Object,String), E4InputField_Intf.setErrorMessage(String), E4InputField_Intf.getErrorMessage()

setLengthMax

public void setLengthMax()

Normally, the number of characters will be validated against getRows() x getCols(), except when this function was called. After calling this function, the length is restricted to the system maximum which is TEXTAREA_MAXLENGTH.

See Also:

TEXTAREA_MAXLENGTH, setLength(int), getLength(), setLengthLayout()

setLength

public void setLength(int limit)

Normally, the number of characters will be validated against getRows() x getCols(), except when this function was called. After calling this function, the length is restricted to the given parameter.

Parameters:

limit - maximum number of characters, a value of -1 indicates that the layout rows x cols shall be used which equals a call to setLengthLayout()

See Also:

TEXTAREA_MAXLENGTH, setLengthLayout(), getLength(), setLengthMax()

setLengthLayout

public void setLengthLayout()

Validate the maximum numbers of characters to the layout lengthm getRows() x getCols().

See Also:

setLength(int), getLength(), setLengthMax()

getLength

public int getLength()

Get the display length.

Returns:

the maximum number of characters that can be entered into the TEXTAREA

See Also:

getRows(), getCols(), setLength(int)

getLengthMaxInput

public int getLengthMaxInput()

Same as getLength()

Overrides:

getLengthMaxInput in class TEXTFIELD

See Also:

getLength()

getLengthDisplay

public int getLengthDisplay()

Same as getLength()

Overrides:

getLengthDisplay in class TEXTFIELD

See Also:

getLength()

getOPTIMALSIZE

public static TEXTAREA.OPTIMALSIZE getOPTIMALSIZE(int field_len)

Find best fitting size, near or less than length. This function tries to get the best row/column match that is less or equal than length, rows are between 2 and 6 and columns between 40 and 60. If no result, than rows = 1 and cols = field length.

Parameters:

field_len - the length for the field, should be >= 80 and <= 255

Returns:

rows/columns best fitting

See Also:

setRows(int), setCols(int)

getRows

public int getRows()

Get the number of rows.

See Also:

getCols(), setRows(int), setLength(int)

getCols

public int getCols()

Get the number of cols.

See Also:

getRows(), setCols(int), setLength(int)

setRows

public void setRows(int rows)

Set the number of rows.

Parameters:

rows - number of rows

See Also:

getRows(), setCols(int), setLength(int)

setCols

public void setCols(int cols)

Set the number of cols.

Parameters:

cols - number of cols

See Also:

getCols(), setRows(int), setLength(int)

duplicate

public E4InputField_Intf duplicate()

Specified by:

duplicate in interface E4InputField_Intf

Overrides:

duplicate in class TEXTFIELD

_getSVNVersionString

public static java.lang.String _getSVNVersionString()

Get version info string from subversion.

Returns:

the version info string.

See Also:

E4Util.getRevisionCodeFromSVN(Class)