Author: SeanRogers
Date: 2010-10-06 21:54:46 -0400 (Wed, 06 Oct 2010)
New Revision: 19485
Added:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richlist-Data_definition_list.xml_sample
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richlist-richlist_example.xml_sample
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richlist-Data_definition_list.png
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richlist-Ordered_list.png
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richlist-Unordered_list.png
Removed:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataOrderedList_example.png
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataList-richdataList_example.png
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml
Log:
Made minor tech review updates for inplaceInput, tabPanel, inputNumberSpinner,
collapsiblePanel, list
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-10-06
23:10:52 UTC (rev 19484)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-10-07
01:54:46 UTC (rev 19485)
@@ -491,12 +491,14 @@
<section
id="sect-Component_Reference-richcollapsiblePanel-Basic_usage">
<title>Basic usage</title>
<para>
- Basic usage requires only the <varname>label</varname> attribute to be
specified, which provides the title for the header element.
+ Basic usage requires the <varname>header</varname> attribute to be
specified, which provides the title for the header element. Additionally the panel
requires content to display when it is expanded. Content is added as child elements like a
standard panel.
</para>
</section>
-
+
<section
id="sect-Component_Reference-richcollapsiblePanel-Expanding_and_collapsing_the_panel">
<title>Expanding and collapsing the panel</title>
+ <!-- TODO not in M3 -->
+ <!--
<para>
If the <sgmltag><rich:collapsiblePanel></sgmltag> component
uses <code><varname>expanded</varname>="true"</code>,
the panel is open and expanded, otherwise it is closed and collapsed.
</para>
@@ -505,7 +507,7 @@
</para>
<variablelist>
<varlistentry>
- <term><literal>heading</literal></term>
+ <term><literal>header</literal></term>
<listitem>
<para>
This is the default setting. Clicking anywhere on the header of the panel will
cause it to expand or collapse.
@@ -529,6 +531,7 @@
</listitem>
</varlistentry>
</variablelist>
+ -->
<para>
The switching mode for performing submissions is determined by the
<varname>switchType</varname> attribute, which can have one of the following
three values:
</para>
@@ -638,7 +641,7 @@
<section id="sect-Component_Reference-richtab-Basic_usage">
<title>Basic usage</title>
<para>
- Basic usage of the <sgmltag><rich:tab></sgmltag> component
requires the <varname>label</varname> attribute, which provides the text on
the tab header. The content of the tab is then detailed inside the
<sgmltag><rich:tab></sgmltag> tags.
+ Basic usage of the <sgmltag><rich:tab></sgmltag> component
requires the <varname>header</varname> attribute, which provides the text on
the tab header. The content of the tab is then detailed inside the
<sgmltag><rich:tab></sgmltag> tags.
</para>
<para>
Alternatively the <literal>header</literal> facet could be used in place
of the <varname>label</varname> attribute. This would allow for additional
styles and custom content to be applied to the tab.
@@ -648,12 +651,14 @@
<section id="sect-Component_Reference-richtab-Switching_tabs">
<title>Switching tabs</title>
<para>
- The switching mode for performing submissions can be inherited from the
<varname>switchMode</varname> attribute of the parent
<sgmltag><rich:tabPanel></sgmltag> component, or set
individually for each <sgmltag><rich:tab></sgmltag> component.
Refer to <xref
linkend="sect-Component_Reference-Panels_and_containers-richtabPanel" /> for
details on the <varname>switchMode</varname> attribute.
+ The switching mode for performing submissions can be inherited from the
<varname>switchType</varname> attribute of the parent
<sgmltag><rich:tabPanel></sgmltag> component, or set
individually for each <sgmltag><rich:tab></sgmltag> component.
Refer to <xref
linkend="sect-Component_Reference-Panels_and_containers-richtabPanel" /> for
details on the <varname>switchType</varname> attribute.
</para>
<para>
An individual tab can be disabled by setting
<code><varname>disabled</varname>="true"</code>.
Disabled tabs cannot be activated or switched to.
</para>
</section>
+
+ <!-- FIXME details on header facets -->
<section
id="sect-Component_Reference-richtab-richtab_client-side_events">
<title><sgmltag><rich:tab></sgmltag> client-side
events</title>
@@ -770,7 +775,11 @@
The <code>activeItem</code> attribute holds the active tab name.
</para>
</section>
-
+
+ <!-- FIXME details on name attribute -->
+
+ <!-- TODO not in M3 -->
+ <!--
<section
id="sect-Component_Reference-richtabPanel-Tab_position_and_alignment">
<title>Tab position and alignment</title>
<para>
@@ -856,6 +865,7 @@
</varlistentry>
</variablelist>
</section>
+ -->
<section
id="sect-Component_Reference-richtabPanel-richtabPanel_client-side_events">
<title><sgmltag><rich:tabPanel></sgmltag> client-side
events</title>
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-10-06
23:10:52 UTC (rev 19484)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-10-07
01:54:46 UTC (rev 19485)
@@ -378,7 +378,7 @@
<section id="sect-Component_Reference-Rich_inputs-richinplaceInput">
<title><sgmltag><rich:inplaceInput></sgmltag></title>
<para>
- The <sgmltag><rich:inplaceInput></sgmltag> component allows
information to be entered in-line in blocks of text, improving readability of the text.
Changes can be rendered either in-line or for the whole block, and inputs can be focused
with keyboard navigation. The component has three functional states: the "view"
state, where the component displays its initial setting, such as "click to
edit"; the "edit" state, where the user can input text; and the
"changed" state, where the new value for the component has been confirmed but
can be edited again if required.
+ The <sgmltag><rich:inplaceInput></sgmltag> component allows
information to be entered in-line in blocks of text, improving readability of the text.
Multiple input regions can be navigated with keyboard navigation. The component has three
functional states: the "view" state, where the component displays its initial
setting, such as "click to edit"; the "edit" state, where the user can
input text; and the "changed" state, where the new value for the component has
been confirmed but can be edited again if required.
</para>
<section id="sect-Component_Reference-richinplaceInput-Basic_usage">
@@ -399,9 +399,14 @@
By default, the event to switch the component to the "edit" state is a
single mouse click. This can be changed using the <varname>editEvent</varname>
attribute to specify a different event.
</para>
<para>
- The user can confirm and save their input by pressing the
<keycap>Enter</keycap> key or cancel by pressing the
<keycap>Esc</keycap> key. Alternatively, buttons for confirming or canceling
can be added to the component by setting
<code>showControls="true"</code>. These buttons can be positioned
using the <varname>controlsHorizontalPosition</varname> attribute with
settings of <literal>left</literal>, <literal>right</literal>, or
<literal>center</literal>, and the
<varname>controlsVerticalPosition</varname> attribute with settings
<literal>bottom</literal>, <literal>center</literal>, or
<literal>top</literal>. The confirmation control icons can be altered using
the <varname>saveControlIcon</varname> and
<varname>cancelControlIcon</varname>. Further customization is possible
through the use of facets.
+ The user can confirm and save their input by pressing the
<keycap>Enter</keycap> key or cancel by pressing the
<keycap>Esc</keycap> key. Alternatively, buttons for confirming or canceling
can be added to the component by setting
<code>showControls="true"</code>.
+ <!-- TODO not in M3
+ These buttons can be positioned using the
<varname>controlsHorizontalPosition</varname> attribute with settings of
<literal>left</literal>, <literal>right</literal>, or
<literal>center</literal>, and the
<varname>controlsVerticalPosition</varname> attribute with settings
<literal>bottom</literal>, <literal>center</literal>, or
<literal>top</literal>. The confirmation control icons can be altered using
the <varname>saveControlIcon</varname> and
<varname>cancelControlIcon</varname>. Further customization is possible
through the use of facets.
+ -->
</para>
</section>
+
+ <!-- FIXME default label functionality -->
<!-- TODO not in M3
<section
id="sect-Component_Reference-richinplaceInput-richinplaceInput_events">
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-10-06
23:10:52 UTC (rev 19484)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-10-07
01:54:46 UTC (rev 19485)
@@ -965,7 +965,7 @@
<title>Unordered list</title>
<mediaobject>
<imageobject>
- <imagedata
fileref="images/figu-Component_Reference-richdataList-richdataList_example.png"
format="PNG" />
+ <imagedata
fileref="images/figu-Component_Reference-richlist-Unordered_list.png"
format="PNG" />
</imageobject>
<textobject>
<para>
@@ -986,7 +986,7 @@
<title>Ordered list</title>
<mediaobject>
<imageobject>
- <imagedata
fileref="images/figu-Component_Reference-Tables_and_grids-richdataOrderedList_example.png"
format="PNG" />
+ <imagedata
fileref="images/figu-Component_Reference-richlist-Ordered_list.png"
format="PNG" />
</imageobject>
<textobject>
<para>
@@ -998,16 +998,23 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>data</literal></term>
+ <term><literal>definitions</literal></term>
<listitem>
<para>
The list is presented as a series of data definitions. Part of the data model,
specified as the term, is listed prominently. The other associated data is listed after
each term.
</para>
+ <para>
+ The term is marked using the <literal>term</literal> facet. The facet
is required for all definition lists. Use of the facet is shown in <xref
linkend="exam-Component_Reference-richlist-Data_definition_list" />.
+ </para>
+ <example
id="exam-Component_Reference-richlist-Data_definition_list">
+ <title>Data definition list</title>
+ <programlisting language="XML" role="XML"><xi:include
parse="text"
href="extras/exam-Component_Reference-richlist-Data_definition_list.xml_sample"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
+ </example>
<figure
id="figu-Component_Reference-richlist-Data_definition_list">
<title>Data definition list</title>
<mediaobject>
<imageobject>
- <imagedata
fileref="images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png"
format="PNG" />
+ <imagedata
fileref="images/figu-Component_Reference-richlist-Data_definition_list.png"
format="PNG" />
</imageobject>
<textobject>
<para>
@@ -1117,17 +1124,17 @@
<section id="sect-Component_Reference-richlist-Customizing_the_list">
<title>Customizing the list</title>
<para>
- The <varname>first</varname> attribute specifies which item in the data
model to start from, and the <varname>rows</varname> attribute specifies the
number of items to list. The <varname>title</varname> attribute is used for a
floating tool-tip. <xref
linkend="exam-Component_Reference-richlist-richlist_example" /> shows a
simple example using the <sgmltag><rich:dataList></sgmltag>
component.
+ The <varname>first</varname> attribute specifies which item in the data
model to start from, and the <varname>rows</varname> attribute specifies the
number of items to list. The <varname>title</varname> attribute is used for a
floating tool-tip. <xref
linkend="exam-Component_Reference-richlist-richlist_example" /> shows a
simple example using the <sgmltag><rich:list></sgmltag>
component.
</para>
<example id="exam-Component_Reference-richlist-richlist_example">
<title><sgmltag><rich:list></sgmltag>
example</title>
- <programlisting language="XML" role="XML"><xi:include
href="extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
+ <programlisting language="XML" role="XML"><xi:include
href="extras/exam-Component_Reference-richlist-richlist_example.xml_sample"
parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude"
/></programlisting>
<blockquote>
<figure id="figu-Component_Reference-richlist-richlist_example">
<title><sgmltag><rich:list></sgmltag>
example</title>
<mediaobject>
<imageobject>
- <imagedata
fileref="images/figu-Component_Reference-richdataList-richdataList_example.png"
format="PNG" />
+ <imagedata
fileref="images/figu-Component_Reference-richlist-Unordered_list.png"
format="PNG" />
</imageobject>
<textobject>
<para>
Deleted:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample 2010-10-06
23:10:52 UTC (rev 19484)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample 2010-10-07
01:54:46 UTC (rev 19485)
@@ -1,11 +0,0 @@
-<h:form>
- <rich:dataDefinitionList var="car"
value="#{dataTableScrollerBean.allCars}" rows="5" first="4"
title="Cars">
- <f:facet name="term">
- <h:outputText value="#{car.make}
#{car.model}"></h:outputText>
- </f:facet>
- <h:outputText value="Price:"
styleClass="label"></h:outputText>
- <h:outputText value="#{car.price}" /><br/>
- <h:outputText value="Mileage:"
styleClass="label"></h:outputText>
- <h:outputText value="#{car.mileage}" /><br/>
- </rich:dataDefinitionList>
-</h:form>
Deleted:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample 2010-10-06
23:10:52 UTC (rev 19484)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample 2010-10-07
01:54:46 UTC (rev 19485)
@@ -1,9 +0,0 @@
-<h:form>
- <rich:dataList var="car"
value="#{dataTableScrollerBean.allCars}" rows="5"
type="unordered" title="Car Store">
- <h:outputText value="#{car.make} #{car.model}"/><br/>
- <h:outputText value="Price:"
styleClass="label"></h:outputText>
- <h:outputText value="#{car.price} "/><br/>
- <h:outputText value="Mileage:"
styleClass="label"></h:outputText>
- <h:outputText value="#{car.mileage} "/><br/>
- </rich:dataList>
-</h:form>
Copied:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richlist-Data_definition_list.xml_sample
(from rev 19482,
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample)
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richlist-Data_definition_list.xml_sample
(rev 0)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richlist-Data_definition_list.xml_sample 2010-10-07
01:54:46 UTC (rev 19485)
@@ -0,0 +1,11 @@
+<h:form>
+ <rich:list var="car" value="#{dataTableScrollerBean.allCars}"
type="definitions" rows="5" title="Cars">
+ <f:facet name="term">
+ <h:outputText value="#{car.make}
#{car.model}"></h:outputText>
+ </f:facet>
+ <h:outputText value="Price:"
styleClass="label"></h:outputText>
+ <h:outputText value="#{car.price}" /><br/>
+ <h:outputText value="Mileage:"
styleClass="label"></h:outputText>
+ <h:outputText value="#{car.mileage}" /><br/>
+ </rich:list>
+</h:form>
Copied:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richlist-richlist_example.xml_sample
(from rev 19482,
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample)
===================================================================
---
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richlist-richlist_example.xml_sample
(rev 0)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richlist-richlist_example.xml_sample 2010-10-07
01:54:46 UTC (rev 19485)
@@ -0,0 +1,9 @@
+<h:form>
+ <rich:list var="car" value="#{dataTableScrollerBean.allCars}"
rows="5" type="unordered" title="Car Store">
+ <h:outputText value="#{car.make} #{car.model}"/><br/>
+ <h:outputText value="Price:"
styleClass="label"></h:outputText>
+ <h:outputText value="#{car.price} "/><br/>
+ <h:outputText value="Mileage:"
styleClass="label"></h:outputText>
+ <h:outputText value="#{car.mileage} "/><br/>
+ </rich:list>
+</h:form>
Deleted:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png
===================================================================
(Binary files differ)
Deleted:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataOrderedList_example.png
===================================================================
(Binary files differ)
Deleted:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataList-richdataList_example.png
===================================================================
(Binary files differ)
Copied:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richlist-Data_definition_list.png
(from rev 19482,
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png)
===================================================================
(Binary files differ)
Copied:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richlist-Ordered_list.png
(from rev 19482,
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-Tables_and_grids-richdataOrderedList_example.png)
===================================================================
(Binary files differ)
Copied:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richlist-Unordered_list.png
(from rev 19482,
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richdataList-richdataList_example.png)
===================================================================
(Binary files differ)