blob: 8b447736987b437526b3164084adf513df53811f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- $Id$ -->
<html>
<head>
<title>contrib:InspectorButton</title>
<link rel="stylesheet" type="text/css" href="Tapestry.css" title="style">
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><A href="contrib.FormTable.html"><IMG alt=contrib:FormTable src="common-images/prev.png"></A></td>
<td align="middle"><A href="index.html"><IMG alt="Component Index" src="common-images/home.png" ></A></td>
<td align="right"><A href="contrib.Otherwise.html"><IMG alt=contrib:Otherwise src="common-images/next.png"></A></td>
<tr>
<tr>
<td colspan="3"><hr></td>
</tr>
<tr>
<td colspan="3">
<table border="0" cellpadding="4" cellspacing="4" width="100%">
<tr valign="top">
<td>
<table>
<tr>
<td><font size="+2"><b>contrib:InspectorButton</b></font></td>
</tr>
<tr>
<td>
<A href="../api/org/apache/tapestry/contrib/inspector/InspectorButton.html">
org.apache.tapestry.inspector.InspectorButton</A>
</td>
</tr>
</table>
</td>
<td>
<table align="right" valign="middle" bgcolor="#c0c0c0" cellpadding="8">
<tr>
<td><IMG alt="Show Inspector" src="images/inspector-rollover.gif" ></td>
</tr>
</table>
</td>
</tr>
<tr valign="center">
<td colspan="2">&nbsp;</td>
</tr>
<tr>
<td colspan="2">
<b>Description</b>
<br>
Adds a link to a page that is used to raise the
<A href="../DevelopersGuide\inspector.html">Tapestry Inspector</A> in a new
window.
<p> The Tapestry Inspector enables you at runtime to examine composition
of a Tapestry application, inspect persistent page properties, clear
<tt>HttpSession</tt>s and Tapestry caches.
<p>
Pages incorporating a InspectorButton component must also include a
<A href="Body.html">Body</A> component.</p>
<P>Prior to release 2.2, this component was named
<STRONG>ShowInspector</STRONG>.</P>
</td>
</tr>
<tr>
<td colspan="2">
<b>See Also</b>
<br>
<A href="Body.html">Body</A>,
<A href="ExceptionDisplay.html">ExceptionDisplay</A>
</td>
</tr>
<tr>
<td colspan="2">
<b>Parameters</b>
<br>
<table border="1" cellpadding="4" cellspacing="4" class="parameters">
<tr>
<th>Name</th>
<th>Type</th>
<th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td>disabled</td>
<td>boolean</td>
<td>in</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><BR>Informal
parameters: <STRONG>forbidden</STRONG><BR>Reserved parameters:
<EM>none</EM></p>
</td>
</tr>
<tr>
<td colspan="2">
<b>Examples</b>
<p>
This example is a simple page with the InspectorButton.</p>
<table class="examples" cellpadding="8">
<tr>
<td>
<h1>Hello world</h1>
<a href="#"><img src="images/inspector-rollover.gif" border="0" name="rollover" align="right"/></a>
</td>
</tr>
</table>
<p>
Template</p>
<pre>&lt;html jwcid=&quot;@Shell&quot; title=&quot;InspectorButton Example&quot;&gt;<br>&lt;head jwcid=&quot;$remove$&quot;&gt;<br> &lt;title&gt;InspectorButton Example&lt;/title&gt;<br>&lt;/head&gt;<br>&lt;body jwcid=&quot;@Body&quot;&gt;<br>&lt;h1&gt;Hello world&lt;/h1&gt;<br>&lt;span jwcid=&quot;@contrib:InspectorButton&quot;/&gt;<br>&lt;/body&gt;<br>&lt;/html&gt;
</pre>
</td>
</tr></table>
</td></tr>
<tr>
<td colspan="3"><hr></td>
</tr>
<tr>
<td align="left"><A href="contrib.Choose.html"><IMG alt=contrib:Choose src="common-images/prev.png"></A></td>
<td align="middle"><A href="index.html"><IMG alt="Component Index" src="common-images/home.png" ></A></td>
<td align="right"><A href="contrib.Otherwise.html"><IMG alt=contrib:Otherwise src="common-images/next.png"></A></td>
</tr>
</table>
</body>
</html>