Author: lfryc(a)redhat.com Date: 2011-11-07 10:48:14 -0500 (Mon, 07 Nov 2011) New Revision: 22890 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richnotifyMessages-richnotifyMessages.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richnotifyMessage.xml Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richnotify.xml Log: RFPL-1580: added documentation for rich:notifyMessage/-s Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml 2011-11-07 15:47:57 UTC (rev 22889) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml 2011-11-07 15:48:14 UTC (rev 22890) @@ -334,12 +334,126 @@ <section id="sect-Component_Reference-richnotify-Style_classes_and_skin_parameters"> <title>Style classes and skin parameters</title> - <para>Note that skinning is common for both <sgmltag>&lt;rich:notify&gt;</sgmltag>, <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> and <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag></para> + <para> + Note that skinning is common for <sgmltag>&lt;rich:notify&gt;</sgmltag>, <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> and <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> + </para> <xi:include href="skinning/tabl-richnotify.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </section> </section> + <section id="sect-Component_Reference-Output_and_messages-richnotifyMessage"> + <title><sgmltag>&lt;rich:notifyMessage&gt;</sgmltag></title> + + <section id="sect-Component_Reference-richnotifyMessage-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> component is built on top of <sgmltag>&lt;rich:notify&gt;</sgmltag>, the difference is in usage of Faces messages system to define notifications. + </para> + <para> + Behavior does not differ from <sgmltag>&lt;rich:message&gt;</sgmltag>: one notification is displayed for first <code>FacesMessage</code> in stack, raisen either programatically or during component conversion/validation. + </para> + <para> + Notification icon and text color is determined by severity of message for which has been notification raised. + </para> + <para> + For customization of notifications behavior refer to Customizing notifications. + </para> + </section> + + <section id="sect-Component_Reference-richnotifyMessage-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.HtmlNotifyMessage</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlNotifyMessage</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>javax.faces.Message</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.NotifyMessageRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richnotifyMessage-Style_classes_and_skin_parameters"> + <title>Style classes and skin parameters</title> + <para> + Note that <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> shares common classes with <sgmltag>&lt;rich:notify&gt;</sgmltag>, since for each JSF message, exactly one notification is rendered. + </para> + <para> + The <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> specific classes are redefining look for various message severity levels. + </para> + <xi:include href="skinning/tabl-richnotifyMessage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </section> + </section> + <section id="sect-Component_Reference-Output_and_messages-richnotifyMessages"> + <title><sgmltag>&lt;rich:notifyMessages&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> component is same as <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag>, but all available messages are displayed instead of the first one only. + </para> + <para> + <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> shares the same set of attributes with <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag> + </para> + <figure id="figu-Component_Reference-richnotifyMessages-richnotifyMessages"> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richnotifyMessages-richnotifyMessages.png" width="300" height="222" format="PNG" /> + </imageobject> + <textobject> + <para> + The <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> component displaying four error messages. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richnotifyMessages-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.HtmlNotifyMessages</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlNotifyMessages</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>javax.faces.Messages</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.NotifyMessagesRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richnotifyMessages-Style_classes_and_skin_parameters"> + <title>Style classes and skin parameters</title> + <para> + <sgmltag>&lt;rich:notifyMessages&gt;</sgmltag> shares style classes with <sgmltag>&lt;rich:notifyMessage&gt;</sgmltag>. + </para> + </section> + </section> + + <!-- <rich:paint2D> --> <!-- Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richnotifyMessages-richnotifyMessages.png =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richnotifyMessages-richnotifyMessages.png (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richnotifyMessages-richnotifyMessages.png 2011-11-07 15:48:14 UTC (rev 22890) @@ -0,0 +1,61 @@ +�PNG + + +RU)
Ts,Y� �$�W ����kn����(Tٓ���sWIա��[�G��Nhߩ�x��J�6:t�z�Q0HA�����=a4A$�GLG��?;T��.U�ؾ�ߛ���֛�a)m�&:p� +,��"����K"�݈�|^�����ZE�ŋ���/$%8���O�%��9 +K)(!����TG�1�� +�8���w�,<��}�h�^�/M���v�v)�IQ5E���\��d�h*�x��@���S�^*�Б���.�F�U�dcy���� o�������ɋ��������7-����&���?���ˏ_z���UO�b��kCC�:��VC�/�9���P<��:NБctnT�vG
�;i�������.:v�jY�ENxbo����̢�.Zv��d1x�J�?�j�&�~UX�,�&<O�PG�|���Pt�iTUuBY����7:'QO�v��Y�j�z���% +R�M]��"�6:t�z�Q0HA�tB�������9a����H�`L1 �����P�c��U�c���~o���Zo2 +�d8�݈�N��o +x���:8�m��-��] +ڙ��:heX��qv����Qׄރ�n������J��'�D��&'��*d%oVi�YX��m
Y'ͤ�U�� +����8� {���w�:p�f�g��,�Z��:݅�2�
�� ���D�Z��J�kG�j��b����,L�0�sB�����`N�`0�2w�t�ƙ�@��`�tb�������X{��x!����ND�ݎI� ��f1�㱫�G����]�F�B��CcM�(�u۬��q���3w6;�`0'd0�2�sB�����`N�`0�2� �c +e0�:�fG�;�L�9!�����`0'd0>����zg��S��_�Dd0�(Nݸ!���!i��q���`��N]�����F��[A^�ԵkLGc�p��x��e��<���b� �$-�,$I:�>(��|0CQ��#�����/\��$l6�<�j�_m.]�ߏ�lݪ�õk�y<���Y��� +lق��[�"�K�(F��)++r��e��SW��t�pH_P`K􅅈F���b��� ���a0�x �۷�J�E
���X�� +D�����(.^�j��ۈDP\��[���g7nL +D��]�'}щGj���K��]��A0� D�a�ab"U��>��M���ʤ\/�[厌 ��Eoy#~��~�F���W���1�k�y'9��l0 +av +�z��1'�ǡ3p#P��"
?�7
Dzc����8��(ΩGB��L&<���G~������bhF�j�{]u�j�e2!µk((@<��)lڄhccI3]<�_e'��7�)��e�:ܼ�D���!����0vO�V���1��uaÆ�&��p�"�FLL����ftta\d�@����^U� +�^��-UC!�?�
SS����[�L�����}���N�'�X�{�[z�Qo2r�[�u}4F���ש���g��kl6+���u+�F�|�F��~���R�wB!ܼ �&�����uׯ#�ՊM��wfd~&f~�F�̒�b�ꝒV���ټ<��iܼ�X,�ɏ> +�SS����Grz%� ���m� %��܊�����L��-0��� 9��n��^�,�VY�ˑ�/�áPpfF���8����P�q�? +�9=M�Aq1&'1: +"C�Í���N�eY�sQ�C��Ȕ��m���-��S"?�avV��T�c���t�>}��_�����õ�B+��2��f�|�I�<=M��ٌk�*ˬ�zܸ
I�Ѩ\�e]����򜹄D��G�S��˗!JC�sG-3�dj +>��c�Ӹr�֡� +lb��X:��̅|>�k��.]������:t�K_�R~~>�qF���y�e�lb��X
�_�^]]�t:�o�����d2}������G"****..N���"!���Hh�Z�y������ٺ���/�t:�������4�$�q +�� +�""���l��#"�y����*��wUX��S*�J �]����"���(H��2'�쥆}�@�]�Εb�~_R�=d� ���v��9M;G�cj�ѡ�4Нd�,7��j���3��@K)�*#� +�ͬ�G�;����}{3� ���~e�l�2(:v.�����a��~�/I��;��Tifiu�K�QCY�cB(s��/6(�M�Uժ�PUU(s*੬JR�i׉����2E�S����J����#�)u3ۨ�H�1�V�U�dcyƄ܇�綧�W.\��G�~�w6��񈱰@^� ����Gg�_���O=�u���w����8�k�O~������g�;1Эst��2/�~h�6����P艟�ܼѬ7J�..�.�<ϼ��;l۶1A�n8����g�.4e�J�H(316���^�˟p�$� +<���ݻ7��LJc�"��:���_��"g{���ߴ�I�`���h"�%%_|�%&����~f��Vͯ,�%�v�Z�W��,sV6�ce�l�]ǁ�j�{!�S�%����z.%@�Oq$d�ud�[pצ H^4�H +B6�����N�#�J�R0�,%O�4�E<O|)����j�S����q]���f��I΅�ܻ�^:˯�U<,VI�����:��������I +B��)s�ü� + +Q��x
��u�W��g_��ZHNɸ�_s͇O�s٣�~�l�L�d�4Ӷ�� 3YHDKje�S½�������K���:���<��(Vo�De�|VY�)�&=h�X��qv����Qׄރ�n������*�g�t�y��HHnrb��BV�f����ei��er�6M� @@m5� \ No newline at end of file Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richnotify.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richnotify.xml 2011-11-07 15:47:57 UTC (rev 22889) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richnotify.xml 2011-11-07 15:48:14 UTC (rev 22890) @@ -33,92 +33,8 @@ </entry> <entry spanname="noskin">No skin parameters.</entry> </row> - - <row> - <entry> - <variablelist> - <varlistentry> - <term><classname>.rf-ntf-info</classname></term> - <listitem> - <para> - This class defines styles for an informative message. - </para> - </listitem> - </varlistentry> - </variablelist> - </entry> - <entry><para><parameter>generalTextColor</parameter></para></entry> - <entry><para><property>color</property></para></entry> - </row> - - <row> - <entry> - <variablelist> - <varlistentry> - <term><classname>.rf-ntf-warn</classname></term> - <listitem> - <para> - This class defines styles for a warning notifications. - </para> - </listitem> - </varlistentry> - </variablelist> - </entry> - <entry spanname="noskin">No skin parameters.</entry> - </row> <row> - <entry> - <variablelist> - <varlistentry> - <term><classname>.rf-ntf-error</classname></term> - <listitem> - <para> - This class defines styles for a error notifications. - </para> - </listitem> - </varlistentry> - </variablelist> - </entry> - <entry spanname="noskin">No skin parameters.</entry> - </row> - - <row> - <entry> - <variablelist> - <varlistentry> - <term><classname>.rf-ntf-fatal</classname></term> - <listitem> - <para> - This class defines styles for a fatal notifications. - </para> - </listitem> - </varlistentry> - </variablelist> - </entry> - <entry spanname="noskin">No skin parameters.</entry> - </row> - - <row> - <entry> - <variablelist> - <varlistentry> - <term><classname>.rf-ntf-info .rf-ntf-ico</classname></term> - <term><classname>.rf-ntf-warn .rf-ntf-ico</classname></term> - <term><classname>.rf-ntf-error .rf-ntf-ico</classname></term> - <term><classname>.rf-ntf-fatal .rf-ntf-ico</classname></term> - <listitem> - <para> - These classes define style for notification icon based on severity of notification message. - </para> - </listitem> - </varlistentry> - </variablelist> - </entry> - <entry spanname="noskin">No skin parameters.</entry> - </row> - - <row> <entry morerows="1"> <variablelist> <varlistentry> Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richnotifyMessage.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richnotifyMessage.xml (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/tabl-richnotifyMessage.xml 2011-11-07 15:48:14 UTC (rev 22890) @@ -0,0 +1,107 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE table PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> + +<table id="tabl-richnotifyMessage-Style_classes_and_corresponding_skin_parameters"> + <title>Style classes (selectors) and corresponding skin parameters</title> + <tgroup cols="3"> + <colspec colname="class"/> + <colspec colname="skin"/> + <colspec colname="css"/> + <spanspec spanname="noskin" namest="skin" nameend="css"/> + <thead> + <row> + <entry>Class (selector)</entry> + <entry>Skin Parameters</entry> + <entry>Mapped <acronym>CSS</acronym> properties</entry> + </row> + </thead> + <tbody> + + <row> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rf-ntf-info</classname></term> + <listitem> + <para> + This class defines styles for an informative message. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> + <entry><para><parameter>generalTextColor</parameter></para></entry> + <entry><para><property>color</property></para></entry> + </row> + + <row> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rf-ntf-warn</classname></term> + <listitem> + <para> + This class defines styles for a warning notifications. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> + <entry spanname="noskin">No skin parameters.</entry> + </row> + + <row> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rf-ntf-error</classname></term> + <listitem> + <para> + This class defines styles for a error notifications. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> + <entry spanname="noskin">No skin parameters.</entry> + </row> + + <row> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rf-ntf-fatal</classname></term> + <listitem> + <para> + This class defines styles for a fatal notifications. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> + <entry spanname="noskin">No skin parameters.</entry> + </row> + + <row> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rf-ntf-info .rf-ntf-ico</classname></term> + <term><classname>.rf-ntf-warn .rf-ntf-ico</classname></term> + <term><classname>.rf-ntf-error .rf-ntf-ico</classname></term> + <term><classname>.rf-ntf-fatal .rf-ntf-ico</classname></term> + <listitem> + <para> + These classes define style for notification icon based on severity of notification message. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> + <entry spanname="noskin">No skin parameters.</entry> + </row> + + </tbody> + </tgroup> +</table>