blob: 077a4238dea3f4bc7a1e9f7fd6df730e6ec3fe0b [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2004, 2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Block</title>
</properties>
<body>
<section name="Block">
<p>
Contains markup and other components, and defers rendering of its body until invoked
by a
<a href="renderblock.html">RenderBlock</a>
.
</p>
<p>
<strong>
See also:
<a href="../../apidocs/org/apache/tapestry/components/Block.html">
org.apache.tapestry.components.Block
</a>
,
<a href="renderblock.html">RenderBlock</a>
</strong>
</p>
<section name="Parameters">
<p>
<em>No parameters</em>
</p>
<p>
Body:
<strong>allowed</strong>
</p>
<p>
Informal parameters:
<strong>forbidden</strong>
</p>
<p>
Reserved parameters:
<em>none</em>
</p>
<p>
When a
<a href="block.html">Block</a>
component renders normally, it does absolutely nothing. It doesn't render any
tag, or render its body. However, a
<a href="renderblock.html">RenderBlock</a>
component can be passed a Block instance, which will trigger the Block to render
its body.
</p>
<p>
The parameters of the
<a href="renderblock.html">RenderBlock</a>
, including informal parameters, are indirectly available to the Block
component. The OGNL expression components.
<em>block</em>
.getParameter("
<em>name</em>
") returns the value of a parameter bound to the
<a href="renderblock.html">RenderBlock</a>
which invoked the rendering of the Block's body.
</p>
</section>
<section name="Example">
<p>
The
<a href="renderblock.html">RenderBlock</a>
component has an extensive example.
</p>
</section>
</section>
</body>
</document>