1:02 p.m.
Author: msorokin
Date: 2008-03-27 14:02:31 -0400 (Thu, 27 Mar 2008)
New Revision: 7324
Modified:
trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.xml
Log:
http://jira.jboss.com/jira/browse/RF-1226
Some descriptiones were changed.
Modified: trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.desc.xml 2008-03-27
17:59:06 UTC (rev 7323)
+++ trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.desc.xml 2008-03-27
18:02:31 UTC (rev 7324)
@@ -24,7 +24,7 @@
<title>Key Features</title>
<itemizedlist>
<listitem>Option to display "save",
"cancel" buttons</listitem>
- <listitem>Possibility to assign an JS action on state
change</listitem>
+ <listitem>Possibility to assign an JavaScript action on state
change</listitem>
<listitem>Switching between<emphasis
role="bold"><property><rich:inplaceInput></property></emphasis>
components using "Tab" key</listitem>
<listitem>Resizable input field</listitem>
</itemizedlist>
Modified: trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.xml 2008-03-27 17:59:06
UTC (rev 7323)
+++ trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.xml 2008-03-27 18:02:31
UTC (rev 7324)
@@ -72,16 +72,16 @@
<para>
As it was mentioned earlier the
<emphasis
role="bold"><property><rich:inplaceInput></property>
</emphasis>
- component was designed to facilitate inputting and editing some parts of a
text.
+ component was designed to facilitate inputting and editing some parts of text.
</para>
<para>
The component has three logical states:
<itemizedlist>
<listitem>
- <para><property>"View"</property> state
displays the text containing in a
<emphasis><property>"value"</property></emphasis>
attribute;</para>
+ <para><property>View</property> state displays the text
containing in a
<emphasis><property>"value"</property></emphasis>
attribute;</para>
<figure>
- <title>"View" state</title>
+ <title>View state</title>
<mediaobject>
<imageobject>
<imagedata
fileref="images/inplaceInputViewState_shadow.png"/>
@@ -90,9 +90,9 @@
</figure>
</listitem>
<listitem>
-
<para><property>"Editable"</property>state - the text
can be edited and saved;</para>
+ <para><property>;Edit</property>state - the text can be
edited and saved;</para>
<figure>
- <title>"Editable" state</title>
+ <title>Edit state</title>
<mediaobject>
<imageobject>
<imagedata
fileref="images/inplaceInputEditState_shadow.png"/>
@@ -101,9 +101,9 @@
</figure>
</listitem>
<listitem>
- <para><property>"Changed"</property>state
- displays the edited text and indicates that it was edited, changed</para>
+ <para><property>Changed</property>state - displays the
edited text and indicates that it was edited, changed</para>
<figure>
- <title>"Changed" state</title>
+ <title>Changed state</title>
<mediaobject>
<imageobject>
<imagedata
fileref="images/inplaceInputChangedState_shadow.png"/>
@@ -130,8 +130,8 @@
However, if
<emphasis><property>"value"</property></emphasis>
attribute is not defined, you can use
- <emphasis><property>"defaultLabel attribute
"</property></emphasis>
- which will display some default text while
+
<emphasis><property>"defaultLabel"</property></emphasis>
attribute
+ which displays some default text while
<emphasis><property>"value"</property></emphasis>
attribute stays undefined.
</para>
@@ -153,10 +153,10 @@
<para>
- Input data is saved (submitted) automatically when the input field loses focus.
- Nevertheless, you can use a
+ Input data is saved (submitted) automatically whenever the input field loses focus.
+ Nevertheless, you can use the
<emphasis><property>"showControls"</property></emphasis>
- attribute, which make <property>"save"</property>and
<property>"cancel" </property> buttons
+ attribute, which makes <property>"save"</property>and
<property>"cancel" </property> buttons
appear next to the input field.
</para>
<para>
@@ -205,7 +205,7 @@
<emphasis><property>"saveControlIcon"</property></emphasis>
and
<emphasis><property>"cancelControlIcon"</property></emphasis>
- attributes relatively. You need to define the path to where your images are
located.
+ attributes r. You need to define the path to where your images are located.
</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -227,19 +227,34 @@
</imageobject>
</mediaobject>
</figure>
+ <para>
+ The
+
<emphasis><property>"inputWidth"</property></emphasis>,
+
<emphasis><property>"minInputWidth"</property></emphasis>,
and
+
<emphasis><property>"maxInputWidth"</property></emphasis>
+ attributes are provided to specify the width, minimal width and maximal width for
the input element respectively.
+
+ </para>
+
+
<para>
The
<emphasis><property>"editEvent"</property></emphasis>
- attribute provides an option to assign an JS action that triggers state changing
from
- <property>"View"</property>
+ attribute provides an option to assign an JavaScript action that initiates the
change of the state from
+ <property>view</property>
to
- <property>"Edit"</property>.
+ <property>edit</property>.
+
+
The default value is "click".
- </para>
+ </para>
+
+
+
<note>
<para>
@@ -248,6 +263,17 @@
</para>
</note>
+
+ <para>
+ Having multiple
+ <emphasis
role="bold"><property><rich:inplaceInput></property></emphasis>
+ components
+ on a page you can use
<emphasis><property>"tabindex"</property></emphasis>
attribute that enables switching (tabbing)
+ between the components by pressing the “Tab” key.
+ Switching order is determined by the value of the attribute which is an integer
between 0 and 32767.
+ </para>
+
+
<para>
The
@@ -255,7 +281,7 @@
<emphasis><property>"selectOnEdit"</property></emphasis>
(with possible values "true", "false") gives you
an
option to make the text in the input area selected right after the change from
- <property>"View"</property> state to
<property>"Edit"</property>.
+ <property>view</property> state to <property>edit</property>
occurs.
</para>
<para>
@@ -266,10 +292,10 @@
and
<emphasis><property>"
onviewactivated"</property></emphasis>
provide a possibility to assign JavaScript code on
- <property>"Edit"</property> state activation, on
- <property>"Edit"</property> state activated,on
- <property>"View"</property> state activation and on
- <property>"View"</property> state activated respectively.
+ <property>edit</property> state activation, on
+ <property>edit</property> state activated,on
+<property>view</property> state activation and on
+<property>view</property> state activated respectively.
</para>
@@ -283,8 +309,8 @@
<para>
The given code illustrates how onviewactivation attribute works,
namely when the state is being changed from
- <property>"Edit"</property> to
- <property>"View"</property>,
+ <property>edit</property> to
+ <property>view</property>,
a confirmation window with a message
"Are you sure you want to change value?" comes up.
</para>
@@ -302,12 +328,17 @@
<tbody>
<row>
<entry>ENTER</entry>
- <entry>Saves the input data, and changes the state from
"Edit" to "Changed"</entry>
+ <entry>Saves the input data, and changes the state from edit to
changed</entry>
</row>
<row>
<entry>ESC</entry>
- <entry>changes the state from "Edit" to
"View" or "Changed", value is not
affected</entry>
+ <entry>changes the state from edit to view or changed, value is not
affected</entry>
</row>
+
+ <row>
+ <entry>TAB</entry>
+ <entry>switches between the components</entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -334,7 +365,7 @@
<!--Sorting API -->
<row>
<entry>edit()</entry>
- <entry>changes the state to Edit </entry>
+ <entry>changes the state to edit </entry>
</row>
<row>
@@ -345,15 +376,15 @@
<row>
<entry>save()</entry>
- <entry>the component hanges the state to the previous one
before editing (Changed or View)</entry>
+ <entry>the component hanges the state to the previous one
before editing (changed or view)</entry>
</row>
<row>
<entry>save()</entry>
- <entry>the component changes its state to Changed with a new
value</entry>
+ <entry>the component changes its state to changed with a new
value</entry>
</row>
<row>
<entry>save()</entry>
- <entry>the component changes its state to Changed with a new
value</entry>
+ <entry>the component changes its state to changed with a new
value</entry>
</row>
<row>
<entry>getValue()</entry>
@@ -434,7 +465,7 @@
</table>
<table>
- <title>Skin parameters redefinition for "View"
state</title>
+ <title>Skin parameters redefinition for view state</title>
<tgroup cols="2">
<thead>
@@ -491,7 +522,7 @@
</table>
<table>
- <title>Classes names that define input field look and feel in
"Edit" state </title>
+ <title>Classes names that define input field look and feel in edit state
</title>
<tgroup cols="2">
<thead>
@@ -540,7 +571,7 @@
<table>
- <title>Class name for the "View" state</title>
+ <title>Class name for the view state</title>
<tgroup cols="2">
<thead>
<row>
@@ -551,12 +582,12 @@
<tbody>
<row>
<entry>rich-inplace-view</entry>
- <entry>Defines styles for the "View"
state</entry>
+ <entry>Defines styles for the view state</entry>
</row>
<row>
<entry>rich-inplace-input-view-hover</entry>
- <entry>Defines styles for hovered text in the "View"
state </entry>
+ <entry>Defines styles for hovered text in the view state
</entry>
</row>
</tbody>
@@ -569,7 +600,7 @@
<table>
- <title>Class name for the input field in "Edit"
state</title>
+ <title>Class name for the input field in edit state</title>
<tgroup cols="2">
<thead>
<row>
@@ -580,7 +611,7 @@
<tbody>
<row>
<entry>rich-inplace-field</entry>
- <entry>Defines styles for input field look and feel in
"Edit" state</entry>
+ <entry>Defines styles for input field look and feel in edit
state</entry>
</row>
</tbody>
@@ -687,7 +718,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>In the shown example the font in "Edit" state is
changed to bold.</para>
+ <para>In the shown example the font in <property>edit</property>
state is changed to bold.</para>