From seam-commits at lists.jboss.org Tue Apr 8 13:24:42 2008 Content-Type: multipart/mixed; boundary="===============3027025230831150111==" MIME-Version: 1.0 From: seam-commits at lists.jboss.org To: seam-commits at lists.jboss.org Subject: [seam-commits] Seam SVN: r7876 - branches/Seam_2_0/doc/Seam_Reference_Guide/en-US. Date: Tue, 08 Apr 2008 13:24:42 -0400 Message-ID: --===============3027025230831150111== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: pete.muir(a)jboss.org Date: 2008-04-08 13:24:42 -0400 (Tue, 08 Apr 2008) New Revision: 7876 Modified: branches/Seam_2_0/doc/Seam_Reference_Guide/en-US/Controls.xml Log: JBSEAM-2806 Modified: branches/Seam_2_0/doc/Seam_Reference_Guide/en-US/Controls.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 --- branches/Seam_2_0/doc/Seam_Reference_Guide/en-US/Controls.xml 2008-04-0= 8 15:10:51 UTC (rev 7875) +++ branches/Seam_2_0/doc/Seam_Reference_Guide/en-US/Controls.xml 2008-04-0= 8 17:24:42 UTC (rev 7876) @@ -2,870 +2,611 @@ = - Seam JSF controls - - Seam includes a number of JSF controls that are useful for working with - Seam. These are intended to complement the built-in JSF controls, and - controls from other third-party libraries. We recommend - JBoss RichFaces, and Apache MyFaces Trinidad tag libraries for use wit= h Seam. - We do not recommend the use of the Tomahawk tag library. - + Seam JSF controls + + Seam includes a number of JSF controls that are useful for working w= ith + Seam. These are intended to complement the built-in JSF controls, and + controls from other third-party libraries. We recommend + JBoss RichFaces, and Apache MyFaces Trinidad tag libraries for use w= ith Seam. + We do not recommend the use of the Tomahawk tag library. + = -
- Tags +
+ Tags = - - To use these tags, define the "s" namespace in your= page = - as follows (facelets only): - + + To use these tags, define the "s" namespace in= your page = + as follows (facelets only): + = - ]]> = - - The ui example demonstrates the use of a number of these tags. - - - - Seam JSF Control Reference - - - - - - - - - - - <s:button> - - - + + The ui example demonstrates the use of a number of these tags. + + = +
+ Navigation Controls + = +
+ <literal><s:button></literal> + = Description + = - A button that supports invocation of an action with control - over conversation propagation. Does not submit the= form. + A button that supports invocation of an action with control= over = + conversation propagation. Does not submit the = + form. Attributes + = - - - value — the label. - - - - - action — a method binding that = specified - the action listener. - - - - - view — the JSF view id to link = to. - - - - - fragment — the fragment identif= ier to link to. - - - - - disabled — is the link disabled? - - - - - propagation — determines the co= nversation - propagation style: begin, jo= in, - nest, none or end. - - - - - pageflow — a pageflow definitio= n to begin. - (This is only useful when propagation=3D"begin"= or - propagation=3D"join".) - - + + + value — the label. + + + + + action — a method binding th= at = + specified the action + listener. + + + + + view — the JSF view id to li= nk to. + + + + + fragment — the fragment = + identifier to link to. + + + + + disabled — is the link disab= led? + + + + + propagation — determines the = + conversation propagation style: begin, = + join, nest, = + none or end. + + + + + pageflow — a pageflow defini= tion = + to begin. (This is only useful when = + propagation=3D"begin" or + propagation=3D"join" is used). + + + = Usage - ]]> - You can specify both view and a= ction - on <s:link />. In this case, the a= ction = - will be called once the redirect to the specified view has - occured. + You can specify both view and = + action on <s:link />. = + In this case, the action wil be called once the redirect to= the = + specified view has occured. - - - - - + = +
+ = +
+ <literal><s:conversationId></literal> + = + Description + = - <s:cache> + Add the conversation id to JSF link or button (e.g. + <h:commandLink /> , + <s:button />). - - + = + Attributes + = + None + = +
+ = +
+ <literal><s:taskId></literal> + = Description - Cache the rendered page fragment using JBoss Cache. Note that - <s:cache> actually uses the instance - of JBoss Cache managed by the built-in pojoCache - component. + Add the task id to an output link (or similar JSF control), = + when the task is available via #{task}. + = Attributes - - - - key — the key to cache rendered= content, - often a value expression. For example, if we were cachin= g a page - fragment that displays a document, we might use - key=3D"Document-#{document.id}". - - - - - enabled — a value expression th= at determines - if the cache should be used. - - - - - region — a JBoss Cache node to = use (different - nodes can have different expiry policies). - - - - Usage - -
-

#{blogEntry.title}

-
- -
-

- [Posted on  - - - ] -

-
-]]> - - - - - - <s:conversationId> + None. - - + = +
+ = +
+ <literal><s:link></literal> + = Description - Add the conversation id to JSF link or button (e.g. <h:commandLink />, <s:button />). + A link that supports invocation of an action with control o= ver = + conversation propagation. Does not submit the = + form. + = Attributes + + + + value — the label. + + + + + action — a method binding t= hat = + specified the action listener. + + + + + view — the JSF view id to li= nk to. + + + + + fragment — the fragment iden= tifier + to link to. + + + + + disabled — is the link disab= led? + + + + + propagation — determines the = + conversation propagation style: begin, + join, nest, + none or end. + + + + + pageflow — a pageflow defini= tion = + to begin. (This is only useful when using + propagation=3D"begin" or + propagation=3D"join".) + + + + = + Usage + ]]> - None. + You can specify both view and = + action on <s:link />. + In this case, the action will be called once the redirect t= o the = + specified view has occured. - - - - - + = +
+ = +
+ <literal><s:conversationPropagation></literal></t= itle> + = + <para><emphasis>Description</emphasis></para> <para> - <literal><s:conversationPropagation></literal> + Customize the conversation propagation for a command link o= r button + (or similar JSF control). <emphasis>Facelets only.</emphasi= s> </para> - </entry> - <entry valign=3D"top"> - <para><emphasis>Description</emphasis></para> - <para> - Customize the conversation propagation for a command link = or button - (or similar JSF control). <emphasis>Facelets only.</emphas= is> - </para> - <para><emphasis>Attributes</emphasis></para> - <itemizedlist> - <listitem> + = + <para><emphasis>Attributes</emphasis></para> + <itemizedlist> + <listitem> <para> <literal>type</literal> — determines the conver= sation - propagation style: <literal>begin</literal>, <literal= >join</literal>, - <literal>nest</literal>, <literal>none</literal> or <= literal>end</literal>. + propagation style: <literal>begin</literal>, = + <literal>join</literal>, <literal>nest</literal>, = + <literal>none</literal> or <literal>end</literal>. </para> - </listitem> - <listitem> + </listitem> + <listitem> <para> - <literal>pageflow</literal> — a pageflow definit= ion to begin. - (This is only useful when <literal>propagation=3D"begi= n"</literal> or - <literal>propagation=3D"join"</literal>.) + <literal>pageflow</literal> — a pageflow defini= tion to = + begin. (This is only useful when using = + <literal>propagation=3D"begin"</literal> or = + <literal>propagation=3D"join"</literal>.) </para> - </listitem> - </itemizedlist> - <para><emphasis>Usage</emphasis></para> - <programlisting role=3D"XHTML"><![CDATA[<h:commandButton val= ue=3D"Apply" action=3D"#{personHome.update}"> - <s:conversationPropagation type=3D"join" /> + </listitem> + </itemizedlist> + <para><emphasis>Usage</emphasis></para> + <programlisting role=3D"XHTML"><![CDATA[<h:commandButton value= =3D"Apply" action=3D"#{personHome.update}"> + <s:conversationPropagation type=3D"join" /> </h:commandButton>]]></programlisting> - </entry> - </row> - - <row> - <entry valign=3D"top"> - <para><literal><s:convertDateTime></literal></para> - </entry> - <entry valign=3D"top"> - <para><emphasis>Description</emphasis></para> + </section> + = + <section> + <title> + <literal><s:defaultAction></literal> + + = - Perform date or time conversions in the Seam timezone. + Description - Attributes - None. + Specify the default action to run when the form is submitte= d using + the enter key. + + Currently you can only nest it inside buttons (e.g. + <h:commandButton />, + <a:commandButton /> or + <tr:commandButton />). + + + You must specify an id on the action source. You can only h= ave one + default action per form. + + = + + Attributes + + None. + = Usage + + +]]> +
+ = +
+ = +
+ Converters and Validators + = +
+ <literal><s:convertDateTime></literal> + = + Description + Perform date or time conversions in the Seam timezone. + = + Attributes + None. + = + Usage - + ]]> - - - - - - <s:convertEntity> - - + = +
+ = +
+ <literal><s:convertEntity></literal> + = Description - Assigns an entity converter to the current component. This= is primarily - useful for radio button and dropdown controls. + Assigns an entity converter to the current component. This = is + primarily useful for radio button and dropdown controls. - + = - The converter works with any managed entity which has an @Id annotation - - either simple or composite. + The converter works with any managed entity which has an + @Id + annotation - either simple or composite. - + = Attributes - - - None. - - + None. + = Configuration - + = - You must use Seam managed transactions = (see ) with <s:convertEntity />. + You must use Seam managed transactions= (see + )= with + <s:convertEntity />. - + = - If your Managed Persistence Context isn= 't called - entityManager, then you need to set it in= components.xml: + If your Managed Persistence Context is= n't = + called entityManager, then you need to s= et it in = + components.xml: - #{em} + #{em} ]]> - + = - If you are using a Managed Hibernate Session = - then you need to set it in components.xml: + If you are using a Managed Hibernate Session + then you need to set it in components.xml: - #{hibernateSession} + #{hibernateSession} ]]> - + = - If you want to use more than one entity manager with the ent= ity = - converter, you can create a copy of the entity converter for= each - entity manager in components.xml: + If you want to use more than one entity manager with the en= tity + converter, you can create a copy of the entity converter fo= r each + entity manager in components.xml: - = + = - #{em} + #{em} ]]> - + = - - + + ]]> - + = Usage - - + + ]]> - - - - - - <s:convertEnum> - - - +
+ = +
+ <literal><s:convertEnum></literal> + = Description - Assigns an enum converter to the current component. This is= primarily - useful for radio button and dropdown controls. + Assigns an enum converter to the current component. This is + primarily useful for radio button and dropdown controls. + = Attributes - - None. - + None. + = Usage - - + ]]> - - +
= + = +
+ <literal><s:validate></literal> + = + Description + + A non-visual control, validates a JSF input field against t= he = + bound property using Hibernate Validator. + + = + Attributes + + None. + + = + Usage + + + +]]> +
+ = +
+ <literal><s:validateAll></literal> = - - + Description - <s:decorate> + A non-visual control, validates all child JSF input fields = + against their bound properties using Hibernate Validator. - - + = + Attributes + + None. + + = + Usage + +
+ Username: + + +
+
+ Password: + + +
+
+ Verify Password: + + +
+]]> + = +
+ = +
+ = +
+ Formatting + = +
+ <literal><s:decorate></literal> + = Description - "Decorate" a JSF input field when validation fails or when - required=3D"true" is set. + "Decorate" a JSF input field when validation fails or when + required=3D"true" is set. = Attributes - - - template — the facelets templat= e to use to decorate the component + + + template — the facelets temp= late = + to use to decorate the component - #{invalid} and #{required} are = - available inside s:decorate; #{r= equired} = - evaluates to true if you have set the inp= ut component = - being decorated as required, and #{invalid} evaluates = - to true if a validation error occurs. + #{invalid} and #{required} = + are available inside s:decorate; = + #{required} evaluates to = + true if you have set the input component= being + decorated as required, and #{invalid} = + evaluates to true if a validation error = occurs. + = Usage - Country: - - ]]> - + Country: + + ]]> + = -
= +
= = - - - * - + + + * + = - - - - - + + + + + = - = + = = -
= +
= = ]]> - - - = - - - - <s:defaultAction> - - - +
+ = +
+ <literal><s:div></literal> + = Description - Specify the default action to run when the form is submitted= using - the enter key. + Render a HTML <div>. - - Currently you can only nest it inside buttons (e.g. = - <h:commandButton />, - <a:commandButton /> or - <tr:commandButton />). - - - You must specify an id on the action source. You can only ha= ve one - default action per form. - + = Attributes - None. + None. + = Usage - - -]]> - - - - - - - <s:div> - - - - Description - - Render a HTML <div>. - - Attributes - - None. - - Usage - - Sorry, but this member does not exist. + + Sorry, but this member does not exist. ]]> - - - - - - - <s:enumItem> - - - - Description - - Creates a SelectItem from an enum value. - - Attributes - - - - enumValue — the string repre= sentation of the enum - value. - - - - - label — the label to be used = when rendering the SelectItem. - - - - Usage - - - - - - - -]]> - - - - - - - <s:fileUpload> - - - +
+ = +
+ <literal><s:span></literal> + = Description - Renders a file upload control. This control must be used w= ithin a form with - an encoding type of multipart/form-data,= i.e: + Render a HTML <span>. - - ]]> - - - For multipart requests, the Seam Multipart servlet filter mu= st also be configured - in web.xml: - - - - Seam Filter - org.jboss.seam.servlet.SeamFilter - - - - Seam Filter - /* -]]> - - Configuration - - - The following configuration options for multipart requests m= ay be configured in components.xml: - - - - - - createTempFiles — if this optio= n is set to true, uploaded files are - streamed to a temporary file instead of in memory. - - - - - maxRequestSize — the maximum si= ze of a file upload request, in bytes. - - - - - - Here's an example: - - - - true - 1000000 -]]> - + = Attributes - - - - data — this value binding recei= ves the binary file data. - The receiving field should be declared as a byt= e[] or InputStream (required). - - - - - contentType — this value bindin= g receives the file's - content type (optional). - - - - - fileName — this value binding r= eceives the filename (optional). - - - - - fileSize — this value binding r= eceives the file size (optional). - - - - - accept — a comma-separated list= of content types to accept, - may not be supported by the browser. E.g. "ima= ges/png,images/jpg", - "images/*". - - - - - style — The control's style - - - - - styleClass — The control's styl= e class - - - - Usage - ]]> - - - - - - <s:formattedText> - - - Description - Outputs Seam Text, a rich text markup = useful for blogs, wikis and - other applications that might use rich text. See the Seam = Text chapter for full usage. + None. - Attributes - - - - value — an EL expression specif= ying the rich text markup to render. - - - + = Usage - ]]> - Example - - - - - - - - - - - - - - - <s:fragment> - - - + *]]> + = +
+ = +
+ <literal><s:fragment></literal> + = Description - A non-rendering component useful for enabling/disabling rend= ering of it's children. + A non-rendering component useful for enabling/disabling ren= dering + of it's children. + = Attributes - None. + None. + = Usage - Current bid: + Current bid: ]]> - - + = +
+ = +
+ <literal><s:label></literal> = - - - - <s:graphicImage> - - - Description - An extended <h:graphicImage> that a= llows the image to be created in a Seam Component; further transforms - can be applied to the image. + "Decorate" a JSF input field with the label. The label is = placed + inside the HTML <label> tag, and i= s = + associated with the nearest JSF input component. It is oft= en = + used with <s:decorate>. - - All attributes for <h:graphicImage>= are supported, as well as: - Attributes - + - - value — image to display. Can b= e a path String - (loaded from the classpath), a byte[],= a java.io.File, - a java.io.InputStream or a ja= va.net.URL. Currently supported - image formats are image/png, = image/jpeg and image/gif. - + + style — The control's style + - - - fileName — if not specified the = served image will have a generated file name. - If you want to name your file, you should specify it here= . This name should be unique - + + + styleClass — The control's s= tyle class + - - Transformations - - To apply a transform to the image, you would nest a tag spe= cifying the transform to apply. Seam currently supports these - transforms: - - - - <s:transformImageSize> - - - - - width — new width of the = image - - - - - height — new height of th= e image - - - - - maintainRatio — if true, and one of - width/height= are specified, the image will be resized with the - dimension not specified being calculated to mainta= in the aspect ratio. - - - - - factor — scale the image = by the given factor - - - - - - - <s:transformImageBlur> - - - - - radius — perform a convol= ution blur with the given radius - - - - - - - <s:transformImageType> - - - - - contentType — alter the t= ype of the image to either image/jpeg or image/= png - - - - - - - - - It's easy to create your own transform - create a U= IComponent which implements - org.jboss.seam.ui.graphicImage.ImageTransform. Inside the applyTransform()method - use image.getBufferedImage() to get the o= riginal image and image.setBufferedImage() - to set your transformed image. Transforms are applied in th= e order specified in the view. - - Usage - - -]]> - - - = - - - - <s:label> - - - - Description - - "Decorate" a JSF input field with the label. The label is p= laced inside = - the HTML <label> tag, and is associ= ated with the - nearest JSF input component. It is often used with <s:decorate>. - - Attributes - - - - style — The control's style - - - - - styleClass — The control's styl= e class - - + = Usage Country: ]]> - - - = - - - - <s:link> - - - +
+ = +
+ <literal><s:message></literal> + = Description - A link that supports invocation of an action with control ov= er conversation - propagation. Does not submit the form. + "Decorate" a JSF input field with the validation error mess= age. + = Attributes - - - - value — the label. - - - - - action — a method binding that = specified - the action listener. - - - - - view — the JSF view id to link = to. - - - - - fragment — the fragment identif= ier to link to. - - - - - disabled — is the link disabled? - - - - - propagation — determines the co= nversation - propagation style: begin, jo= in, - nest, none or end. - - - - - pageflow — a pageflow definitio= n to begin. - (This is only useful when propagation=3D"begin"= or - propagation=3D"join".) - - - - Usage - ]]> - You can specify both view and a= ction - on <s:link />. In this case, the a= ction = - will be called once the redirect to the specified view has - occured. + None. - - - - - - - <s:message> - - - - Description - - "Decorate" a JSF input field with the validation error messa= ge. - - Attributes - - None. - + = Usage @@ -873,486 +614,579 @@ ]]> - - - = - - - - <s:remote> - - - + = +
+ = +
+ = +
+ Seam Text + = +
+ <literal><s:validateFormattedText></literal></tit= le> + = <para><emphasis>Description</emphasis></para> <para> - Generates the Javascript stubs required to use Seam Remoting. + Checks that the submitted value is valid Seam Text </para> + = <para><emphasis>Attributes</emphasis></para> - <itemizedlist> - <listitem> - <para> - <literal>include</literal> — a comma-separated lis= t of the component names (or fully qualified class names) - for which to generate Seam Remoting Javascript stubs. S= ee <xref linkend=3D"remoting"/> for more details. - </para> - </listitem> - </itemizedlist> - <para><emphasis>Usage</emphasis></para> - <programlisting role=3D"XHTML"><![CDATA[<s:remote include=3D"c= ustomerAction,accountAction,com.acme.MyBean"/>]]></programlisting> - </entry> - </row> = - - <row> - <entry valign=3D"top"> <para> - <literal><s:selectDate></literal> + None. </para> - </entry> - <entry valign=3D"top"> + </section> + = + <section> + <title><literal><s:formattedText></literal> + Description - Deprecated. Use <rich:calendar /><= /literal> instead. + Outputs Seam Text, a rich text markup = useful + for blogs, wikis and other applications that might use rich= text. + See the Seam Text chapter for full usage. - - Displays a dynamic date picker component that selects a dat= e for the specified input field. - The body of the selectDate element shoul= d contain HTML elements, such as - text or an image, that prompt the user to click to display = the date picker. The date picker - must be styled using CSS. An example = CSS file can be found in the Seam - booking demo as date.css, or can be gene= rated using seam-gen. The CSS - styles used to control the appearance of the date picker ar= e also described below. - - + = Attributes - - for — The id of the input field= that the date picker will insert the - selected date into. - + + value — an EL expression spec= ifying = + the rich text markup to render. + - - - dateFormat — The date format st= ring. This should match the date format of the - input field. - - - - - startYear — The popup year sele= ctor range will start at this year. - - - - - endYear — The popup year select= or range will end at this year. - - - - - firstDayOfWeek — Controls which= day is the first day of the week = - (0 =3D Sunday, 6 =3D Saturday). If this attribute is no= t set, then the first day of the week will - default based on the user's locale. - - - + = Usage + ]]> = - - Date of birth* - - - - - - -
-]]> - = - Example - + - + - - CSS Styling + = +
+ = +
= + = +
+ Dropdowns + = +
+ <literal><s:enumItem></literal> + = + Description - The following list describes the CSS class names that are us= ed to control the style of the selectDate control. + Creates a SelectItem from an enum value. + = + Attributes - - - seam-date — This class is appli= ed to the outer div containing the - popup calendar. (1) It is also applied to the t= able that controls the inner layout of the - calendar. (2) - - - - - seam-date-header — This class i= s applied to the calendar header table row (tr) - and header table cells (td). (3) - - - - - seam-date-header-prevMonth — Th= is class is applied to the "previous month" table cell, - (td), which when clicked causes the c= alendar to display the month prior to the one currently - displayed. (4) - - - - - seam-date-header-nextMonth — Th= is class is applied to the "next month" table cell, - (td), which when clicked causes the c= alendar to display the month following the one currently - displayed. (5) - - - - - seam-date-headerDays — This cla= ss is applied to the calendar days header row - (tr), which contains the names of the= week days. (6) - - - - - seam-date-footer — This class i= s applied to the calendar footer row - (tr), which displays the current date= . (7) - - - - - seam-date-inMonth — This class = is applied to the table cell - (td) elements that contain a date wit= hin the month currently displayed. (8) - - - - - seam-date-outMonth — This class= is applied to the table cell - (td) elements that contain a date out= side of the month currently displayed. (9) - - - - - seam-date-selected — This class= is applied to the table cell - (td) element that contains the curren= tly selected date. (10) - - - - - seam-date-dayOff-inMonth — This= class is applied to the table cell - (td) elements that contain a "day off= " date (i.e. weekend days, Saturday and Sunday) - within the currently selected month. (11) - - - - - seam-date-dayOff-outMonth — Thi= s class is applied to the table cell - (td) elements that contain a "day off= " date (i.e. weekend days, Saturday and Sunday) - outside of the currently selected month. (12) - - - - - seam-date-hover — This class is= applied to the table cell - (td) element over which the cursor is= hovering. (13) - - - - - seam-date-monthNames — This cla= ss is applied to the div - control that contains the popup month selector. (14) - - - - - seam-date-monthNameLink — This = class is applied to the anchor (a) - controls that contain the popup month names. (15) - - - - - seam-date-years — This class i= s applied to the div - control that contains the popup year selector. (16) - - - - - seam-date-yearLink — This class= is applied to the anchor (a) - controls that contain the popup years. (15) - - + + + enumValue — the string = + representation of the enum value. + + + + + label — the label to be used= when = + rendering the SelectItem. + + + = + Usage + + + + + + + +]]> +
+ = +
+ <literal><s:selectItems></literal> = - - - - - - - - - - - - - + Description - <s:selectItems> + Creates a List<SelectItem> from a = List, Set, DataModel or Array. - - - Description - - Creates a List<SelectItem> from = a List, Set, DataModel or Array. - - Attributes - + + Attributes + - - value — an EL expression spe= cifying the data that backs the List<SelectItem> - + + value — an EL expression = + specifying the data that backs the = + List<SelectItem> + - - - var — defines the name of th= e local variable that holds the current object during iteration - + + + var— defines the name of the= local + variable that holds the current object during iterati= on + - - label — the label to be used= when rendering the SelectItem. Can reference - the var variable - + + label — the label to be used= when = + rendering the SelectItem. Can refe= rence = + the var variable. + - - itemValue — Value to return = to the server if this option is selected. Optional, by default the var object is used. Can reference the var var= iable = - + + itemValue — Value to return = to the = + server if this option is selected. Optional, by defau= lt the + var object is used. Can reference = the + var variable. + - = - - - disabled — if true the SelectItem will be rendered disabled. Can reference - the var variable - + + + + disabled + — if true the SelectItem wil= l be = + rendered disabled. Can reference the var + variable. + - - noSelectionLabel — specifies= the (optional) label to place at the top of list (if - required=3D"true" is also specifie= d then selecting this value will cause a validation error) - + + noSelectionLabel — specifies= the = + (optional) label to place at the top of list (if + required=3D"true" is also specifie= d then = + selecting this value will cause a validation error). + - - hideNoSelectionLabel — if tru= e, the noSelectionLabel will be hidden - when a value is selected - + + hideNoSelectionLabel — if tr= ue, + the noSelectionLabel will be hidde= n when + a value is selected = + - - Usage + + Usage ]]> - - +
+ = +
+ = +
+ Other + = +
+ <literal><s:cache></literal> = - - - - <s:span> - - - Description - Render a HTML <span>. + Cache the rendered page fragment using JBoss Cache. Note th= at + <s:cache> actually uses the instan= ce + of JBoss Cache managed by the built-in = + pojoCache component. Attributes - - None. - + + + + key — the key to cache rende= red = + content, often a value expression. For example, if we= were = + caching a page fragment that displays a document, we = might = + use key=3D"Document-#{document.id}". + + + + + enabled — a value expression= that = + determines if the cache should be used. + + + + + region — a JBoss Cache node = to use + (different nodes can have different expiry policies). + + + + = Usage - *]]> - - + +
+

#{blogEntry.title}

+
+ +
+

+ [Posted on  + + + ] +

+
+]]> + = +
= - - - - <s:taskId> - - - +
+ <literal><s:fileUpload></literal> + Description - - Add the task id to an output link (or similar JSF control)= , when the - task is available via #{task}. - - Attributes - None. + Renders a file upload control. This control must be used w= ithin + a form with an encoding type of = + multipart/form-data, i.e: = - - = - - + ]]> + - <s:validate> + For multipart requests, the Seam Multipart servlet filter m= ust = + also be configured in web.xml: - - - Description + + + Seam Filter + org.jboss.seam.servlet.SeamFilter + + + + Seam Filter + /* +]]> + + Configuration + - A non-visual control, validates a JSF input field against th= e bound - property using Hibernate Validator. + The following configuration options for multipart requests = may be + configured in components.xml: - Attributes + + + + + createTempFiles — if this op= tion = + is set to true, uploaded files are streamed to a temp= orary = + file instead of in memory. + + + + + maxRequestSize — the maximum= size = + of a file upload request, in bytes. + + + + - None. + Here's an example: + + + true + 1000000 +]]> + + Attributes + + + + data — this value binding re= ceives + the binary file data. The receiving field should be = + declared as a byte[] or = + InputStream (required). + + + + + contentType — this value bin= ding = + receives the file's content type (optional). + + + + + fileName — this value bindin= g = + receives the filename (optional). + + + + + fileSize — this value bindin= g = + receives the file size (optional). + + + + + accept — a comma-separated l= ist of + content types to accept, may not be supported by the = + browser. E.g. "images/png,images/jpg", + "images/*". + + + + + style — The control's style + + + + + styleClass — The control's s= tyle = + class + + + Usage - - - -]]> - - + ]]> + = +
= - - - <s:validateAll> - - +
+ <literal><s:graphicImage></literal> + = Description - A non-visual control, validates all child JSF input fields a= gainst their bound - properties using Hibernate Validator. + An extended <h:graphicImage> that = allows + the image to be created in a Seam Component; further transf= orms + can be applied to the image. + + All attributes for <h:graphicImage> are = + supported, as well as: + + = Attributes + + + + value — image to display. C= an be = + a path String (loaded from the = + classpath), a byte[], a = + java.io.File, a = + java.io.InputStream or a = + java.net.URL. Currently supported= image + formats are image/png, = + image/jpeg and = + image/gif. + + + + + fileName — if not specified = the = + served image will have a generated file name. If you = want = + to name your file, you should specify it here. This = name = + should be unique + + + + = + Transformations - None. + To apply a transform to the image, you would nest a tag = + specifying the transform to apply. Seam currently supports= these + transforms: - Usage - -
- Username: - - -
-
- Password: - - -
-
- Verify Password: - - -
-]]> - - - = - - + + + + <s:transformImageSize> + + + + + + width — new width o= f the = + image + + + + + height — new height= of the = + image + + + + + maintainRatio — if + true, and = + one of + width/height + are specified, the image will be resized wit= h the + dimension not specified being calculated to + maintain the aspect ratio. + + + + + factor — scale the = image = + by the given factor + + + + + + + + <s:transformImageBlur> + + + + + + radius — perform a = + convolution blur with the given radius + + + + + + + + <s:transformImageType> + + + + + + contentType — alter= the = + type of the image to either = + image/jpeg or + image/png + + + + + + + - <s:validateFormattedText> + It's easy to create your own transform - create a = + UIComponent which implements = + org.jboss.seam.ui.graphicImage.ImageTransform. + Inside the applyTransform()method use = + image.getBufferedImage() to get the orig= inal = + image and image.setBufferedImage() to se= t your + transformed image. Transforms are applied in the order spe= cified + in the view. - - + Usage + + +]]> +
+ = +
+ <literal><s:remote></literal> + = Description - Checks that the submitted value is valid Seam Text + Generates the Javascript stubs required to use Seam Remotin= g. + = Attributes - - None. - - - = + + + + include — a comma-separated = list = + of the component names (or fully qualified class name= s)for = + which to generate Seam Remoting Javascript stubs. Se= e = + for more details. + + + + = + Usage + ]]> = +
+
= + = - - -
-
-
- Annotations - = - - Seam also provides annotations to allow you to use Seam components as = JSF - converters and validators: - = - - - - - @Converter - - - = - ]]> - = - - Registers the Seam component as a JSF converter. Shown here i= s a = - converter which is able to access the JPA EntityManager inside= a = - JTA transaction, when converting the value back to it's object - representation. - - - - - - @Validator - - - + Annotations + = + + Seam also provides annotations to allow you to use Seam components = as JSF + converters and validators: + = + + + + + @Converter + + + = - public void validate(FacesContext context, UIComponent cmp, Object value) - throws ValidatorException { - ItemController ItemController =3D (ItemController) Component.getInstan= ce("itemController"); - return itemController.validate(value); - } - = - }]]> - = - ]]> - - Registers the Seam component as a JSF validator. Shown here= is a = - validator which injects another Seam component; the injected = - component is used to validate the value. - - - - -
+ ]]> + = + + Registers the Seam component as a JSF converter. Shown her= e is a = + converter which is able to access the JPA EntityManager ins= ide a = + JTA transaction, when converting the value back to it's obj= ect + representation. + + + + + + @Validator + + + + = + ]]> + + Registers the Seam component as a JSF validator. Shown h= ere is a = + validator which injects another Seam component; the injec= ted = + component is used to validate the value. + + + + +
= = --===============3027025230831150111==--