e4s.html.input.extended
Interface E4Fieldset_Intf

All Superinterfaces:

E4HtmlElement_Intf

All Known Implementing Classes:

E4Fieldset, E4FieldsetTable

public interface E4Fieldset_Intf
extends E4HtmlElement_Intf

Interface for E4Fieldset elements.

Since:

JDK 1.4

See Also:

E4Fieldset

Method Summary

E4ID	E4ID() The E4ID is a unique application identifier for the whole E4Fieldset element.
void	enable(boolean mode) Enable/Disable this group
E4InputField_Intf	getField(E4InputFieldName_Intf fieldname) Get the associated object for the specified field.
E4Label_Intf	getGeneralErrorE4Message() Gets the general error message for the whole input-field.
E4Label_Intf	getLegend() Returns the caption for the whole input group
int	getSortOrder()
java.lang.String	getValue(E4InputFieldName_Intf fieldname) Get the value for the specified fieldname
boolean	getValueBool(E4InputFieldName_Intf fieldname) Get the value (as boolean) for the specified fieldname
java.util.Date	getValueDate(E4InputFieldName_Intf fieldname) Get the value for the specified fieldname
float	getValueFloat(E4InputFieldName_Intf fieldname) Get the value (as long) for the specified fieldname
long	getValueLong(E4InputFieldName_Intf fieldname) Get the value (as long) for the specified fieldname
boolean	hasAnyError() Returns true, if at least one of the field has an error message set
boolean	isActive() Return the activation status
boolean	isEnabled() Get the disable state
boolean	isFieldDefined(E4InputFieldName_Intf fieldname) Check, if the field is defined
void	setActive(boolean status) Set this input group as a whole active for input or not.
void	setErrorMessage(E4InputFieldName_Intf fieldname, E4Label_Intf error) Set an error message (error) for the specified field (fieldname) within this input group
void	setErrorMessage(E4InputFieldName_Intf fieldname, java.lang.String error) Set an error message (error) for the specified field (fieldname) within this input group
void	setGeneralErrorE4Message(E4Label_Intf error) Sets a general error message for the whole input-field.
void	setHelpId(java.lang.String helpid) Define the Help-Identification string (helpid) for the whole input group
void	setLegend(E4Label_Intf caption) Set the caption for the whole input group
void	setReadOnly() Sets all fields to read-only mode.
void	setReadOnly(boolean mode) Defines all fields as display only
void	setReadOnly(E4InputFieldName_Intf fieldname, boolean mode) Defines the field as display only
void	setSortOrder(int sortOrder)
void	setValue(E4CgiParams params) Sets the value of an input field by looking out in the parameter's collection.
void	setValue(E4InputFieldName_Intf fieldname, boolean value) Sets the value of an input field
void	setValue(E4InputFieldName_Intf fieldname, java.util.Date value) Sets the value of an input field
void	setValue(E4InputFieldName_Intf fieldname, float value) Sets the value of an input field
void	setValue(E4InputFieldName_Intf fieldname, long value) Sets the value of an input field
void	setValue(E4InputFieldName_Intf fieldname, java.lang.String value) Sets the value of an input field
void	setValue(E4ServletImplementation_Intf context) Read the CGI parameters (HTML values) and store them into the apropriate fields (defines their value)
void	storeEventHandler(E4EventHandlerInputField handler) Store input handlers for sub fields (e.g.
void	toHtml_active(E4StringBufferHtml buf, E4ServletImplementation_Intf servlet) This draws a visible form.
void	toHtml_hidden(E4StringBufferHtml buf, E4ServletImplementation_Intf servlet) This draws an INvisible form (all fields go hidden).
boolean	validate(E4ServletImplementation_Intf servlet) Validate all input fields within this input group.

Methods inherited from interface e4s.html.E4HtmlElement_Intf

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

Method Detail

setLegend

void setLegend(E4Label_Intf caption)

Set the caption for the whole input group

getLegend

E4Label_Intf getLegend()

Returns the caption for the whole input group

enable

void enable(boolean mode)

Enable/Disable this group

isEnabled

boolean isEnabled()

Get the disable state

getValue

java.lang.String getValue(E4InputFieldName_Intf fieldname)

Get the value for the specified fieldname

getValueDate

java.util.Date getValueDate(E4InputFieldName_Intf fieldname)
                            throws E4FieldNotFoundException

Get the value for the specified fieldname

Throws:

E4FieldNotFoundException

getValueLong

long getValueLong(E4InputFieldName_Intf fieldname)
                  throws E4FieldNotFoundException

Get the value (as long) for the specified fieldname

Throws:

E4FieldNotFoundException

getValueFloat

float getValueFloat(E4InputFieldName_Intf fieldname)
                    throws E4FieldNotFoundException

Get the value (as long) for the specified fieldname

Throws:

E4FieldNotFoundException

getValueBool

boolean getValueBool(E4InputFieldName_Intf fieldname)
                     throws E4FieldNotFoundException

Get the value (as boolean) for the specified fieldname

Throws:

E4FieldNotFoundException

setValue

void setValue(E4InputFieldName_Intf fieldname,
              java.lang.String value)

Sets the value of an input field

setValue

void setValue(E4InputFieldName_Intf fieldname,
              long value)
              throws java.lang.Exception

Sets the value of an input field

Throws:

java.lang.Exception

setValue

void setValue(E4InputFieldName_Intf fieldname,
              float value)
              throws java.lang.Exception

Sets the value of an input field

Throws:

java.lang.Exception

setValue

void setValue(E4InputFieldName_Intf fieldname,
              boolean value)

Sets the value of an input field

setValue

void setValue(E4InputFieldName_Intf fieldname,
              java.util.Date value)
              throws java.lang.Exception

Sets the value of an input field

Throws:

java.lang.Exception

setValue

void setValue(E4CgiParams params)

Sets the value of an input field by looking out in the parameter's collection.

Specified by:

setValue in interface E4HtmlElement_Intf

Parameters:

params - a collection of parameters, each field is defined by the unique field name

See Also:

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

isFieldDefined

boolean isFieldDefined(E4InputFieldName_Intf fieldname)

Check, if the field is defined

Parameters:

fieldname - the name of the field

Returns:

true, if the specified field is defined within this input group

getField

E4InputField_Intf getField(E4InputFieldName_Intf fieldname)

Get the associated object for the specified field.

Specified by:

getField in interface E4HtmlElement_Intf

Parameters:

fieldname - the name of the field

Returns:

the input field or null if not available

setErrorMessage

void setErrorMessage(E4InputFieldName_Intf fieldname,
                     java.lang.String error)

Set an error message (error) for the specified field (fieldname) within this input group

setErrorMessage

void setErrorMessage(E4InputFieldName_Intf fieldname,
                     E4Label_Intf error)

Set an error message (error) for the specified field (fieldname) within this input group

setGeneralErrorE4Message

void setGeneralErrorE4Message(E4Label_Intf error)

Sets a general error message for the whole input-field.

Parameters:

error - the error message

See Also:

hasAnyError(), getGeneralErrorE4Message()

getGeneralErrorE4Message

E4Label_Intf getGeneralErrorE4Message()

Gets the general error message for the whole input-field.

Returns:

null if no error, or the error message

See Also:

hasAnyError(), setGeneralErrorE4Message(e4s.translate.E4Label_Intf)

setReadOnly

void setReadOnly(E4InputFieldName_Intf fieldname,
                 boolean mode)

Defines the field as display only

setReadOnly

void setReadOnly(boolean mode)

Defines all fields as display only

Specified by:

setReadOnly in interface E4HtmlElement_Intf

Parameters:

mode - true sets the display-only mode

See Also:

E4InputField_Intf.setReadOnly()

setReadOnly

void setReadOnly()

Sets all fields to read-only mode.

See Also:

setReadOnly(boolean), E4InputField_Intf.setReadOnly()

hasAnyError

boolean hasAnyError()

Returns true, if at least one of the field has an error message set

setHelpId

void setHelpId(java.lang.String helpid)

Define the Help-Identification string (helpid) for the whole input group

validate

boolean validate(E4ServletImplementation_Intf servlet)
                 throws java.lang.Exception

Validate all input fields within this input group. Return true, if the validation completed successful

Throws:

java.lang.Exception

setValue

void setValue(E4ServletImplementation_Intf context)

Read the CGI parameters (HTML values) and store them into the apropriate fields (defines their value)

toHtml_hidden

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

This draws an INvisible form (all fields go hidden).

Specified by:

toHtml_hidden in interface E4HtmlElement_Intf

Parameters:

servlet - the context

Throws:

java.lang.Exception

See Also:

e4s.html.E4HtmlElement_Intf#toHtml( E4ServletImplementation_Intf ), #toHtml_active( E4ServletImplementation_Intf ), e4s.html.input.extended.E4InputField_Intf#toHtml_hidden( E4ServletImplementation_Intf )

toHtml_active

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

This draws a visible form.

Parameters:

servlet - the context

Throws:

java.lang.Exception

See Also:

e4s.html.E4HtmlElement_Intf#toHtml( E4ServletImplementation_Intf ), #toHtml_hidden( E4ServletImplementation_Intf )

setActive

void setActive(boolean status)

Set this input group as a whole active for input or not. Note that this is only possible and makes sense in the vanFIELDSETsSoliter container. The default shall be true always.

isActive

boolean isActive()

Return the activation status

setSortOrder

void setSortOrder(int sortOrder)

getSortOrder

int getSortOrder()

storeEventHandler

void storeEventHandler(E4EventHandlerInputField handler)

Store input handlers for sub fields (e.g. TEXTFIELD). Simliar to E4InputField_Intf.setEventHandler(e4s.html.input.extended.E4EventHandlerInputField)

Parameters:

handler - the E4EventHandler to be stored

See Also:

E4InputField_Intf.setEventHandler(e4s.html.input.extended.E4EventHandlerInputField)

E4ID

E4ID E4ID()

The E4ID is a unique application identifier for the whole E4Fieldset element. It is used to store the layout of fields related to this E4Fieldset.

Returns:

the associated E4ID