This project has retired. For details please refer to its Attic page.

org.apache.cocoon.forms.formmodel
Class Messages

java.lang.Object
  org.apache.cocoon.forms.formmodel.AbstractWidget
      org.apache.cocoon.forms.formmodel.Messages

All Implemented Interfaces:

Widget, Locatable

public class Messages
extends AbstractWidget

A widget to output one or messages. This widget doesn't respond to input from the user, except that on each form submit the messages are cleared.

This widget is typically used to communicate extra validation errors or other messages to the user, that aren't associated with any other widget in particular.

Version:

$Id: Messages.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

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

wasValid

Fields inherited from interface org.apache.cocoon.forms.formmodel.Widget

PATH_SEPARATOR

Constructor Summary

protected

Messages(MessagesDefinition definition)

Method Summary

void	addMessage(String message) Adds a string message.
void	addMessage(XMLizable message) Adds a message in the form an object that implements the XMLizable interface.
void	generateItemSaxFragment(ContentHandler contentHandler, Locale locale) Generates nested additional content nested inside the main element for this widget which is generated by AbstractWidget.generateSaxFragment(ContentHandler, Locale) The implementation on the AbstractWidget level inserts no additional XML.
WidgetDefinition	getDefinition() Concrete subclasses should allow access to their underlaying Definition through this method.
String	getXMLElementName() The XML element name used in AbstractWidget.generateSaxFragment(ContentHandler, Locale) to produce the wrapping element for all the XML-instance-content of this Widget.
void	readFromRequest(FormContext formContext) Lets this widget read its data from a request.
boolean	validate() Validates this widget and returns the outcome.

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

addValidator, broadcastEvent, generateDisplayData, generateLabel, generateSaxFragment, getAttribute, getChild, getCombinedState, getForm, getFullName, getId, getLocation, getName, getParent, getRequestParameterName, getState, getValue, getWidget, getXMLElementAttributes, initialize, isRequired, isValid, lookupWidget, removeAttribute, removeValidator, setAttribute, setParent, setState, setValue, toString, widgetNameChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

Messages

protected Messages(MessagesDefinition definition)

Method Detail

getDefinition

public WidgetDefinition getDefinition()

Description copied from class: AbstractWidget

Concrete subclasses should allow access to their underlaying Definition through this method. If subclasses decide to return null they should also organize own implementations of AbstractWidget.getId(), AbstractWidget.getLocation(), AbstractWidget.validate(), AbstractWidget.generateLabel(ContentHandler) and AbstractWidget.generateDisplayData(ContentHandler) to avoid NPE's.

Specified by:

getDefinition in interface Widget

Specified by:

getDefinition in class AbstractWidget

Returns:

the widgetDefinition from which this widget was instantiated. (See WidgetDefinition.createInstance())

readFromRequest

public void readFromRequest(FormContext formContext)

Description copied from interface: Widget

Lets this widget read its data from a request. At this point the Widget may try to convert the request parameter to its native datatype (if it is not a string), but it should not yet generate any validation errors.

validate

public boolean validate()

Description copied from interface: Widget

Validates this widget and returns the outcome. Possible error messages are remembered by the widget itself and will be part of the XML produced by this widget in its Widget.generateSaxFragment(ContentHandler, Locale) method.

Specified by:

validate in interface Widget

Overrides:

validate in class AbstractWidget

Returns:

true to indicate all validations were ok, false otherwise

See Also:

Widget.validate()

addMessage

public void addMessage(String message)

Adds a string message.

addMessage

public void addMessage(XMLizable message)

Adds a message in the form an object that implements the XMLizable interface. This allows to add messages that produce mixed content. The XMLizable should only generate a SAX fragment, i.e. without start/endDocument calls.

A useful implementation is I18nMesage.

getXMLElementName

public String getXMLElementName()

Description copied from class: AbstractWidget

The XML element name used in AbstractWidget.generateSaxFragment(ContentHandler, Locale) to produce the wrapping element for all the XML-instance-content of this Widget.

Specified by:

getXMLElementName in class AbstractWidget

Returns:

"messages"

generateItemSaxFragment

public void generateItemSaxFragment(ContentHandler contentHandler,
                                    Locale locale)
                             throws SAXException

Description copied from class: AbstractWidget

Generates nested additional content nested inside the main element for this widget which is generated by AbstractWidget.generateSaxFragment(ContentHandler, Locale) The implementation on the AbstractWidget level inserts no additional XML. Subclasses need to override to insert widget specific content.

Overrides:

generateItemSaxFragment in class AbstractWidget

Parameters:

contentHandler - to send the SAX events to

locale - in which context potential content needs to be put.

Throws:

SAXException