Author: msorokin Date: 2008-03-24 14:53:57 -0400 (Mon, 24 Mar 2008) New Revision: 7144 Modified: trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.xml Log: http://jira.jboss.com/jira/browse/RF-1226 jJS API added, some parts commented Modified: trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.xml 2008-03-24 18:40:51 UTC (rev 7143) +++ trunk/docs/userguide/en/src/main/docbook/included/inplaceInput.xml 2008-03-24 18:53:57 UTC (rev 7144) @@ -315,51 +315,60 @@ </section> <!-- End. Details of Usage--> - + + <!-- JavaScript API--> - <section> - <title>JavaScript API</title> - <table> - <title>JavaScript API</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Function</entry> - <entry>Description</entry> - - </row> - </thead> - <tbody> + <section> + <title>JavaScript API</title> + <table> + <title>JavaScript API</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Function</entry> + <entry>Description</entry> + + </row> + </thead> + <tbody> <!--Sorting API --> <row> - <entry>enable()</entry> - <entry>Begins polling for ajax mode </entry> + <entry>edit()</entry> + <entry>changes the state to Edit </entry> </row> <row> - <entry>disable()</entry> - <entry>Stops polling for ajax mode</entry> + <entry>cancel()</entry> + <entry>changes its state to the previous one before editing (changed or view)</entry> </row> <row> - <entry>setValue(value)</entry> - <entry>Updates the progress of the process</entry> - + <entry>save()</entry> + <entry>the component hanges the state to the previous one before editing (Changed or View)</entry> </row> <row> - <entry>setLabel(label)</entry> - <entry>Update the label for the process</entry> - + <entry>save()</entry> + <entry>the component changes its state to Changed with a new value</entry> </row> - - - - - </tbody> - </tgroup> - </table> - </section> + <row> + <entry>save()</entry> + <entry>the component changes its state to Changed with a new value</entry> + </row> + <row> + <entry>getValue()</entry> + <entry>gets the current value</entry> + </row> + + <row> + <entry>setValue(newValue)</entry> + <entry>sets the current value</entry> + </row> + + </tbody> + </tgroup> + </table> + </section> <!-- End of JavaScript API--> <!-- Look-and-Feel Customization--> @@ -372,17 +381,18 @@ <property>skin parameters.</property> </emphasis></para> <para>There are two ways to redefine the appearance of all <emphasis role="bold"> - <property>&lt;rich:progressBar&gt;</property> + <property>&lt;rich:inplaceInput&gt;</property> </emphasis> components at once: <itemizedlist> <listitem>Redefine the corresponding skin parameters</listitem> <listitem> Add to your style sheets style classes used by a <emphasis role="bold"> - <property>&lt;rich:progressBar&gt;</property> + <property>&lt;rich:inplaceInput&gt;</property> </emphasis> component</listitem> </itemizedlist> </para> </section> <!-- Skin Parameters Redefinition--> + <!-- <section> <title>Skin Parameters Redefinition</title> @@ -565,15 +575,16 @@ </table> - </section> + </section>--> <!-- END Skin Parameters Redefinition--> <!-- Definition of Custom Style Classes--> - +<!-- <section> <title>Definition of Custom Style Classes</title> <para>On the screenshot there are classes names that define styles for component elements.</para> - + + <figure> <title>Classes names</title> <mediaobject> @@ -581,9 +592,7 @@ <imagedata fileref="images/progressbarClasses.png"/> </imageobject> </mediaobject> - </figure> - - <table> + </figure> <table> <title>Classes names for the bar</title> <tgroup cols="2"> <thead> @@ -718,16 +727,16 @@ </figure> <para>As it could be seen on the picture above, the font style for output text was changed.</para> - - + </section> + --> + <section> <title>Relevant Resources Links</title> <para> <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/progressbar... you can see the example of <emphasis role="bold"> - <property>&lt;rich:progressBar&gt;</property> + <property>&lt;rich:inplaceIput&gt;</property> </emphasis> usage and sources for the given example. </para> - </section> </section> \ No newline at end of file