Package org.silverpeas.core.contribution.content.form.form

Class XmlSearchForm

java.lang.Object

org.silverpeas.core.contribution.content.form.AbstractForm

org.silverpeas.core.contribution.content.form.form.XmlSearchForm

All Implemented Interfaces:

Form

public class XmlSearchForm
extends AbstractForm

A Form is an object which can display in HTML the content of a DataRecord to a end user and can retrieve via HTTP any updated values.

See Also:

DataRecord, RecordTemplate, FieldDisplayer

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXTRA_FIELD_PERIOD
static String	EXTRA_FIELD_SPACE

Fields inherited from class org.silverpeas.core.contribution.content.form.AbstractForm

REPEATED_FIELD_CSS_HIDE, REPEATED_FIELD_CSS_SHOW, REPEATED_FIELD_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
XmlSearchForm(RecordTemplate template)

Method Summary

Modifier and Type	Method	Description
void	display(javax.servlet.jsp.JspWriter jw, PagesContext pageContext, DataRecord record)	Prints this form into the specified JSP writer according to the specified records of data that populate the form fields.
void	displayScripts(javax.servlet.jsp.JspWriter jw, PagesContext pagesContext)	Prints the javascripts which will be used to control the new values given to the data record fields.
String	toString(PagesContext pagesContext, DataRecord record)	Prints the HTML layout of the dataRecord using the RecordTemplate to extract labels and extra informations.

Methods inherited from class org.silverpeas.core.contribution.content.form.AbstractForm

display, getData, getFieldDisplayer, getFieldTemplates, getFormName, getJavascriptSnippet, getName, getSkippableSnippet, getSureField, getTitle, isEmpty, isViewForm, setData, setFormName, setName, setTitle, setViewForm, toString, update, update, updateWysiwyg

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_FIELD_PERIOD

public static final String EXTRA_FIELD_PERIOD

See Also:

Constant Field Values

EXTRA_FIELD_SPACE

public static final String EXTRA_FIELD_SPACE

See Also:

Constant Field Values

Constructor Detail

XmlSearchForm

public XmlSearchForm(RecordTemplate template)
              throws FormException

Throws:

FormException

Method Detail

displayScripts

public void displayScripts(javax.servlet.jsp.JspWriter jw,
                           PagesContext pagesContext)

Prints the javascripts which will be used to control the new values given to the data record fields. The error messages may be adapted to a local language. The RecordTemplate gives the field type and constraints. The RecordTemplate gives the local label too. Never throws an Exception but log a silvertrace and writes an empty string when :

• a field is unknown by the template.
• a field has not the required type.

Specified by:

displayScripts in interface Form

Overrides:

displayScripts in class AbstractForm

Parameters:

jw - the JSP writer into which the javascript is written.

pagesContext - the JSP page context.

toString

public String toString(PagesContext pagesContext,
                       DataRecord record)

Prints the HTML layout of the dataRecord using the RecordTemplate to extract labels and extra informations. The value formats may be adapted to a local language. Never throws an Exception but log a silvertrace and writes an empty string when :

• a field is unknown by the template.
• a field has not the required type.

display

public void display(javax.servlet.jsp.JspWriter jw,
                    PagesContext pageContext,
                    DataRecord record)

Description copied from class: AbstractForm

Prints this form into the specified JSP writer according to the specified records of data that populate the form fields.

Specified by:

display in interface Form

Specified by:

display in class AbstractForm

Parameters:

jw - the JSP writer.

pageContext - the JSP page context.

record - the record the data records embbed the form fields.