apache > cocoon
 
Font size:      

Cocoon Forms: output widget (2.1 legacy document)

Warning
This document was copied as is from the Cocoon 2.1 documentation, but has not yet been fully reviewed or moved to its new home.

Concept

An fd:output widget is similar to a field widget, but its value is not editable. The value of an output widget must be set programmatically (or through binding). An output widget does not read its value from the request, so is most useful in the case where the form is stored accross requests (automatically the case when using flowscript). An output widget does not perform any validation, it is always considered to be valid.

It is likely that we'll add a generalized 'readonly' capability to all widgets. When we do that, fd:output will become obsolete and can be replaced by a 'readonly' field wiget. In the meantime you can safely use fd:output since this change won't have much impact.

Possible alternative: On each widget you can also store additional information (i.e. arbitrary Java objects) in attributes. See the Java API of the Widget interface, methods setAttribute and getAttribute. You can then retrieve these attributes using the JXTemplate generator.

Configuration

<fd:output id="...">
  <fd:label>...</fd:label>
  <fd:help>...</fd:help>
  <fd:hint>...</fd:hint>
  <fd:datatype base="...">
     [...]
  </fd:datatype>
</fd:output>

See field widget for a description of the configuration elements.

Comments

add your comments