e4s.html.input.extended
Class CHECKBOX

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.CHECKBOX

All Implemented Interfaces:

E4FieldsetLayout_Intf, E4HtmlElement_Intf, E4InputField_Intf

public class CHECKBOX
extends E4InputField
implements E4InputField_Intf

An input field (for <FORM>) element representing a boolean value. The grafical representation of this field will be a checkbox.

Example_CHECKBOX.java

Example_InputForm.java

Since:

JDK 1.4

See Also:

FORM

Nested Class Summary

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

E4InputField.A_PICK

Field Summary

static char	LABEL_POSITION_ABOVE Print the label above the checkbox (requires embedding in a table).
static char	LABEL_POSITION_LEFT Print the label left before the checkbox.
static char	LABEL_POSITION_RIGHT Print the label right following the checkbox.

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

CHECKBOX(CHECKBOX field)
Construct a checkbox input field.

CHECKBOX(E4ID parent_id, E4InputFieldName_Intf name)
Construct a checkbox input field without a label.

CHECKBOX(E4ID parent_id, E4InputFieldName_Intf name, E4Label_Intf label)
Construct a checkbox input field.

CHECKBOX(E4ID parent_id, E4InputFieldName_Intf name, java.lang.String label)
Construct a checkbox input field.

CHECKBOX(E4InputFieldName_Intf name)
Construct a checkbox input field without a label.

CHECKBOX(E4InputFieldName_Intf name, E4Label_Intf label)
Construct a checkbox input field.

CHECKBOX(E4InputFieldName_Intf name, java.lang.String label)
Construct a checkbox input field.

Method Summary

static java.lang.String	_getSVNVersionString() Get version info string from subversion.
E4InputField_Intf	duplicate()
E4InputFieldName_Intf	getColumnName(boolean changed_name_if_readonly)
char	getLabelPosition() Get the label's position.
boolean	getValue() Get the value of this input field.
void	setLabelPosition(char position) Set's the label's position.
void	setValue(E4CgiParams params) Look in the parameter list, and if the HTML-fieldname matches one of the parameters, assign it as String.
void	toHtml_drawSimpleReport(java.lang.StringBuffer buf, E4ServletImplementation_Intf servlet, java.lang.String value, boolean printing)
void	toHtml(E4StringBufferHtml buf, E4ServletImplementation_Intf servlet) Create the HTML output for this element.
void	toHtml(E4StringBufferHtml buf, E4ServletImplementation_Intf context, java.lang.String formelement)

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, getValue_native, 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, setVisible, toHIDDENFIELD, toHtml_drawSimpleReport, toHtml_drawSimpleReport, toHtml_drawSimpleReport, toHtml_hidden, toString, updatePersistantLayout, validate, 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, setVisible, toHIDDENFIELD, toHtml_drawSimpleReport, toHtml_drawSimpleReport, validate, 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

LABEL_POSITION_LEFT

public static final char LABEL_POSITION_LEFT

Print the label left before the checkbox.

See Also:

setLabelPosition(char), LABEL_POSITION_RIGHT, LABEL_POSITION_ABOVE, Constant Field Values

LABEL_POSITION_RIGHT

public static final char LABEL_POSITION_RIGHT

Print the label right following the checkbox.

See Also:

setLabelPosition(char), LABEL_POSITION_LEFT, LABEL_POSITION_ABOVE, Constant Field Values

LABEL_POSITION_ABOVE

public static final char LABEL_POSITION_ABOVE

Print the label above the checkbox (requires embedding in a table).

See Also:

setLabelPosition(char), LABEL_POSITION_LEFT, LABEL_POSITION_RIGHT, Constant Field Values

Constructor Detail

CHECKBOX

public CHECKBOX(E4ID parent_id,
                E4InputFieldName_Intf name,
                java.lang.String label)

Construct a checkbox input field.

Parameters:

name - name of the input field

label - label for display

CHECKBOX

public CHECKBOX(E4InputFieldName_Intf name,
                java.lang.String label)

Construct a checkbox input field.

Parameters:

name - name of the input field

label - label for display

CHECKBOX

public CHECKBOX(CHECKBOX field)

Construct a checkbox input field.

Parameters:

field - the CHECKBOX to be copied from.

CHECKBOX

public CHECKBOX(E4ID parent_id,
                E4InputFieldName_Intf name,
                E4Label_Intf label)

Construct a checkbox input field.

Parameters:

name - name of the input field

label - label for display

CHECKBOX

public CHECKBOX(E4InputFieldName_Intf name,
                E4Label_Intf label)

Construct a checkbox input field.

Parameters:

name - name of the input field

label - label for display

CHECKBOX

public CHECKBOX(E4ID parent_id,
                E4InputFieldName_Intf name)

Construct a checkbox input field without a label.

Parameters:

name - name of the input field

CHECKBOX

public CHECKBOX(E4InputFieldName_Intf name)

Construct a checkbox input field without a label.

Parameters:

name - name of the input field

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 E4HtmlElementGeneral

servlet - the servlet environment currently running in

Throws:

java.lang.Exception

toHtml

public void toHtml(E4StringBufferHtml buf,
                   E4ServletImplementation_Intf context,
                   java.lang.String formelement)
            throws java.lang.Exception

Overrides:

toHtml in class E4InputField

Throws:

java.lang.Exception

getValue

public boolean getValue()

Get the value of this input field.

Returns:

the value

See Also:

E4InputField.setValue(java.lang.String), setValue(e4s.html.E4CgiParams)

toHtml_drawSimpleReport

public void toHtml_drawSimpleReport(java.lang.StringBuffer buf,
                                    E4ServletImplementation_Intf servlet,
                                    java.lang.String value,
                                    boolean printing)

setValue

public void setValue(E4CgiParams params)

Description copied from class: E4InputField

Look in the parameter list, and if the HTML-fieldname matches one of the parameters, assign it as String. Dangerous for Date, long, boolean input elements which should implement their own version including necessary conversions.

Specified by:

setValue in interface E4HtmlElement_Intf

Specified by:

setValue in interface E4InputField_Intf

Overrides:

setValue in class E4InputField

Parameters:

params - the whole parameter list

See Also:

E4InputField_Intf.setValue(e4s.html.E4CgiParams), #validate(e4s.html.E4CgiParams)

getLabelPosition

public char getLabelPosition()

Get the label's position.

Returns:

LABEL_POSITION_RIGHT or LABEL_POSITION_ABOVE

See Also:

setLabelPosition(char)

setLabelPosition

public void setLabelPosition(char position)

Set's the label's position.

Parameters:

position - LABEL_POSITION_RIGHT or LABEL_POSITION_ABOVE

See Also:

getLabelPosition(), LABEL_POSITION_ABOVE, LABEL_POSITION_RIGHT

duplicate

public E4InputField_Intf duplicate()

Specified by:

duplicate in interface E4InputField_Intf

getColumnName

public E4InputFieldName_Intf getColumnName(boolean changed_name_if_readonly)

_getSVNVersionString

public static java.lang.String _getSVNVersionString()

Get version info string from subversion.

Returns:

the version info string.

See Also:

E4Util.getRevisionCodeFromSVN(Class)