From richfaces-svn-commits at lists.jboss.org Thu Mar 17 22:09:24 2011 Content-Type: multipart/mixed; boundary="===============8062668961980410730==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r22259 - in modules/docs/trunk/Component_Reference/src/main/docbook/en-US: skinning and 1 other directory. Date: Thu, 17 Mar 2011 22:09:24 -0400 Message-ID: <201103180209.p2I29Olu022743@svn01.web.mwc.hst.phx2.redhat.com> --===============8062668961980410730== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2011-03-17 22:09:23 -0400 (Thu, 17 Mar 2011) New Revision: 22259 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/t= abl-richmessage.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/t= abl-richprogressBar.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/t= abl-richtooltip.xml Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Output_and_messages.xml Log: Added output skinning references - RFPL-1235 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Output_and_messages.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Output_and_messages.xml 2011-03-18 01:28:20 UTC (rev 22258) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Output_and_messages.xml 2011-03-18 02:09:23 UTC (rev 22259) @@ -124,6 +124,11 @@ + +
+ Style classes and skin parameters + +
= @@ -243,6 +248,13 @@ + +
+ Style classes and skin parameters + + The <rich:messages> component uses the same s= tyling as the <rich:message> component. Refer to <= xref linkend=3D"sect-Component_Reference-richmessage-Style_classes_and_skin= _parameters" /> for details. + +
= @@ -506,37 +518,42 @@ + +
+ Style classes and skin parameters + +
= - -
- <sgmltag><rich:toolTip></sgmltag> + +
+ <sgmltag><rich:tooltip></sgmltag> - The <rich:toolTip> component provides an infor= mational tool-tip. The tool-tip can be attached to any control and is displ= ayed when hovering the mouse cursor over the control. + The <rich:tooltip> component provides an infor= mational tool-tip. The tool-tip can be attached to any control and is displ= ayed when hovering the mouse cursor over the control. -
- <sgmltag><rich:toolTip></sgmltag> +
+ <sgmltag><rich:tooltip></sgmltag> - A <rich:toolTip> component, displayed while= hovering the mouse cursor over a button control. + A <rich:tooltip> component, displayed while= hovering the mouse cursor over a button control.
= -
+
Basic usage - For basic usage, define the tool-tip text using the value attribute. The <rich:toolTip> component is = then automatically attached to the parent element, and is usually shown whe= n the mouse cursor hovers. + For basic usage, define the tool-tip text using the value attribute. The <rich:tooltip> component is = then automatically attached to the parent element, and is usually shown whe= n the mouse cursor hovers. - Alternatively, the content of the tool-tip can be defined inside the <= sgmltag><rich:toolTip> tags, and the value attribute is not used. This allows HTML tags to be used to define the co= ntent, and provides for rich content such as images, links, buttons, and ot= her RichFaces components. + Alternatively, the content of the tool-tip can be defined inside the <= sgmltag><rich:tooltip> tags, and the value attribute is not used. This allows HTML tags to be used to define the co= ntent, and provides for rich content such as images, links, buttons, and ot= her RichFaces components. - + Defining tool-tip content @@ -555,28 +572,28 @@
= -
+
Attaching the tool-tip to another component - If not otherwise specified, the tool-tip is attached to the parent ele= ment in which it is defined. The for attribute is used t= o attach the tool-tip to another component, pointing to the target componen= t's id identifier. This allows the <rich:too= lTip> component to be specified outside the target element. Th= is approach is demonstrated in . + If not otherwise specified, the tool-tip is attached to the parent ele= ment in which it is defined. The for attribute is used t= o attach the tool-tip to another component, pointing to the target componen= t's id identifier. This allows the <rich:too= ltip> component to be specified outside the target element. Th= is approach is demonstrated in . - + Attaching the tool-tip - The <rich:toolTip> component can alternativel= y be left unattached, and is instead invoked through an event handler on th= e target component. To leave the <rich:toolTip> co= mponent unattached, set attached=3D"false", and define the eve= nt handler to trigger the tool-tip on the target component. This approach i= s demonstrated in . When leaving the <rich:toolTip> component unattached, ensure it has an id identifie= r defined. If the <rich:toolTip> component is nest= ed inside the target element, it must be the last child. If it is defined o= utside the target element, it must be nested in an <a4j:form>= ; component. + The <rich:tooltip> component can alternativel= y be left unattached, and is instead invoked through an event handler on th= e target component. To leave the <rich:tooltip> co= mponent unattached, set attached=3D"false", and define the eve= nt handler to trigger the tool-tip on the target component. This approach i= s demonstrated in . When leaving the <rich:tooltip> component unattached, ensure it has an id identifie= r defined. If the <rich:tooltip> component is nest= ed inside the target element, it must be the last child. If it is defined o= utside the target element, it must be nested in an <a4j:form>= ; component. - + Unattached tool-tips
= -
+
Appearance - By default, the <rich:toolTip> component is p= ositioned intelligently based on the position of the mouse cursor. Use the = direction attribute to specify a corner of the target co= mponent at which to display the tool-tip instead. Possible values include <= literal>top-left, top-right, bottom-l= eft, and bottom-right. Use the horizo= ntalOffset and verticalOffset attributes to sp= ecify the horizontal offset and vertical offset at which to display the too= l-tip. + By default, the <rich:tooltip> component is p= ositioned intelligently based on the position of the mouse cursor. Use the = direction attribute to specify a corner of the target co= mponent at which to display the tool-tip instead. Possible values include <= literal>top-left, top-right, bottom-l= eft, and bottom-right. Use the horizo= ntalOffset and verticalOffset attributes to sp= ecify the horizontal offset and vertical offset at which to display the too= l-tip. Use the hideEvent attribute to specify when the too= l-tip is hidden. The default value is none, so the tool-= tip remains shown. However, it can be linked to an event on the target comp= onent, such as the mouseout event. @@ -585,11 +602,11 @@ Set followMouse=3D"true" to cause the tool-tip to follow = the user's mouse movements. - Advanced appearance features are demonstrated in . + Advanced appearance features are demonstrated in .
= -
+
Update mode The mode for updating the tool-tip is determined by the mode<= /varname> attribute, which can have one of the following values: @@ -615,16 +632,16 @@ When using mode=3D"ajax", define the defaultCont= ent facet. The tool-tip displays the content of the defa= ultContent facet while loading the actual content from the server. - + Advanced tool-tip usage
= -
- <sgmltag><rich:toolTip></sgmltag> client-side events</titl= e> + <section id=3D"sect-Component_Reference-richtooltip-richtooltip_client-s= ide_events"> + <title><sgmltag><rich:tooltip></sgmltag> client-side events</titl= e> <para> - The <sgmltag><rich:toolTip></sgmltag> component supports the fol= lowing client-side events: + The <sgmltag><rich:tooltip></sgmltag> component supports the fol= lowing client-side events: </para> <variablelist> <varlistentry> @@ -694,10 +711,10 @@ </variablelist> </section> = - <section id=3D"sect-Component_Reference-richtoolTip-JavaScript_API"> + <section id=3D"sect-Component_Reference-richtooltip-JavaScript_API"> <title>JavaScript API - The <rich:toolTip> component can be contr= olled through the JavaScript API. The JavaScript API provides the following= functions: + The <rich:tooltip> component can be contr= olled through the JavaScript API. The JavaScript API provides the following= functions: @@ -719,36 +736,41 @@
= -
+
Reference data - component-type: org.richfaces.comp= onent.toolTip + component-type: org.richfaces.comp= onent.tooltip - component-class: org.richfaces.com= ponent.html.HtmlToolTip + component-class: org.richfaces.com= ponent.html.HtmlTooltip - component-family: org.richfaces.co= mponent.toolTip + component-family: org.richfaces.co= mponent.tooltip - renderer-type: org.richfaces.rende= rkit.html.toolTipRenderer + renderer-type: org.richfaces.rende= rkit.html.tooltipRenderer - tag-class: org.richfaces.taglib.Ht= mlToolTipTag + tag-class: org.richfaces.taglib.Ht= mlTooltipTag
+ +
+ Style classes and skin parameters + +
=
Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinni= ng/tabl-richmessage.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/= tabl-richmessage.xml (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/= tabl-richmessage.xml 2011-03-18 02:09:23 UTC (rev 22259) @@ -0,0 +1,146 @@ + + + + + Style classes (selectors) and corresponding skin parameters + + + + + + + + Class (selector) + Skin Parameters + Mapped CSS properties + + + + = + + + + + .rf-msg + + + This class defines styles for the message itself. + + + + + + generalFamilyFont + font-family + + + generalSizeFont + font-size + + = + + + + + .rf-msg-err + + + This class defines styles for an error message. + + + + + + errorColor + color + + = + + + + + .rf-msg-ftl + + + This class defines styles for a fatal message. + + + + + + errorColor + color + + = + + + + + .rf-msg-inf + + + This class defines styles for an information message. + + + + + + generalTextColor + color + + = + + + + + .rf-msg-wrn + + + This class defines styles for a warning message. + + + + + + warningTextColor + color + + = + + + + + .rf-msg-ok + + + This class defines styles for a basic OK mes= sage. + + + + + + generalTextColor + color + + = + + + + + .rf-msg-sum + .rf-msg-det + + + These classes define styles for the summary or details of a messa= ge. + + + + + + No skin parameters. + + = + + +
Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinni= ng/tabl-richprogressBar.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/= tabl-richprogressBar.xml (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/= tabl-richprogressBar.xml 2011-03-18 02:09:23 UTC (rev 22259) @@ -0,0 +1,86 @@ + + + + + Style classes (selectors) and corresponding skin parameters + + + + + + + + Class (selector) + Skin Parameters + Mapped CSS properties + + + + = + + + + + .rf-pb-lbl + + + This class defines styles for labels on the progress bar. + + + + + + No skin parameters. + + = + + + + + .rf-pb-prgs + + + This class defines styles for the progressed portion of the progr= ess bar. + + + + + + panelBorderColor + border-color + + + selectControlColor + background-color + + = + + + + + .rf-pb-init + .rf-pb-fin + + + These classes define styles for the initial state and finished st= ate. + + + + + + generalTextColor + color + + + generalFamilyFont + font-family + + + generalSizeFont + font-size + + = + + +
Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinni= ng/tabl-richtooltip.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/= tabl-richtooltip.xml (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/= tabl-richtooltip.xml 2011-03-18 02:09:23 UTC (rev 22259) @@ -0,0 +1,96 @@ + + + + + Style classes (selectors) and corresponding skin parameters + + + + + + + + Class (selector) + Skin Parameters + Mapped CSS properties + + + + = + + + + + .rf-tt + + + This class defines styles for the tool-tip itself. + + + + + + No skin parameters. + + = + + + + + .rf-tt-loading + + + This class defines styles for the tool-tip when it is loading. + + + + + + No skin parameters. + + = + + + + + .rf-tt-cnt + + + This class defines styles for the tool-tip content. + + + + + + No skin parameters. + + = + + + + + .rf-tt-cntr + + + This class defines styles for the progressed portion of the progr= ess bar. + + + + + + tipBorderColor + border-color + + + generalFamilyFont + font-family + + + generalSizeFont + font-size + + = + + +
--===============8062668961980410730==--