Author: jkuhnert
Date: Fri Nov 10 20:57:35 2006
New Revision: 473641
URL: http://svn.apache.org/viewvc?view=rev&rev=473641
Log:
Documented some of the new components.
Added:
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/Dialog.png
(with props)
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/InlineEditBox-editing.png
(with props)
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/InlineEditBox.png
(with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/dialog.xml (with
props)
tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/inlineeditbox.xml
(with props)
Modified:
tapestry/tapestry4/trunk/src/site/site.xml
Added:
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/Dialog.png
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/Dialog.png?view=auto&rev=473641
==============================================================================
Binary file - no diff available.
Propchange:
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/Dialog.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/InlineEditBox-editing.png
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/InlineEditBox-editing.png?view=auto&rev=473641
==============================================================================
Binary file - no diff available.
Propchange:
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/InlineEditBox-editing.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/InlineEditBox.png
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/InlineEditBox.png?view=auto&rev=473641
==============================================================================
Binary file - no diff available.
Propchange:
tapestry/tapestry4/trunk/src/site/resources/images/ComponentReference/InlineEditBox.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: tapestry/tapestry4/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/site.xml?view=diff&rev=473641&r1=473640&r2=473641
==============================================================================
--- tapestry/tapestry4/trunk/src/site/site.xml (original)
+++ tapestry/tapestry4/trunk/src/site/site.xml Fri Nov 10 20:57:35 2006
@@ -150,8 +150,10 @@
<item name="Dojo" href="/components/dojo/index.html"
collapse="true">
<item name="Autocompleter"
href="/components/dojo/autocompleter.html" />
+ <item name="Dialog" href="/components/dojo/dialog.html" />
<item name="DropdownDatePicker"
href="/components/dojo/dropdowndatepicker.html" />
<item name="DropdownTimePicker"
href="/components/dojo/dropdowntimepicker.html" />
+ <item name="InlineEditBox"
href="/components/dojo/inlineeditbox.html" />
</item>
</menu>
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/dialog.xml
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/dialog.xml?view=auto&rev=473641
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/dialog.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/dialog.xml Fri Nov
10 20:57:35 2006
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2006 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>Dialog</title>
+ </properties>
+ <body>
+
+ <section name="Dialog">
+
+ <p>
+ Creates a modal Dialog on the client side (of sorts). This
component may prove useful for cutting down
+ on typical CRUD operations where you normally have to navigate
to a lot of seperate pages to do things
+ like "edit" / "view" / or "add" something. Why make your users
navigate all over the place when they
+ can do it right there? :)
+ </p>
+
+ <p>
+ Also note that this particular component comes with two very
useful methods that you can
+ invoke in java code to hide and show the Dialog. They are
aptly named <code>hide()</code> and
+ <code>show()</code>.
+ </p>
+
+ <img src="../../images/ComponentReference/Dialog.png" />
+
+ <p>
+ <strong>
+ See also:
+ <a
href="../../tapestry-framework/apidocs/org/apache/tapestry/dojo/html/Dialog.html">
+ org.apache.tapestry.dojo.html.Dialog
+ </a>
+ </strong>
+
+ </p>
+
+ <section name="Parameters">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>hidden</td>
+ <td>boolean</td>
+ <td>no</td>
+ <td>true</td>
+ <td>
+ Whether or not the Dialog should be hidden by
default. (Which is what you want in most
+ cases.)
+ </td>
+ </tr>
+ <tr>
+ <td>backgroundColor</td>
+ <td>String</td>
+ <td>no</td>
+ <td>literal:black</td>
+ <td>
+ The html style color to give the background of the
dialog. The color given can be a literal
+ color name or hex string such as
<code>#efefef</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>opacity</td>
+ <td>float</td>
+ <td>no</td>
+ <td>0.4</td>
+ <td>
+ Controls how opaque the background is. This
parameter is given in the form of a percent, so
+ valid values would range from <code>0.1 - 1</code>.
+ </td>
+ </tr>
+ </table>
+
+ <p>
+ Body:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ </section>
+
+ <section name="Examples">
+ TODO...
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/dialog.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/inlineeditbox.xml
URL:
http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/inlineeditbox.xml?view=auto&rev=473641
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/inlineeditbox.xml
(added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/inlineeditbox.xml
Fri Nov 10 20:57:35 2006
@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2006 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>InlineEditBox</title>
+ </properties>
+ <body>
+
+ <section name="InlineEditBox">
+
+ <p>
+ Manages a single string value that can be edited "inline" in
either text or textarea mode.
+ </p>
+
+ <img src="../../images/ComponentReference/InlineEditBox.png" />
+
+ <img
src="../../images/ComponentReference/InlineEditBox-editing.png" />
+
+ <section name="Parameters">
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>value</td>
+ <td>String</td>
+ <td>yes</td>
+ <td></td>
+ <td>
+ The string property to manage. This will be
dynamically updated with any changes made by
+ someone editing the value "inline" in the browser.
+ </td>
+ </tr>
+ <tr>
+ <td>mode</td>
+ <td>
+ One of [text,textarea].
+ </td>
+ <td>no</td>
+ <td>literal:text</td>
+ <td>
+ Defines the editing mode that will be displayed
when editing the value.
+ </td>
+ </tr>
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ Controls whether the component is active or not. A
disabled
+ InlineEditBox that isn't currently being edited
will simply not allow editing
+ when clicking on it. If the edit box is already
being used when it is disable (like with
+ an ajax request update) the editable area will be
"greyed" out using the native browser
+ controls for disabling form input.
+ </td>
+ </tr>
+ <tr>
+ <td>minWidth</td>
+ <td>int</td>
+ <td>no</td>
+ <td>100</td>
+ <td>
+ The minimum display width for the editable
input/textarea control in "pixels".
+ </td>
+ </tr>
+ <tr>
+ <td>minHeight</td>
+ <td>int</td>
+ <td>no</td>
+ <td>200</td>
+ <td>
+ The minimum display height for the editable
input/textarea control in "pixels".
+ </td>
+ </tr>
+ <tr>
+ <td>doFade</td>
+ <td>boolean</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ Whether the animation transition from editing ->
normal mode should be a fade. If
+ false (the default) - the animation sequence will
be a simple highlight effect.
+ </td>
+ </tr>
+ </table>
+
+ <p>
+ Body:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ </section>
+
+ <section name="Examples">
+ TODO...
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange:
tapestry/tapestry4/trunk/src/site/xdoc/components/dojo/inlineeditbox.xml
------------------------------------------------------------------------------
svn:eol-style = native
