Author: hlship
Date: Mon Apr 14 16:19:41 2008
New Revision: 648052
URL: http://svn.apache.org/viewvc?rev=648052&view=rev
Log:
TAPESTRY-2340: Documentation about informal parameters should reference the
@SupportsInformalParameters annotation specifically
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/site/apt/guide/parameters.apt
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/site/apt/guide/parameters.apt
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/site/apt/guide/parameters.apt?rev=648052&r1=648051&r2=648052&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/site/apt/guide/parameters.apt
(original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/site/apt/guide/parameters.apt
Mon Apr 14 16:19:41 2008
@@ -255,7 +255,11 @@
the component. Generally speaking, components that have a 1:1 relationship
with a particular HTML tag
(such as
{{{../ref/org/apache/tapestry/corelib/components/TextField.html}TextField}} and
\<input\> will support informal parameters.
-
+
+ Only components whose class is annotated with
+
{{{../apidocs/org/apache/tapestry/annotations/SupportsInformalParameters.html}SupportsInformalParameters}}
+ will support informal parameters.
+
Informal parameters are often used to set the CSS class of an element, or to
specify client-side event handlers.
The default binding prefix for informal parameters depends on <where> the
parameter binding is specified.
@@ -264,7 +268,18 @@
prefix is "prop:". If the parameter is bound inside the component template,
then the default binding
prefix is "literal:". This reflects the fact that a parameter specified in
the Java class, using the annotation, is most likely
a computed value, whereas a value in the template should simply be copied,
as is, into the result HTML stream.
-
+
+Supporting Informal Parameters
+
+ <<Only>> components which area annotated with
+
{{{../apidocs/org/apache/tapestry/annotations/SupportsInformalParameters.html}SupportsInformalParameters}}
+ may have informal parameters. Tapestry silently drops informal parameters
that are specified for components
+ that do not have this annotation.
+
+ To render informal parameters, inject the
+
{{{../apidocs/org/apache/tapestry/ComponentResources.html}ComponentResources}}
for your component
+ and invoke the <<<renderInformalParameters()>>> method.
+
Parameters Are Bi-Directional
