You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by ds...@apache.org on 2003/05/21 21:39:21 UTC
cvs commit: jakarta-tapestry/doc/src/ComponentReference Block.html FieldLabel.html RenderBlock.html Select.html TextField.html ValidField.html
dsolis 2003/05/21 12:39:21
Modified: doc/src/ComponentReference Block.html FieldLabel.html
RenderBlock.html Select.html TextField.html
ValidField.html
Log:
Improve documentation. Add examples for FieldLabel, Block and RenderBlock.
Revision Changes Path
1.8 +4 -5 jakarta-tapestry/doc/src/ComponentReference/Block.html
Index: Block.html
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/ComponentReference/Block.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Block.html 6 Mar 2003 17:19:17 -0000 1.7
+++ Block.html 21 May 2003 19:39:20 -0000 1.8
@@ -100,10 +100,9 @@
</tr>
<tr>
- <td colspan="2">
- <b>Examples</b>
- <p>
- This example is under construction.</p>
+ <td colspan="2"> <b>Examples</b>
+ <p> Please see the documentation for the <a href="RenderBlock.html">RenderBlock</a>
+ component.</p>
</td></tr></table>
1.9 +2 -2 jakarta-tapestry/doc/src/ComponentReference/FieldLabel.html
Index: FieldLabel.html
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/ComponentReference/FieldLabel.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- FieldLabel.html 24 Mar 2003 20:41:43 -0000 1.8
+++ FieldLabel.html 21 May 2003 19:39:20 -0000 1.9
@@ -123,7 +123,7 @@
<td colspan="2">
<b>Examples</b>
<p>
- This example is under construction.</p>
+ Please see the documentation for the <A href="ValidField.html">ValidField</a> component.</p>
</td></tr></table>
1.4 +130 -5 jakarta-tapestry/doc/src/ComponentReference/RenderBlock.html
Index: RenderBlock.html
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/ComponentReference/RenderBlock.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- RenderBlock.html 6 Mar 2003 17:19:17 -0000 1.3
+++ RenderBlock.html 21 May 2003 19:39:20 -0000 1.4
@@ -110,11 +110,136 @@
<tr>
<td colspan="2">
<b>Examples</b>
- <p>
- This example is under construction.</p>
-
+ <p> This example shows a page with a custom TabPanel component. When
+ a user selects a tab, TabPanel switches content. Each tab content
+ is defined by a Block.</p>
+ <table border="0" width="50%" cellspacing="0" cellpadding="0">
+<tr>
+ <td width="10"> </td>
+ <td>
+ <table border="0" cellspacing="0" cellpadding="5">
+ <tr>
+<td bgcolor="#FFFF00">
- </td></tr></table>
+Berlin
+
+</td> <td width="1"></td>
+
+<td bgcolor="#CCFFFF">
+Rome
+</td> <td width="1"></td>
+
+<td bgcolor="#CCFFFF">
+Tokyo
+</td> <td width="1"></td>
+</tr>
+ </table>
+ </td>
+ <td width="10" > </td>
+</tr>
+
+
+<tr>
+<td colspan="3" bgcolor="#00CC33" height="5"> </td>
+</tr>
+
+<tr>
+<td width="10" bgcolor="#00CC33"> </td> <td align="center">
+ <H1>Berlin</H1>
+ </td>
+<td width="10" bgcolor="#00CC33"> </td>
+</tr>
+
+<tr>
+<td colspan="3" bgcolor="#00CC33" height="5"> </td>
+</tr>
+
+</table>
+<br>
+ <pre><html title="TabPanel Test"><br> <body><br> <span jwcid="@TabPanel" blockNames='ognl:{"Berlin", "Rome", "Tokyo"}' selectColor="#FFFF00" unSelectColor="#CCFFFF" borderColor="#00CC33"/><br> <span jwcid="Berlin@<a href="Block.html">Block</a>"><br> <H1>Berlin</H1><br> </span><br> <span jwcid="Rome@<a href="Block.html">Block</a>"><br> <H1>Rome</H1><br> </span><br> <span jwcid="Tokyo@<a href="Block.html">Block</a>"><br> <H1>Tokyo</H1><br> </span><br> </body><br></html>
+</pre>
+ <br>
+ TabPanel.html
+ <pre><table border="0" width="50%" cellspacing="0" cellpadding="0"><br> <tr><br> <td width="10">&nbsp;</td><br> <td><br> <table border="0" cellspacing="0" cellpadding="5"><br> <tr><br> <span jwcid="foreach@Foreach" source="ognl:blockNames" value="ognl:currentBlock"><br> <td jwcid="@Any" element="td" bgcolor="ognl:tabCellColor"><br> <a jwcid="link"><br> <span jwcid="@Insert" value="ognl:components.foreach.value">Tab Title</span><br> </a><br> </td><br> <td width="1"></td><br> </span><br> </tr><br> </table><br> </td><br> <td width="10">&nbsp;</td><br> </tr><br> <tr><br> <td jwcid="@Any" element="td" height="5" bgcolor="ognl:borderColor" colspan="3">&nbsp;</td><br> </tr><br> <tr><br> <td jwcid="@Any" element="td" width="10" bgcolor="ognl:borderColor">&nbsp;</td><br> <td align="center"><br> <span jwcid="@<a href="RenderBlock.html">RenderBlock</a>" block='ognl:block'>Page content goes here</span><br> </td><br> <td jwcid="@Any" element="td" width="10" bgcolor="ognl:borderColor">&nbsp;</td><br> </tr><br> <tr><br> <td jwcid="@Any" element="td" height="5" bgcolor="ognl:borderColor" colspan="3">&nbsp;</td><br> </tr><br></table><br>
+</pre>
+<br>TabPanel.jwc
+ <pre><?xml version="1.0" encoding="UTF-8"?><br><!DOCTYPE component-specification<br> PUBLIC "-//Apache Software Foundation//Tapestry Specification 1.4//EN"<br> "http://jakarta.apache.org/tapestry/dtd/Tapestry_1_4.dtd"><br><br><component-specification class="spoc.components.TabPanel" allow-body="no" allow-informal-parameters="no"><br> <parameter name="blockNames" direction="in" type="java.util.List" required="yes"/><br> <parameter name="selectColor" direction="in" type="java.lang.String" required="no"/><br> <parameter name="unSelectColor" direction="in" type="java.lang.String" required="no"/><br> <parameter name="borderColor" direction="in" type="java.lang.String" required="no"/><br><br> <component id="link" type="DirectLink"><br> <binding name="listener" expression="listeners.selectBlock"/><br> <binding name="parameters" expression="components.foreach.value"/><br> <binding name="disabled" expression="currentBlock == selectedBlock"/><br> <binding name="stateful" expression="false"/><br> </component><br><br> <property-specification name="selectedBlock" type="java.lang.String"/><br> <property-specification name="currentBlock" type="java.lang.String"/><br></component-specification><br>
+</pre>
+<br>TabPanel.java
+ <pre>package com.dsconsulting.tapestry.components;
+
+import org.apache.tapestry.BaseComponent;
+import org.apache.tapestry.IRequestCycle;
+import org.apache.tapestry.components.Block;
+
+import java.util.List;
+
+
+public abstract class TabPanel extends BaseComponent {
+
+ public static final String SELECT_COLOR = "#7D000D";
+ public static final String UNSELECT_COLOR = "#C0C0C0";
+
+ private String _borderColor = SELECT_COLOR;
+ private List _blockNames;
+
+ public List getBlockNames() {
+ return _blockNames;
+ }
+
+ public void setBlockNames(List value) {
+ _blockNames = value;
+ if (getSelectedBlock() == null) {
+ String defaultComponent = getDefaultBlock();
+ setSelectedBlock(defaultComponent);
+ setCurrentBlock(defaultComponent);
+ }
+ }
+
+ public String getTabCellColor() {
+ String selectColor = getSelectColor();
+ String unSelectColor = getUnSelectColor();
+ return getCurrentBlock().equals(getSelectedBlock()) ?
+ selectColor != null ? selectColor : SELECT_COLOR :
+ unSelectColor != null ? unSelectColor : UNSELECT_COLOR;
+ }
+
+ public String getBorderColor() {
+ return _borderColor;
+ }
+
+ public void setBorderColor(String value) {
+ _borderColor = value;
+ }
+
+ public void selectBlock(IRequestCycle cycle) {
+ String block = (String) cycle.getServiceParameters()[0];
+ setSelectedBlock(block);
+ fireObservedChange("selectedBlock", block);
+ }
+
+ public Block getBlock() {
+ return (Block) getPage().getComponent(getSelectedBlock());
+ }
+
+ public String getDefaultBlock() {
+ List tabComponents = getBlockNames();
+ return tabComponents != null ? (String)tabComponents.get(0) : null;
+ }
+
+ public abstract String getSelectColor();
+ public abstract String getUnSelectColor();
+
+ public abstract String getSelectedBlock();
+ public abstract void setSelectedBlock(String value);
+
+ public abstract String getCurrentBlock();
+ public abstract void setCurrentBlock(String value);
+
+}
+</pre>
+ </td>
+ </tr></table>
</td></tr>
<tr>
<td colspan="3"><hr></td>
1.13 +12 -19 jakarta-tapestry/doc/src/ComponentReference/Select.html
Index: Select.html
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/ComponentReference/Select.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Select.html 24 Mar 2003 20:41:43 -0000 1.12
+++ Select.html 21 May 2003 19:39:20 -0000 1.13
@@ -184,25 +184,18 @@
have it's selected property set to true (see below)<p>
Which produces the following HTML:<p>
- <pre>
-<form method="post" name="Form0" action="/componentref">
-<input type="hidden" name="service" value="direct">
-<input type="hidden" name="context" value="Selection/form">
-<input type="hidden" name="sp" value="S0">
- Select a color:
-<select name="selection" multiple>
-<option value="0">Green
-<option value="1">Blue
-<option value="2">Red
-<option value="3">White
-<option value="4">Purple
-<option value="5">Dark Black
-<option value="6">Fiji Blue
-</select>
-<input type="hidden" name="Form0" value="1">
+ <pre><form method="post" name="Form0" action="/componentref"><br> <input type="hidden" name="service" value="direct/0/SelectPage/$Form"/><br> <input type="hidden" name="sp" value="S0"/><br> <input type="hidden" name="Form0" value="$Select"/><br> Select a color<br> <select name="$Select" multiple="multiple">
+ <option value="0">Green</option>
+ <option value="1">Blue</option>
+ <option value="2">Red</option>
+ <option value="3">White</option>
+ <option value="4">Purple</option>
+ <option value="5">Dark Black</option>
+ <option value="6">Fiji Blue</option>
+ </select>
</form>
- </pre>
-</td>
+ </pre>
+ </td>
</tr>
<tr>
1.11 +3 -3 jakarta-tapestry/doc/src/ComponentReference/TextField.html
Index: TextField.html
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/ComponentReference/TextField.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- TextField.html 24 Mar 2003 20:41:43 -0000 1.10
+++ TextField.html 21 May 2003 19:39:20 -0000 1.11
@@ -147,9 +147,9 @@
<table valign="middle">
<tr>
<td>Id</td>
- <td>span jwcid="<span class="jwcid">@<a href="TextField.html">TextField</a></span>" value="ognl:visit.id" size="8"/></td>
+ <td><span jwcid="inputId<span class="jwcid">@<a href="TextField.html">TextField</a></span>" value="ognl:visit.id" size="8"/></td>
<td>Password</td>
- <td><span jwcid="<span class="jwcid">@<a href="TextField.html">TextField</a></span>" value="ognl:visit.password" hidden="ognl:true" size="8"/></td>
+ <td><span jwcid="inputPassword<span class="jwcid">@<a href="TextField.html">TextField</a></span>" value="ognl:visit.password" hidden="ognl:true" size="8"/></td>
</tr>
<tr>
<td colspan="4" align="right"><input type="submit" value="Submit"/></td>
1.19 +2 -37 jakarta-tapestry/doc/src/ComponentReference/ValidField.html
Index: ValidField.html
===================================================================
RCS file: /home/cvs/jakarta-tapestry/doc/src/ComponentReference/ValidField.html,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- ValidField.html 24 Mar 2003 20:41:43 -0000 1.18
+++ ValidField.html 21 May 2003 19:39:20 -0000 1.19
@@ -269,42 +269,7 @@
<pre>
-<form jwcid="@<a href="Form.html">Form</a>" delegate="ognl:beans.delegate">
-<table class="examples" cellpadding="2">
-<tr>
- <td colspan="2"><span class="title">Regal Auctions Bid Page</span></td>
-</tr>
-<tr>
- <td colspan="2"><hr></td>
-</tr>
-<tr>
- <td colspan="2"><span jwcid="@ShowError" delegate="ognl:beans.delegate"/></td>
-</tr>
-<tr>
- <td>Lot Number</td><td><input jwcid="<span class="jwcid">lotNoField</span>" type="text" size="4" maxlength="4"/></td>
-</tr>
-<tr>
- <td>Bid Amount</td><td><input jwcid="<span class="jwcid">bidAmountField</span>" type="text" size="7" maxlength="7"/></td>
-</tr>
-<tr>
- <td<Full Name</td><td><input jwcid="<span class="jwcid">fullNameField</span>" type="text" size="25" maxlength="30"/></td>
-</tr>
-<tr>
- <td>Email</td><td><input jwcid="<span class="jwcid">emailField</span>" type="text" size="25" maxlength="30"/></td>
-</tr>
-<tr>
- <td>Telphone</td><td><input jwcid="<span class="jwcid">telephoneField</span>" type="text" size="25" maxlength="30"/></td>
-</tr>
-<tr>
- <td colspan="2" align="right">
- <input jwcid="@<a href="Submit.html">Submit</a>" listener="ognl:listeners.okSubmit" type="Submit" value=" OK "/>
- <input jwcid="@<a href="Submit.html">Submit</a>" listener="ognl:listeners.cancelSubmit"onclick="form.onsubmit = null;"/>
- </td>
-</tr>
-</table>
-</form>
-
-
+<form jwcid="@<A href="Form.html">Form</A>" delegate="ognl:beans.delegate"><br><table class="examples" cellpadding="2"><br><tr><br> <td colspan="2"><span class="title">Regal Auctions Bid Page</span></td><br></tr><br><tr><br> <td colspan="2"><hr></td><br></tr><br><tr><br> <td colspan="2"><span jwcid="@ShowError" delegate="ognl:beans.delegate"/></td><br></tr><br><tr><br> <td><span jwcid="@<A href="FieldLabel.html">FieldLabel</A>" field="ognl:components.lotNoField">Lot Number</span></td><td><input jwcid="lotNoField" type="text" size="4" maxlength="4"/></td><br></tr><br><tr><br> <td><span jwcid="@<A href="FieldLabel.html">FieldLabel</A>" field="ognl:components.bidAmountField">Bid Amount</span></td><td><input jwcid="bidAmountField" type="text" size="7" maxlength="7"/></td><br></tr><br><tr><br> <td><span jwcid="@<A href="FieldLabel.html">FieldLabel</A>" field="ognl:components.fullNameField">Full Name</span></td><td><input jwcid="fullNameField" type="text" size="25" maxlength="30"/></td><br></tr><br><tr><br> <td><span jwcid="@<A href="FieldLabel.html">FieldLabel</A>" field="ognl:components.emailField">Email</span></td><td><input jwcid="emailField" type="text" size="25" maxlength="30"/></td><br></tr><br><tr><br> <td><span jwcid="@<A href="FieldLabel.html">FieldLabel</A>" field="ognl:components.telephoneField">Telephone</span></td><td><input jwcid="telephoneField" type="text" size="25" maxlength="30"/></td><br></tr><br><tr><br> <td colspan="2" align="right"><br> <input jwcid="@Submit" listener="ognl:listeners.okSubmit" type="Submit" value=" OK "/><br> <input jwcid="@Submit" listener="ognl:listeners.cancelSubmit"onclick="form.onsubmit = null;"/><br> </td><br></tr><br></table><br></form><br>
<bean name="delegate" class="com.mycorp.FormValidationDelegate"/>
<bean name="lotNoValidator" class="<A href="../api/org/apache/tapestry/valid/NumberValidator.html">org.apache.tapestry.valid.NumberValidator</a>">