Java Doc for Form.java in » Content-Management-System » apache-lenya-2.0 » org » apache » cocoon » forms » formmodel » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Content Management System » apache lenya 2.0 » org.apache.cocoon.forms.formmodel

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.cocoon.forms.formmodel .AbstractWidget

org.apache.cocoon.forms.formmodel .AbstractContainerWidget

org.apache.cocoon.forms.formmodel .Form

Form
public class Form extends AbstractContainerWidget implements ValidationErrorAware(Code)
	A widget that serves as a container for other widgets, the top-level widget in a form description file. version: $Id: Form.java 475908 2006-11-16 20:15:45Z vgritsenko $

Field Summary
final public static String	SUBMIT_ID_PARAMETER

Constructor Summary
public	Form(FormDefinition definition)

Method Summary
public void	addProcessingPhaseListener(ProcessingPhaseListener listener)
public void	addWidgetEvent(WidgetEvent event) Events produced by child widgets should not be fired immediately, but queued in order to ensure an overall consistency of the widget tree before being handled.
public boolean	addWidgetUpdate(Widget widget) Mark a widget as being updated.
public void	endProcessing(boolean redisplayForm) End the current form processing after the current phase.
public Set	getChildUpdatedWidgetIds()
public WidgetDefinition	getDefinition()
public String	getId()
public Locale	getLocale() Get the locale to be used to process this form.
public Widget	getSubmitWidget() Get the widget that triggered the current processing.
public Set	getUpdatedWidgetIds()
public ValidationError	getValidationError() Set a validation error on this field.
public String	getXMLElementName()
public boolean	hasFormHandler()
public void	informEndLoadingModel() Inform the form that the values are loaded.
public void	informEndSavingModel() Inform the form that the values are saved.
public void	informStartLoadingModel() Inform the form that the values will be loaded.
public void	informStartSavingModel() Inform the form that the values will be saved.
public void	initialize() Initialize the form by recursively initializing all its children.
public boolean	isValid()
public synchronized boolean	process(FormContext formContext) Processes a form submit.
public void	readFromRequest(FormContext formContext)
public void	removeProcessingPhaseListener(ProcessingPhaseListener listener)
public void	setFormHandler(FormHandler formHandler)
public void	setId(String value) Set the optional id.
public void	setSubmitWidget(Widget widget) Set the widget that triggered the current form processing.
public void	setValidationError(ValidationError error)
public boolean	validate() Performs validation phase of form processing.

Field Detail

SUBMIT_ID_PARAMETER
final public static String SUBMIT_ID_PARAMETER(Code)
	Form parameter containing the submit widget's id

Constructor Detail

Form
public Form(FormDefinition definition)(Code)

Method Detail

addProcessingPhaseListener
public void addProcessingPhaseListener(ProcessingPhaseListener listener)(Code)

addWidgetEvent
public void addWidgetEvent(WidgetEvent event)(Code)
	Events produced by child widgets should not be fired immediately, but queued in order to ensure an overall consistency of the widget tree before being handled. Parameters: event - the event to queue

addWidgetUpdate
public boolean addWidgetUpdate(Widget widget)(Code)
	Mark a widget as being updated. When it Ajax mode, only updated widgets will be redisplayed Parameters: widget - the updated widget `true` if this widget was added to the list (i.e. wasn't alredy marked for update)

endProcessing
public void endProcessing(boolean redisplayForm)(Code)
	End the current form processing after the current phase. Parameters: redisplayForm - indicates if the form should be redisplayed to the user.

getChildUpdatedWidgetIds
public Set getChildUpdatedWidgetIds()(Code)

getDefinition
public WidgetDefinition getDefinition()(Code)

getId
public String getId()(Code)
	See Also: org.apache.cocoon.forms.formmodel.AbstractWidget.getId

getLocale
public Locale getLocale()(Code)
	Get the locale to be used to process this form. the form's locale.

getSubmitWidget
public Widget getSubmitWidget()(Code)
	Get the widget that triggered the current processing. Note that it can be any widget, and not necessarily an action or a submit. the widget that submitted this form.

getUpdatedWidgetIds
public Set getUpdatedWidgetIds()(Code)

getValidationError
public ValidationError getValidationError()(Code)
	Set a validation error on this field. This allows the form to be externally marked as invalid by application logic. the validation error

getXMLElementName
public String getXMLElementName()(Code)

hasFormHandler
public boolean hasFormHandler()(Code)

informEndLoadingModel
public void informEndLoadingModel()(Code)
	Inform the form that the values are loaded.

informEndSavingModel
public void informEndSavingModel()(Code)
	Inform the form that the values are saved.

informStartLoadingModel
public void informStartLoadingModel()(Code)
	Inform the form that the values will be loaded.

informStartSavingModel
public void informStartSavingModel()(Code)
	Inform the form that the values will be saved.

initialize
public void initialize()(Code)
	Initialize the form by recursively initializing all its children. Any events occuring within the initialization phase are buffered and fired after initialization is complete, so that any action from a widget on another one occurs after that other widget has been given the opportunity to initialize itself.

isValid
public boolean isValid()(Code)
	Was form validation successful ? `true` if the form was successfully validated.

process

public synchronized boolean process(FormContext formContext)(Code)

Processes a form submit. If the form is finished, i.e. the form should not be redisplayed to the user, then this method returns true, otherwise it returns false. To know if the form was sucessfully validated, use the Form.isValid() method.

Form processing consists in multiple steps:

all widgets read their value from the request (i.e. Form.readFromRequest(FormContext) is called recursively on the whole widget tree)
if there is an action event, call the FormHandler
perform validation.

This processing can be interrupted by the widgets (or their event listeners) by calling Form.endProcessing(boolean) .

Note that this method is synchronized as a Form is not thread-safe. This should not be a bottleneck as such concurrent requests can only happen for a single user.

readFromRequest
public void readFromRequest(FormContext formContext)(Code)

removeProcessingPhaseListener
public void removeProcessingPhaseListener(ProcessingPhaseListener listener)(Code)

setFormHandler
public void setFormHandler(FormHandler formHandler)(Code)

setId
public void setId(String value)(Code)
	Set the optional id. Parameters: value - A new id.

setSubmitWidget
public void setSubmitWidget(Widget widget)(Code)
	Set the widget that triggered the current form processing. Parameters: widget - the widget

setValidationError
public void setValidationError(ValidationError error)(Code)
	set a validation error

validate
public boolean validate()(Code)
	Performs validation phase of form processing.

Fields inherited from org.apache.cocoon.forms.formmodel.AbstractContainerWidget

protected ValidationError validationError(Code)(Java Doc)
protected WidgetList widgets(Code)(Java Doc)

Methods inherited from org.apache.cocoon.forms.formmodel.AbstractContainerWidget

public void addChild(Widget widget)(Code)(Java Doc)
public void generateItemSaxFragment(ContentHandler contentHandler, Locale locale) throws SAXException(Code)(Java Doc)
public Widget getChild(String id)(Code)(Java Doc)
public Iterator getChildren()(Code)(Java Doc)
public int getSize()(Code)(Java Doc)
public boolean hasChild(String id)(Code)(Java Doc)
public void initialize()(Code)(Java Doc)
public void readFromRequest(FormContext formContext)(Code)(Java Doc)
public boolean validate()(Code)(Java Doc)

Fields inherited from org.apache.cocoon.forms.formmodel.AbstractWidget

protected boolean wasValid(Code)(Java Doc)

Methods inherited from org.apache.cocoon.forms.formmodel.AbstractWidget

public void addValidator(WidgetValidator validator)(Code)(Java Doc)
public void broadcastEvent(WidgetEvent event)(Code)(Java Doc)
protected void generateDisplayData(ContentHandler contentHandler) throws SAXException(Code)(Java Doc)
protected void generateItemSaxFragment(ContentHandler contentHandler, Locale locale) throws SAXException(Code)(Java Doc)
public void generateLabel(ContentHandler contentHandler) throws SAXException(Code)(Java Doc)
public void generateSaxFragment(ContentHandler contentHandler, Locale locale) throws SAXException(Code)(Java Doc)
public Object getAttribute(String name)(Code)(Java Doc)
protected Widget getChild(String id)(Code)(Java Doc)
public WidgetState getCombinedState()(Code)(Java Doc)
abstract public WidgetDefinition getDefinition()(Code)(Java Doc)
public Form getForm()(Code)(Java Doc)
public String getFullName()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public Location getLocation()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
final public Widget getParent()(Code)(Java Doc)
public String getRequestParameterName()(Code)(Java Doc)
public WidgetState getState()(Code)(Java Doc)
public Object getValue()(Code)(Java Doc)
public Widget getWidget(String id)(Code)(Java Doc)
protected AttributesImpl getXMLElementAttributes()(Code)(Java Doc)
abstract protected String getXMLElementName()(Code)(Java Doc)
public void initialize()(Code)(Java Doc)
public boolean isRequired()(Code)(Java Doc)
public boolean isValid()(Code)(Java Doc)
public Widget lookupWidget(String path)(Code)(Java Doc)
public void removeAttribute(String name)(Code)(Java Doc)
public boolean removeValidator(WidgetValidator validator)(Code)(Java Doc)
public void setAttribute(String name, Object value)(Code)(Java Doc)
public void setParent(Widget widget)(Code)(Java Doc)
public void setState(WidgetState state)(Code)(Java Doc)
public void setValue(Object object)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public boolean validate()(Code)(Java Doc)
protected void widgetNameChanged()(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.