From richfaces-svn-commits at lists.jboss.org Thu Apr 9 11:56:40 2009 Content-Type: multipart/mixed; boundary="===============3609147600839108274==" 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: r13475 - trunk/docs/userguide/en/src/main/docbook/included. Date: Thu, 09 Apr 2009 11:56:40 -0400 Message-ID: --===============3609147600839108274== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: ochikvina Date: 2009-04-09 11:56:40 -0400 (Thu, 09 Apr 2009) New Revision: 13475 Modified: trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml Log: https://jira.jboss.org/jira/browse/RF-5730 - adding links to RichFaces cook= book articles; Modified: trunk/docs/userguide/en/src/main/docbook/included/jsFunction.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 --- trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2009-0= 4-09 15:52:25 UTC (rev 13474) +++ trunk/docs/userguide/en/src/main/docbook/included/jsFunction.xml 2009-0= 4-09 15:56:40 UTC (rev 13475) @@ -122,7 +122,7 @@ Relevant resources links + url=3D"http://www.jboss.org/community/docs/DOC-11856"> Here you can find additional information and example on how to use Modified: trunk/docs/userguide/en/src/main/docbook/included/modalPanel.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 --- trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2009-0= 4-09 15:52:25 UTC (rev 13474) +++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2009-0= 4-09 15:56:40 UTC (rev 13475) @@ -118,16 +118,16 @@ RichFaces.showMod= alPanel (client Id) = - Opens a window wi= th a specified - client Id + Opens a window wi= th a specified client + Id = RichFaces.hideMod= alPanel (client Id) = - Closes a window w= ith a specified - client Id + Closes a window w= ith a specified client + Id @@ -135,21 +135,23 @@ = Important: - To work properly the <rich:modalPan= el> should always be placed = - outside the original <h:form> and must include its own <= h:form> for such cases like = - performing submissions from within the <rich:modalPanel>. - - - - Note: - In order to avoid a bug in IE, the root node of the dialog = is moved on the top of a DOM tree. - - - = + To work properly the <rich:modalPan= el> should + always be placed outside the origi= nal <h:form> + and must include its own <h:for= m> for such + cases like performing submissions = from within the + <rich:modalPanel>. + + + Note: + In order to avoid a bug in IE, the roo= t node of the dialog is + moved on the top of a DOM tree. + = + It's possible to add a "header" - facet to the component to set th= e content for the header. + facet to the component to set th= e content for the + header. = = @@ -209,8 +211,9 @@ The result: =
- <emphasis role=3D"bold"><property><rich:= modalPanel></property></emphasis> = - with 'Close' control + <emphasis role=3D"bold"> + <property><rich:modal= Panel></property> + </emphasis> with 'Close'= control = @@ -219,25 +222,44 @@
= - To understand the sence of "domElementAttachment" attribute = - you should understand the stacking context in th= e division element (<div>) HTML makeup. = - Since each positioned or z-indexed element (in CSS position: ab= solute or relative or z-index: [any integer value= different from 0]) = - form their own stacking context the <rich:modalPanel> nested into such element = - may be overlapped with another elements, which appear later in HTML h= eirarchy and assimilated with basic stacking context (HTML <body>). = - To make the panel rendered in closest to the observer layer and avoid= such overlapping, the component was designed in way when = - it is always being automatically assimilated with <body><= /code> and with a very high rendering layer (z-index). = - Due to some side effects the <ri= ch:modalPanel> should not always be = - assimilated with <body> stacking = context. The "domElementAttachment" = - attribute helps to reassign the panel to it 'parent' or 'form' element. = - If 'form' is used and no parent form i= s available the panel is functioning as if it is assimilated with <= ;body>. - - = - - Note: - If "domElementAttachment" value is not 'body' the= n some overlapping may occur. = - - - = + To understand the sence of " + domElementAttachment + " attribute you should under= stand the + stacking context in the division + element (<div>) HTML make= up. Since each + positioned or z-indexed element (in CSS position: + absolute or relative<= /code> or z-index: + [any integer value different from = 0]) form their own + stacking context the + <rich:modalPanel><= /property> + nested into such element may be = overlapped with another + elements, which appear later in HTML heirarc= hy and assimilated with + basic stacking context (HTML <body>). = To make the panel + rendered in closest to the observer layer an= d avoid such overlapping, + the component was designed in way when it is= always being + automatically assimilated with <bod= y> and + with a very high rendering layer (z-in= dex). Due to some + side effects the + <rich:modalPanel><= /property> + should not always be assimilated= with + <body> stacking= context. The " + domElementAttachment + " attribute helps to reassig= n the panel to it + 'parent&= apos; or + 'form&ap= os; element. If + 'form&ap= os; is used and no + parent form is available the panel is functi= oning as if it is + assimilated with <body>. = + + + Note: + If " + domElementAtta= chment + " value is not + 'body' then + some overlapping may occur. + + To manage window placement relative to the compo= nent, there are "left" and @@ -256,13 +278,12 @@ and "minHeight" attributes specifying the minima= l window sizes. - - Also you can use + Also you can use "minWidth" and "minHeight" - attributes used as showMod= alPanel() arguments in JavaScript options. - + attributes used as showMod= alPanel() arguments + in JavaScript options. You can pass your parameters during modalPanel = opening or closing. This passing could be performed in the following = way: = @@ -274,7 +295,8 @@ own parameters. Also modalPanel allows to handle its own openin= g and closing events on the client side. The - "onshow" attribute is used in this case. + "onshow" + attribute is used in this case. = The following example shows how on the client s= ide to define opening and closing event handling in such a way that yo= ur own parameters could also be obtained: @@ -331,7 +353,8 @@ level up) if it has the = form inside. - Simple example of using commandButton within mod= alPanel is placed below. + Simple example of using commandButton within mod= alPanel is placed + below. Example: @@ -393,14 +416,12 @@ = show() - Opens the corresp= onding - modalPanel + Opens the corresp= onding modalPanel = hide() - Closes the corres= ponding - modalPanel + Closes the corres= ponding modalPanel = @@ -408,7 +429,7 @@ = - = +
Facets @@ -416,18 +437,19 @@ - Facet - Descrip= tion + Facet + Description - header<= /entry> - Define = the header content + header + Define the header= content - control= s - Defines= the control elements on the header + controls + Defines the contr= ol elements on the + header @@ -611,7 +633,8 @@ = - The screenshot shows the classes names for defin= ing different elements. + The screenshot shows the classes names for defin= ing different + elements. =
Classes names that define a component= appearance @@ -630,37 +653,36 @@ rich-modalpanel = Defines styles fo= r a wrapper - <div> element of - a modalPanel + <div> element of a + modalPanel = rich-mpnl-mask-di= v = Defines styles fo= r a wrapper - <div> element of - a mask + <div> element of a= mask - = + - rich-mp= nl_panel - = - Defines= styles for a - moda= lPanel + rich-mpnl_panel + + Defines styles fo= r a modalPanel - = + - rich-mp= -container - = - Defines= styles for a modalPanel container + rich-mp-container= + + Defines styles fo= r a modalPanel + container = rich-mpnl-resizer= = Defines styles fo= r a wrapper - <div> element of - a resizing element + <div> element of a= resizing + element = @@ -669,11 +691,12 @@ Defines styles fo= r a modalPanel shadow - = + - rich-mp= -content-table - = - Defines= styles for a <table> element of a modalPanel + rich-mp-content-t= able + + Defines styles fo= r a <table> + element of a modalPanel<= /entry> = @@ -686,31 +709,30 @@ rich-mpnl-header-= cell = - Defines styles fo= r a header - cell + Defines styles fo= r a header cell = rich-mpnl-text = Defines styles fo= r a wrapper - <div> element of - a header text + <div> element of a= header + text = rich-mpnl-body = - Defines styles fo= r a content - inside a modalPanel + Defines styles fo= r a content inside a + modalPanel = rich-mpnl-control= s = Defines styles fo= r a wrapper - <div> element of - a modalPanel control + <div> element of a= modalPanel + control @@ -767,7 +789,8 @@ "headerClass"<= /property> attribute for <rich:modalPanel><= /property> - is defined as it's shown in= the example below: + is defined as it's shown in= the example + below: = Example: @@ -795,46 +818,74 @@
Relevant Resources Links - Vizit - ModalPanel page at RichFaces Livedemo for examples of compone= nt usage and their sources. - - = - Read the " - An Introduction To JBoss RichFaces" tutorial by Max Katz= to find out how = - the <rich:modalPanel> = - helps to edit and save changes for table entries. = - - = - Some articles at JBoss portal describing different aspects of <= emphasis role=3D"bold"><rich:modalPanel> usage: - - = - - - - "ModalPanelWizards" article describes = - how to create a typical wizard with the help of <rich:modalPanel> component = - (the same could also be found in the " - How to organize wizards using the <rich:modalPanel> compon= ent?" chapter of RichFaces FAQ guide); - - - - - "ModalPanelValidation" article = - gives examples of validation in = <rich:modalPanel> = - (the same in the corresponding topic = - at RichFaces Users Forum); - - - - - "RichFacesPleaseWaitBox" article = - describes how to show a "Please wait" box and block the = input while the Ajax request is being processed = - using combination of <a4j:sta= tus> and = - <rich:modalPanel> components. - - = - - = + Vizit ModalPanel page at RichF= aces Livedemo for examples + of component usage and their sources. + + Read the " An Introduction To JBoss RichFac= es" + tutorial by Max Katz to find out how the + <rich:modalPanel><= /property> + helps to edit and save changes f= or table entries. + + Some articles at JBoss portal describing differe= nt aspects of + <rich:modalPanel><= /property> + usage: + + + + "ModalPanelWizards" article + describes how to create = a typical wizard with the + help of + <rich:modal= Panel> + component (t= he same could also be + found in the " How to organize wizard= s using the + <rich:modalPanel> + component?"= chapter of RichFaces + FAQ guide); + + + Refer to the "How to do a detail view= modalPanel in a + table" arti= cle in the RichFaces cookbook at JBoss Portal to find out how to + build a table with detai= ls link clicking on which + will display a modal pan= el with information loaded from the server. + + + "ModalPanelValidation" article + gives examples of valida= tion in + <rich:modal= Panel> + (the same in= the corresponding topic at RichFaces Users + Forum); + + + "RichFacesPleaseWaitBox<= /ulink>" article + describes how to show a = "Please + wait" box and block= the input while the + Ajax request is being pr= ocessed using combination + of + <a4j:status= > + and + <rich:modal= Panel> + components. = + + +
= = Modified: trunk/docs/userguide/en/src/main/docbook/included/outputPanel.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 --- trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2009-= 04-09 15:52:25 UTC (rev 13474) +++ trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2009-= 04-09 15:56:40 UTC (rev 13475) @@ -29,15 +29,11 @@ component-class - - org.ajax4jsf.component.html.HtmlAjaxOutputPanel - + org.ajax4jsf.component.html.HtmlAjaxOutputPanel renderer-type - - org.ajax4jsf.components.AjaxOutputPanelRenderer - + org.ajax4jsf.components.AjaxOutputPanelRenderer @@ -45,9 +41,7 @@ =
Creating on a page - - Here is the simplest way for a component creation on a page. - + Here is the simplest way for a component creation on a page. = Example: @@ -74,25 +68,16 @@ <a4j:outputPanel> - - allows marking of a page area, which is updated on Ajax - response. Anyway, - + allows marking of a page area, which is updated on Ajax res= ponse. Anyway, + <a4j:outputPanel> - - usage is optional, as in RichFaces it's possible to - indicate any existing component id on a component view in - order to define updating areas. - - To speed up the performance, RichFaces updates only a - component tree. - + usage is optional, as in RichFaces it's possible to in= dicate any + existing component id on a component view in order to define updating a= reas. To speed up + the performance, RichFaces updates only a component tree. <a4j:outputPanel> - - usage is recommended for wrapping components that - aren't rendered during the primary non-ajax response, - as the components don't present in a component tree. - + usage is recommended for wrapping components that aren&apos= ;t rendered + during the primary non-ajax response, as the components don't pres= ent in a + component tree. Example: @@ -103,42 +88,27 @@ ... ]]> - - In addition to the areas directly indicated in - + In addition to the areas directly indicated in "reRender" - - attribute of Ajax components, - + attribute of Ajax components, <a4j:outputPanel> - - allows to update a part of a page basing on its own flag. - The flag is defined by the - + allows to update a part of a page basing on its own flag. T= he flag is + defined by the "ajaxRendered" - - attribute. The flag is commonly used when a part of a page - must be updated or can be updated on any response. - + attribute. The flag is commonly used when a part of a page = must be updated + or can be updated on any response. Example: ]]> - - On default - + On default <a4j:outputPanel> - - is output as a pair of opening and closing html - + is output as a pair of opening and closing html <span> - - tag, but with the help of the layout attribute this output - way could be changed. There are three variants for this - component value: - + tag, but with the help of the layout attribute this output = way could be + changed. There are three variants for this component value: "inline" (default) @@ -150,40 +120,25 @@ "none" - - If - layout=3D"block" - is chosen, the component is rendered as a pair of opening - and closing - + If layout=3D"block" is chosen, the compone= nt is rendered + as a pair of opening and closing <div> - - tag, to which it's possible to apply any available - style attributes available for block tags. - + tag, to which it's possible to apply any available sty= le attributes + available for block tags. - layout =3D"none" - helps to avoid an unnecessary tag round a context that could - or couldn't be rendered according to the defined - + layout =3D"none" helps to avoid an unnecessary t= ag round a + context that could or couldn't be rendered according to the define= d "rendered" - - attribute conditions. If an inner context isn't rendered, - + attribute conditions. If an inner context isn't render= ed, <a4j:outputPanel> - - is rendered as a - + is rendered as a <span> - - tag with the id equal to an id of a child component and - display:none - style. If a child component is rendered, - + tag with the id equal to an id of a child component and + display:none style. If a child component is rendered, <a4j:outputPanel> - - doesn't present at all in a final code. - + doesn't present at all in a final code. Example: @@ -194,97 +149,63 @@ ... ]]> - - As you see, the code is very similar to the one shown above, - but - + As you see, the code is very similar to the one shown above, but = "reRender " - - attribute refers directly to the updating panelGrid and not - to the framing outputPanel, and it's more semantically - correct. - + attribute refers directly to the updating panelGrid and not= to the framing + outputPanel, and it's more semantically correct. <a4j:outPanel> - - should be used for non-JSF component part framing, which is - to be updated on Ajax response, as RichFaces specifies the - list of updating areas as a list of an existing JSF - component. - - - On default non-JSF context isn't saved in a component - tree, but is rendered anew every time. To accelerate the - processing speed and Ajax response input speed, RichFaces - saves non-JSF context in a component tree on default. This - option could be canceled by - + should be used for non-JSF component part framing, which is= to be updated on + Ajax response, as RichFaces specifies the list of updating areas as a l= ist of an + existing JSF component. + On default non-JSF context isn't saved in a component tree, = but is rendered + anew every time. To accelerate the processing speed and Ajax response i= nput speed, + RichFaces saves non-JSF context in a component tree on default. This op= tion could be + canceled by "keepTransient" - - attribute that cancels transient flag forced setting for - child components. This flag setting keeps the current value - set by child components. - + attribute that cancels transient flag forced setting for ch= ild components. + This flag setting keeps the current value set by child components. Note: - - In JSF 1.1 implementation and lower, where non-JSF - context should be framed with the - + In JSF 1.1 implementation and lower, where non-JSF context shoul= d be framed with + the <f:verbatim> - - component, - + component, <a4j:outputPanel> - - doesn't improve this JSF implementation option in - any way, so you still have to use this tag where - it's necessary without RichFaces usage. - + doesn't improve this JSF implementation option in any= way, so + you still have to use this tag where it's necessary without RichF= aces + usage. - - RichFaces allows setting Ajax responses rendering directly - basing on component tree nodes without referring to the JSP - (XHTML) page code. It could be defined by "sel= fRendered" - attribute setting to - "true" - - on - + RichFaces allows setting Ajax responses rendering directly basing= on component tree + nodes without referring to the JSP (XHTML) page code. It could be defin= ed by + "selfRendered" + attribute setting to "true" on <a4j:region> - - and could help considerably speed up a response output. - However, if a transient flag is kept as it is, this rapid - processing could cause missing of transient components that - present on view and don't come into a component tree. Hence, - for any particular case you could choose a way for you - application optimization: speed up processing or redundant - memory for keeping tree part earlier defined a transient. + and could help considerably speed up a response output. How= ever, if a + transient flag is kept as it is, this rapid processing could cause miss= ing of transient + components that present on view and don't come into a component tr= ee. Hence, + for any particular case you could choose a way for you application opti= mization: speed + up processing or redundant memory for keeping tree part earlier defined= a transient.
Relevant resources links - Here - - you can see the example of - + url=3D"http://livedemo.exadel.com/richfaces-demo/richfaces/outputPanel= .jsf?c=3DoutputPanel" + > Here you can see the example of <a4j:outputPanel> - - usage and sources for the given example. + usage and sources for the given example. + Some additional information about usage of component can be found= on the Ajax4JSF Users Forum - - Some additional information about usage of component can be on the - found - - Ajax4JSF Users Forum - - . - + See how the + <a4j:outputPanel> + component can be used in the Aj= ax Input form with detection of Old/New + Values example in the RichFaces cookbook.
- \ No newline at end of file + --===============3609147600839108274==--