apache > cocoon

- Home

# Messages widget

## Concept

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 messages to the user, that aren't associated with any other widget in particular.

## Definition

    <fd:messages id="..." state="...">
    </fd:messages>

While the fd:messages widget can have validators etc., this probably does not make much sense for this widget so they are not mentioned above.

## Template

A messages widget is inserted in a template using the ft:widget tag:

    <ft:widget id="..."/>

## Styling (default HTML XSL)

The messages are rendered as an unordered list.

## API

Messages are added using the `addMessage` method on this widget. The argument can be a string, but also any object implementing the XMLizable interface, for example `org.apache.cocoon.forms.util.I18nMessage`.

Errors and Improvements? If you see any errors or potential improvements in this document please help us: View, Edit or comment on the latest development version (registration required).