Author: SeanRogers
Date: 2010-10-07 02:22:36 -0400 (Thu, 07 Oct 2010)
New Revision: 19487
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
Log:
Updated tab and tabPanel based on tech review
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-07
05:47:33 UTC (rev 19486)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-10-07
06:22:36 UTC (rev 19487)
@@ -641,11 +641,47 @@
<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>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.
+ Basic usage of the <sgmltag><rich:tab></sgmltag> component
requires the <varname>name</varname> attribute to uniquely identify the tab
within the parent <sgmltag><rich:tabPanel></sgmltag> component.
As the tabs are switched, the <varname>name</varname> identifier of the
currently selected tab is stored in the <varname>activeItem</varname>
attribute of the parent <sgmltag><rich:tabPanel></sgmltag>
component.
</para>
+ </section>
+
+ <section id="sect-Component_Reference-richtab-Header_labeling">
+ <title>Header labeling</title>
<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.
+ In addition to the <varname>name</varname> identifier, the
<varname>header</varname> attribute must be defined. The
<varname>header</varname> attribute 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>header</varname> attribute. This would allow for additional
styles and custom content to be applied to the tab. The component also supports three
facets to customize the appearance depending on the current state of the tab:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><literal>headerActive</literal> facet</term>
+ <listitem>
+ <para>
+ This facet is used when the tab is the currently active tab.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>headerInactive</literal> facet</term>
+ <listitem>
+ <para>
+ This facet is used when the tab is not currently active.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>headerDisabled</literal> facet</term>
+ <listitem>
+ <para>
+ This facet is used when the tab is disabled.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ The <literal>header</literal> facet is used in place of any state-based
facet that has not been defined.
+ </para>
</section>
<section id="sect-Component_Reference-richtab-Switching_tabs">
@@ -657,8 +693,6 @@
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>
@@ -743,6 +777,9 @@
<section id="sect-Component_Reference-richtabPanel-Switching_tabs">
<title>Switching panels</title>
<para>
+ The <code>activeItem</code> attribute holds the active tab name. This
name is a reference to the <varname>name</varname> identifier of the active
child <sgmltag><rich:tab></sgmltag> component.
+ </para>
+ <para>
The switching mode for performing submissions is determined by the
<code>switchType</code> attribute, which can have one of the following three
values:
</para>
<variablelist>
@@ -771,9 +808,6 @@
</listitem>
</varlistentry>
</variablelist>
- <para>
- The <code>activeItem</code> attribute holds the active tab name.
- </para>
</section>
<!-- FIXME details on name attribute -->
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-07
05:47:33 UTC (rev 19486)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-10-07
06:22:36 UTC (rev 19487)
@@ -407,8 +407,6 @@
-->
</para>
</section>
-
- <!-- FIXME default label functionality -->
<!-- TODO not in M3
<section
id="sect-Component_Reference-richinplaceInput-richinplaceInput_events">