www.element4solution.com

e4s.html.input.extended
Class E4InputMultiState

java.lang.Object
  extended by e4s.util.E4Object
      extended by e4s.html.E4HtmlObject
          extended by e4s.html.E4HtmlElementGeneral
              extended by e4s.html.input.extended.E4FieldsetLayout
                  extended by e4s.html.input.extended.E4InputField
                      extended by e4s.html.input.extended.E4InputMultiState
All Implemented Interfaces:
E4FieldsetLayout_Intf, E4HtmlElement_Intf, E4InputField_Intf

public class E4InputMultiState
extends E4InputField
implements E4InputField_Intf

An input field (for <FORM>) elements representing an image for each value. The image changes each time the user clicks on that image.

Example_MultiState.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
 
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
E4InputMultiState(E4ID parent_id, E4InputFieldName_Intf name, E4InputMultiStateOptions selection)
          Construct an input field for the Multi-State element-
E4InputMultiState(E4ID parent_id, E4InputFieldName_Intf name, E4Label_Intf label, E4InputMultiStateOptions selection)
          Construct an input field for the Multi-State element-
E4InputMultiState(E4ID parent_id, E4InputFieldName_Intf name, java.lang.String label, E4InputMultiStateOptions selection)
          Construct an input field for the Multi-State element-
E4InputMultiState(E4InputFieldName_Intf name, E4InputMultiStateOptions selection)
          Construct an input field for the Multi-State element-
E4InputMultiState(E4InputFieldName_Intf name, E4Label_Intf label, E4InputMultiStateOptions selection)
          Construct an input field for the Multi-State element-
E4InputMultiState(E4InputFieldName_Intf name, java.lang.String label, E4InputMultiStateOptions selection)
          Construct an input field for the Multi-State element-
E4InputMultiState(E4InputMultiState field)
           
 
Method Summary
static java.lang.String _getSVNVersionString()
          Get version info string from subversion.
 void collectTranslationsForEditing(E4TranslationsVec translations, E4ServletImplementation_Intf servlet)
          Build a list (Vector) with translation texts used so far during display of this page.
 E4InputField_Intf duplicate()
           
 E4JavaScript getJsSet(E4ServletImplementation_Intf servlet)
           
 java.lang.String getValue()
           
 void setEventHandler(E4EventHandlerInputField handler)
           
 void setSTYLE(CLASS_Name class_name)
          Set the style for the input field.
 void toHtml(E4StringBufferHtml buf, E4ServletImplementation_Intf servlet)
          Create the HTML output for this element.
 
Methods inherited from class e4s.html.input.extended.E4InputField
addElement, AppendValidationE4Message, changeColumnName, collectStylesForEditing, 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, setHelpId, setHelpImage, setLabel, setMultipleTablerowsId, setReadOnly, setReadOnly, setReadOnly, 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, 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, setHelpId, setLabel, setMultipleTablerowsId, setReadOnly, setReadOnly, setValidator, setValue, 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, debugToString, findElement, findElement, getElements, getElementsVec, getField, getId, getStringContent, isContentClass, removeAll, removeElementById, removeElements, set_e4sID, setId, toHtml_hidden, validate
 

Constructor Detail

E4InputMultiState

public E4InputMultiState(E4ID parent_id,
                         E4InputFieldName_Intf name,
                         java.lang.String label,
                         E4InputMultiStateOptions selection)
Construct an input field for the Multi-State element-

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
selection - This Vector of objects from type OPTION is used to display the different options for the list. Each option consists of two values: the option value itself, and [optional] a different String for display purposes. The class OPTION is a inner class defined here.

E4InputMultiState

public E4InputMultiState(E4InputFieldName_Intf name,
                         java.lang.String label,
                         E4InputMultiStateOptions selection)
Construct an input field for the Multi-State element-

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
selection - This Vector of objects from type OPTION is used to display the different options for the list. Each option consists of two values: the option value itself, and [optional] a different String for display purposes. The class OPTION is a inner class defined here.

E4InputMultiState

public E4InputMultiState(E4ID parent_id,
                         E4InputFieldName_Intf name,
                         E4Label_Intf label,
                         E4InputMultiStateOptions selection)
Construct an input field for the Multi-State element-

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
selection - This Vector of objects from type OPTION is used to display the different options for the list. Each option consists of two values: the option value itself, and [optional] a different String for display purposes. The class OPTION is a inner class defined here.

E4InputMultiState

public E4InputMultiState(E4InputFieldName_Intf name,
                         E4Label_Intf label,
                         E4InputMultiStateOptions selection)
Construct an input field for the Multi-State element-

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
selection - This Vector of objects from type OPTION is used to display the different options for the list. Each option consists of two values: the option value itself, and [optional] a different String for display purposes. The class OPTION is a inner class defined here.

E4InputMultiState

public E4InputMultiState(E4ID parent_id,
                         E4InputFieldName_Intf name,
                         E4InputMultiStateOptions selection)
Construct an input field for the Multi-State element-

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.
selection - This Vector of objects from type OPTION is used to display the different options for the list. Each option consists of two values: the option value itself, and [optional] a different String for display purposes. The class OPTION is a inner class defined here.

E4InputMultiState

public E4InputMultiState(E4InputFieldName_Intf name,
                         E4InputMultiStateOptions selection)
Construct an input field for the Multi-State element-

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.
selection - This Vector of objects from type OPTION is used to display the different options for the list. Each option consists of two values: the option value itself, and [optional] a different String for display purposes. The class OPTION is a inner class defined here.

E4InputMultiState

public E4InputMultiState(E4InputMultiState field)
Method Detail

getJsSet

public E4JavaScript getJsSet(E4ServletImplementation_Intf servlet)

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

getValue

public java.lang.String getValue()

setSTYLE

public void setSTYLE(CLASS_Name class_name)
Description copied from class: E4InputField
Set the style for the input field. Note, that an input field can be disabled (E4InputField.getReadOnly() and therefore, two styles (classes) are required: one for the active case and one for the in-active (disabled) case. This function sets both classes, so disabling the field would make no visual difference for the display GUI.

Overrides:
setSTYLE in class E4InputField
See Also:
E4InputField.setSTYLE( e4s.html.style.CLASS_Name, e4s.html.style.CLASS_Name ), E4InputField.getSTYLE()

collectTranslationsForEditing

public void collectTranslationsForEditing(E4TranslationsVec translations,
                                          E4ServletImplementation_Intf servlet)
Description copied from class: E4HtmlElementGeneral
Build a list (Vector) with translation texts used so far during display of this page. Run throught all subclasses elements and collect their texts as well. Note, that a text will only be added one time. The Vector contains elements of class E4Label.

Specified by:
collectTranslationsForEditing in interface E4HtmlElement_Intf
Overrides:
collectTranslationsForEditing in class E4InputField
Parameters:
translations - the Vector where the styles will be collected, may not be null
servlet - the current servlet instance
See Also:
E4Label_Intf

duplicate

public E4InputField_Intf duplicate()
Specified by:
duplicate in interface E4InputField_Intf

setEventHandler

public void setEventHandler(E4EventHandlerInputField handler)
Specified by:
setEventHandler in interface E4InputField_Intf
Overrides:
setEventHandler in class E4InputField

_getSVNVersionString

public static java.lang.String _getSVNVersionString()
Get version info string from subversion.

Returns:
the version info string.
See Also:
E4Util.getRevisionCodeFromSVN(Class)

www.element4solution.com