tapestry/tapestry-contrib/src/site/xdoc/componentreference/inspectorbutton.xml - tapestry4 - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!--
     Copyright 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>InspectorButton</title>
     </properties>
     <body>

         <section name="InspectorButton">

             <p>
                 Adds a link to a page that is used to raise the Tapestry Inspector in a new window.
                 <br />
                 The Tapestry Inspector enables you at runtime to examine composition of a Tapestry
                 application, inspect persistent page properties, clear HttpSessions and Tapestry
                 caches.
                 <br />
                 Pages incorporating a InspectorButton component must also include a Body component.
             </p>
             <img src="../images/inspectorbutton.png" alt="Embedded inspector button in page."/>
             <p>
                 <strong>
                     See also:
                     <a href="../../components/general/body.html">Body</a>
                     ,
                     <a href="../../components/general/exceptiondisplay.html">ExceptionDisplay</a>
                 </strong>
             </p>

             <subsection name="Parameters">
                 <table>
                     <tr>
                         <th>Name</th>
                         <th>Type</th>
                         <th>Required</th>
                         <th>Default</th>
                         <th>Description</th>
                     </tr>
                     <tr>
                         <td>disabled</td>
                         <td>boolean</td>
                         <td>no</td>
                         <td>false</td>
                         <td>
                             If true, the button does not appear. This is the correct configuration
                             for a deployed application.
                         </td>
                     </tr>

                 </table>

                 <p>
                     Body:
                     <strong>removed</strong>
                 </p>

                 <p>
                     Informal parameters:
                     <strong>forbidden</strong>
                 </p>

                 <p>
                     Reserved parameters:
                     <em>none</em>
                 </p>

             </subsection>

             <subsection name="Examples">

                 <p>This example is a simple page with the InspectorButton.</p>
                 <p>
                     <strong>Template</strong>
                 </p>
                 <source xml:space="preserve">
 &lt;html jwcid="@Shell" title="InspectorButton Example"&gt;
 &lt;head jwcid="$remove$"&gt;
  &lt;title&gt;InspectorButton Example&lt;/title&gt;
 &lt;/head&gt;
 &lt;body jwcid="@Body"&gt;
 &lt;h1&gt;Hello world&lt;/h1&gt;
 &lt;span jwcid="@contrib:InspectorButton"/&gt;
 &lt;/body&gt;
 &lt;/html&gt;</source>
             </subsection>

         </section>

     </body>
 </document>
	<?xml version="1.0" encoding="UTF-8"?>
	<!--
	Copyright 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>InspectorButton</title>
	</properties>
	<body>

	<section name="InspectorButton">

	<p>
	Adds a link to a page that is used to raise the Tapestry Inspector in a new window.
	<br />
	The Tapestry Inspector enables you at runtime to examine composition of a Tapestry
	application, inspect persistent page properties, clear HttpSessions and Tapestry
	caches.
	<br />
	Pages incorporating a InspectorButton component must also include a Body component.
	</p>
	<img src="../images/inspectorbutton.png" alt="Embedded inspector button in page."/>
	<p>
	<strong>
	See also:
	<a href="../../components/general/body.html">Body</a>
	,
	<a href="../../components/general/exceptiondisplay.html">ExceptionDisplay</a>
	</strong>
	</p>

	<subsection name="Parameters">
	<table>
	<tr>
	<th>Name</th>
	<th>Type</th>
	<th>Required</th>
	<th>Default</th>
	<th>Description</th>
	</tr>
	<tr>
	<td>disabled</td>
	<td>boolean</td>
	<td>no</td>
	<td>false</td>
	<td>
	If true, the button does not appear. This is the correct configuration
	for a deployed application.
	</td>
	</tr>

	</table>

	<p>
	Body:
	<strong>removed</strong>
	</p>

	<p>
	Informal parameters:
	<strong>forbidden</strong>
	</p>

	<p>
	Reserved parameters:
	<em>none</em>
	</p>

	</subsection>

	<subsection name="Examples">

	<p>This example is a simple page with the InspectorButton.</p>
	<p>
	<strong>Template</strong>
	</p>
	<source xml:space="preserve">
	<html jwcid="@Shell" title="InspectorButton Example">
	<head jwcid="$remove$">
	<title>InspectorButton Example</title>
	</head>
	<body jwcid="@Body">
	<h1>Hello world</h1>
	<span jwcid="@contrib:InspectorButton"/>
	</body>
	</html></source>
	</subsection>

	</section>

	</body>
	</document>