com.silverpeas.form.displayers
Class CheckBoxDisplayer

java.lang.Object
  com.silverpeas.form.displayers.AbstractFieldDisplayer<TextField>
      com.silverpeas.form.displayers.CheckBoxDisplayer

All Implemented Interfaces:

FieldDisplayer<TextField>

public class CheckBoxDisplayer
extends AbstractFieldDisplayer<TextField>

A CheckBoxDisplayer is an object which can display a checkbox in HTML the content of a checkbox to a end user and can retrieve via HTTP any updated value.

See Also:

Field, FieldTemplate, Form, FieldDisplayer

Constructor Summary

CheckBoxDisplayer()
Constructeur

Method Summary

void	display(PrintWriter out, TextField field, FieldTemplate template, PagesContext PagesContext) Prints the HTML value of the field.
void	displayScripts(PrintWriter out, FieldTemplate template, PagesContext pagesContext) Prints the javascripts which will be used to control the new value given to the named field.
String[]	getManagedTypes() Returns the name of the managed types.
int	getNbHtmlObjectsDisplayed(FieldTemplate template, PagesContext pagesContext) Return the number of HTML Objects displayed by the displayer.
boolean	isDisplayedMandatory()
List<String>	update(List<org.apache.commons.fileupload.FileItem> items, TextField field, FieldTemplate template, PagesContext pageContext) Updates the value of the field.
List<String>	update(String values, TextField field, FieldTemplate template, PagesContext PagesContext) Updates the value of the field.

Methods inherited from class com.silverpeas.form.displayers.AbstractFieldDisplayer

index

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckBoxDisplayer

public CheckBoxDisplayer()

Constructeur

Method Detail

getManagedTypes

public String[] getManagedTypes()

Returns the name of the managed types.

Returns:

displayScripts

public void displayScripts(PrintWriter out,
                           FieldTemplate template,
                           PagesContext pagesContext)
                    throws IOException

Prints the javascripts which will be used to control the new value given to the named field. The error messages may be adapted to a local language. The FieldTemplate gives the field type and constraints. The FieldTemplate gives the local labeld too. Never throws an Exception but log a silvertrace and writes an empty string when :

• the fieldName is unknown by the template.
• the field type is not a managed type.

Parameters:

out -

template -

pagesContext -

Throws:

IOException

display

public void display(PrintWriter out,
                    TextField field,
                    FieldTemplate template,
                    PagesContext PagesContext)
             throws FormException

Prints the HTML value of the field. The displayed value must be updatable by the end user. The value format may be adapted to a local language. The fieldName must be used to name the html form input. Never throws an Exception but log a silvertrace and writes an empty string when :

• the field type is not a managed type.

Parameters:

out -

field -

template -

PagesContext -

Throws:

FormException

update

public List<String> update(List<org.apache.commons.fileupload.FileItem> items,
                           TextField field,
                           FieldTemplate template,
                           PagesContext pageContext)
                    throws FormException

Description copied from interface: FieldDisplayer

Updates the value of the field. The fieldName must be used to retrieve the HTTP parameter from the request. @throw FormException if the field type is not a managed type. @throw FormException if the field doesn't accept the new value.

Specified by:

update in interface FieldDisplayer<TextField>

Overrides:

update in class AbstractFieldDisplayer<TextField>

Returns:

Throws:

FormException

update

public List<String> update(String values,
                           TextField field,
                           FieldTemplate template,
                           PagesContext PagesContext)
                    throws FormException

Description copied from interface: FieldDisplayer

Updates the value of the field. The fieldName must be used to retrieve the HTTP parameter from the request. @throw FormException if the field type is not a managed type. @throw FormException if the field doesn't accept the new value.

Returns:

Throws:

FormException

isDisplayedMandatory

public boolean isDisplayedMandatory()

getNbHtmlObjectsDisplayed

public int getNbHtmlObjectsDisplayed(FieldTemplate template,
                                     PagesContext pagesContext)

Description copied from interface: FieldDisplayer

Return the number of HTML Objects displayed by the displayer.

Returns:

the number of HTML Objects displayed by the displayer.