Tag reference sheet
Tag library reference for the following tag libraries:
- Tomahawk sandbox tag library. (myfaces_sandbox.tld) - uri: http://myfaces.apache.org/sandbox
Tomahawk sandbox tag library.
Enhanced standard JSP actions and custom MyFaces actions.
This is version 1.0.
- accordionPanel A group of panels, which can be opened and closed
- ajaxChildComboBox Refreshes contents through an ajax call when the parent combo box's value is changed
- autoUpdateDataTable Extended data_table that adds some additional features to the standard data_table action: see attribute descriptions for preserveDataModel, sortColumn, sortAscending and preserveSort
- commandButtonAjax Extends standard commandButton allowing for dynamic ajax submitting of the form
- conversation puts a bean into the conversation context add a bean under context control
- convertBoolean Converter that translates between boolean values (true/false) and alternate versions of those boolean values like (yes/no), (1/0), and (way/no way)
- convertDateTime Simple convert that overrides the spec DateTimeConverter and uses TimeZone
- convertNumber Converter which uses either the manually set destType or the value binding to determine the correct destination type to convert the number to This tag creates a number formatting converter and associates it with the nearest parent UIComponent
- convertStringUtils Converts the format of a string Provides runtime modification of a string
- effect provides javascript effects which are from the script
- endConversation end a conversation
- ensureConversation Ensures a named conversation is running check if a conversation is active
- exporterActionListener Export datatable contents to an excel file or a pdf file
- fieldset Renders an HTML Fieldset
- filterTable
- fishEyeCommandLink CommandLink component that can be used in nodeStamp facet
- fishEyeNavigationMenu Provide a FishEye toolbar component from the DOJO toolkit A Mac OSX-style toolbar, using the DOJO toolkit
- floatingPane PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad
- focus
- form Renders a HTML form element which allow defining a different scheme, servername or port for the action url to which the form is submited
- graphicImageDynamic Extends standard graphicImage
- ifMessage Provide a component that will optionally render its children if the specified component(s) specified has a message
- imageLoop HTML image loop component
- imageLoopItem Image loop item
- imageLoopItems Image loop items
- inputSuggest Provides an input textbox with "suggest" functionality
- inputSuggestAjax Provides an input textbox with "suggest" functionality, using an ajax request to the server
- inputTextAjax Extends standard inputText allowing for dynamic ajax submitting
- layoutingContentPane Base content pane for the dojo layouts jsfed dojo content pane
- layoutingSplitPane PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad
- layoutingTitlePane Title Pane layouting element
- limitRendered Tag that allows for selective rendering based on a count or by child index Component that only renders a subset of its children components
- listener Allows a component to listen for events on another component with AJAX input elements
- loadBundle Extended loadbundle which does its job in all life-cycle phases or even on calling LoadBundle
- media
- message MyFaces extension to the standard messages tag: see summaryDetailSeparator attribute
- modalDialog Modal Dojo Dialog (is not working with overridden 'onload')
- outputLinkDynamic Extends standard outputLink but links to a dynamically rendered resource (image, file,
- outputText Extending the outputText component in order to introduce the for attribute
- passwordStrength
- pprPanelGroup AJAX component which supports updating its children via AJAX calls
- pprSubmit PPRSubmitTag can be attached to command components, enabling PPR-request inside UIData components
- roundedDiv Component that allows for a rounded border effect on DIV tags that is supported in CSS2 compatible browsers and IE6
- scope Scope control which does basically the same as savestate but bypasses the serialization and utilizes the session directly
- script Adds (java)script to the browser
- selectBooleanCheckboxAjax Extends standard selectBooleanCheckbox by user role support
- selectManyCheckboxAjax Extends standard selectManyCheckbox allowing for dynamic ajax submitting
- selectOneRadioAjax Extends standard selectOneRadio allowing for dynamic ajax submitting
- selectOneRow Enhancement for a data-table to select one Row with a radio button
- separateConversationContext Separates the current context from the children
- sortableColumn
- startConversation start a conversation
- stateChangedNotifier A component that listens to changes in the components Shows a confirmation window if some of the input fields of the form have changed its value
- subForm A SubForm which will allow for partial validation and model update
- submitOnEvent Attach an event handler to an input element or use a global event handler to submit a form by "clicking" on a link or button
- tableSuggestAjax Provides an input textbox with "suggest" functionality, using an ajax request to the server
- timedNotifier Displays a timed notifier tag
- toggleGroup Container class allows user to toggle between view/edit mode
- toggleLink Extends standard outputLink but links to a dynamically rendered resource (image, file,
- togglePanel Container class allows user to toggle between view/edit mode
- validateCSV Validation by validating comma separated values individually
- validateCompareTo Validates this component against another component
- validateISBN A custom validator for isbn codes, based upons Jakarta Commons
- validateUrl A custom validator for url format, based upons Jakarta Commons
- validationScript
- valueChangeNotifier ValueChangeNotifier Like valueChangeListener, but will send valueChange events after the UPDATE_MODEL phase
- xmlTemplate Transforms XML using and XSL stylesheet
Required attributes are marked with a *
<s:accordionPanel>
A group of panels, which can be opened and closed. See attribute layout for further description on how opening and closing works. Extends standard panelGroup by user role support.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| borderColor | Defines the color of the border. | String |
| collapsedBackColor | Defines the background color for collapsed state. | String |
| collapsedFontWeight | Defines the font weight for collapsed state. | String |
| collapsedTextColor | Defines the text color for collapsed state. | String |
| colspan | standard html colspan attribute for table cell | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| displayValueOnly | If true, renders only the value of the component, but no input widget. Default is false. | String |
| displayValueOnlyStyle | Style used when displayValueOnly is true. | String |
| displayValueOnlyStyleClass | Style class used when displayValueOnly is true. | String |
| enabledOnUserRole | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. | String |
| expandedBackColor | Defines the background color for expanded state. | String |
| expandedFontWeight | Defines the font weight for expanded state. | String |
| expandedTextColor | Defines the text color for expanded state. | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| hoverBackColor | Defines the background color on hover. | String |
| hoverTextColor | Defines the text color on hover. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| lang | HTML: The base language of this document. | String |
| layout | Defines the layout of this accordionPanel. If you set this to 'accordion', opening a panel will close all other panels. If you set this to 'toggling', opening a panel doesn't affect the state of the other panels. You can close a panel by clicking on the header of this panel a second time. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is released over this element. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
| visibleOnUserRole | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. | String |
<s:ajaxChildComboBox>
Refreshes contents through an ajax call when the parent combo box's value is changed. This component is to be used in conjunction with a regular combo box or list box. When the selected value of the latter changes, it executes an ajax call to the specified method to refresh its contents based on the new selected value.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| accesskey | HTML: Sets the access key for this element. | String |
| ajaxSelectItemsMethod | Method to call via ajax to reload the combo box | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| converter | The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. | String |
| datafld | Reserved for future use. | String |
| dataformatas | Reserved for future use. | String |
| datasrc | Reserved for future use. | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| disabled | HTML: When true, this element cannot receive focus. | String |
| disabledClass | The CSS class assigned to the label element for enabled choices. | String |
| displayValueOnly | If true, renders only the value of the component, but no input widget. Default is false. | String |
| displayValueOnlyStyle | Style used when displayValueOnly is true. | String |
| displayValueOnlyStyleClass | Style class used when displayValueOnly is true. | String |
| enabledClass | The CSS class assigned to the label element for enabled choices. | String |
| enabledOnUserRole | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. | String |
| escape | Indicates whether rendered markup should be escaped. Default: true | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| immediate | A boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| lang | HTML: The base language of this document. | String |
| onblur | HTML: Specifies a script to be invoked when the element loses focus. | String |
| onchange | HTML: Specifies a script to be invoked when the element is modified. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onfocus | HTML: Specifies a script to be invoked when the element receives focus. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is released over this element. | String |
| onselect | HTML: Specifies a script to be invoked when the element is selected. | String |
| parentComboBox | id of the parent combo box This is not a 'Parent' in terms of the component heirarchy; This is the component whose 'onchange' event triggers a refresh. | String |
| readonly | HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| required | A boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted. | String |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| tabindex | HTML: Specifies the position of this element within the tab order of the document. | String |
| title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
| validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
| value | The initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed | String |
| valueChangeListener | A method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute. | String |
| visibleOnUserRole | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. | String |
<s:autoUpdateDataTable>
Extended data_table that adds some additional features to the standard data_table action: see attribute descriptions for preserveDataModel, sortColumn, sortAscending and preserveSort. NOTE: This component is deprecated. Use periodicalUpdate mechanism of partial page rendering instead
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| align | HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01. | String |
| bgcolor | HTML: The background color of this element. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| bodyStyle | Corresponds to the HTML style attribute for the table body tag | String |
| bodyStyleClass | Corresponds to the HTML class attribute for the table body tag. | String |
| border | HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01. | String |
| cellpadding | HTML: Specifies the amount of empty space between the cell border and its contents. It can be either a pixel length or a percentage. | String |
| cellspacing | HTML: Specifies the amount of space between the cells of the table. It can be either a pixel length or a percentage of available space. | String |
| columnClasses | A comma separated list of CSS class names to apply to td elements in each column. | String |
| datafld | Reserved for future use. | String |
| dataformatas | Reserved for future use. | String |
| datasrc | Reserved for future use. | String |
| detailStampExpandedDefault | true|false - true if the detailStamp should be expanded by default. default: false | String |
| detailStampLocation | before|after - where to render the detailStamp, before the actual row or after it. default: after | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| embedded | Avoids rendering the html table tags, thus, giving you a table rendering just rows. You can use this together with the detailStamp faces of the parent datatable to render child-tables using the same layout as the parent. Notice: You have to ensure both tables do have the same number of columns. Using the colspan attribute of the column tag might help alot. | String |
| enabledOnUserRole | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. | String |
| first | The index of the first row to be displayed, where 0 is the first row. | String |
| footerClass | The CSS class to be applied to footer cells. | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| forceIdIndexFormula | A formula that overrides the default row index in the construction of table's body components. Example : #{myRowVar.key} Warning, the EL should evaluate to a unique value for each row ! | String |
| frame | HTML: Controls what part of the frame that surrounds a table is visible. Values include: void, above, below, hsides, lhs, rhs, vsides, box, and border. | String |
| frequency | Defines in seconds the interval of reloads. if no value is specified 2 seconds will be default. | String |
| headerClass | The CSS class to be applied to header cells. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| lang | HTML: The base language of this document. | String |
| newspaperColumns | The number of columns to wrap the table over. Default: 1 Set the number of columns the table will be divided over. | String |
| newspaperOrientation | The orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical". Default: vertical | String |
| onSuccess | Define javascript function to call after successful refresh. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is released over this element. | String |
| preserveDataModel | Indicates whether the state of the whole DataModel should be saved and restored. When set to false, the value-binding for the "value" attribute of this table is executed each time the page is rendered. When set to true, that value-binding is only executed when the component is first created, and the DataModel state is thereafter saved/restored automatically by the component. When column sorting is used for a table this property needs to be false so that the DataModel can be updated to reflect any changes in the sort criteria. Default: false | String |
| preserveRowStates | Indicates whether the state for each row should not be discarded before the datatable is rendered again. Setting this to true might be hepful if an input component inside the datatable has no valuebinding and the value entered in there should be displayed again. This will only work reliable if the datamodel of the datatable did not change either by sorting, removing or adding rows. Default: false | String |
| preserveSort | Indicates whether the state of the sortColumn and sortAscending attribute should be saved and restored and written back to the model during the update model phase. Default: true | String |
| previousRowDataVar | A parameter name, under which the previous RowData Object is set in request scope similar to the rowIndexVar and rowCountVar parameters. Mind that the value of this request scope attribute is null in the first row or when isRowAvailable returns false for the previous row. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| renderedIfEmpty | Indicates whether this table should be rendered if the underlying DataModel is empty. You could as well use rendered="#{not empty bean.list}", but this one causes the getList method of your model bean beeing called up to five times per request, which is not optimal when the list is backed by a DB table. Using renderedIfEmpty="false" solves this problem, because the MyFaces extended HtmlDataTable automatically caches the DataModel and calles the model getter only once per request. Default: true | String |
| rowClasses | A comma separated list of CSS class names to apply to td elements in each row. | String |
| rowCountVar | A parameter name, under which the rowCount is set in request scope similar to the var parameter. | String |
| rowGroupStyle | Corresponds to the HTML style attribute for grouped rows. | String |
| rowGroupStyleClass | StyleClass for grouped rows. | String |
| rowId | The id to use for | String |
| rowIndexVar | A parameter name, under which the current rowIndex is set in request scope similar to the var parameter. | String |
| rowOnClick | Defines a JavaScript onclick event handler for each table row | String |
| rowOnDblClick | Defines a JavaScript ondblclick event handler for each table row | String |
| rowOnKeyDown | Defines a JavaScript onkeydown event handler for each table row | String |
| rowOnKeyPress | Defines a JavaScript onkeypress event handler for each table row | String |
| rowOnKeyUp | Defines a JavaScript onkeyup event handler for each table row | String |
| rowOnMouseDown | Defines a JavaScript onmpusedown event handler for each table row | String |
| rowOnMouseMove | Defines a JavaScript onmousemove event handler for each table row | String |
| rowOnMouseOut | Defines a JavaScript onmouseout event handler for each table row | String |
| rowOnMouseOver | Defines a JavaScript onmouseover event handler for each table row | String |
| rowOnMouseUp | Defines a JavaScript onmouseup event handler for each table row | String |
| rowStyle | Corresponds to the HTML style attribute for the row tr tag. | String |
| rowStyleClass | Corresponds to the HTML class attribute for the row tr tag. | String |
| rows | The number of rows to be displayed. Specify zero for all remaining rows in the table. | String |
| rules | HTML: Controls how rules are rendered between cells. Values include: none, groups, rows, cols, and all. | String |
| sortAscending | Value reference to a model property that gives the current sort direction. The target Boolean property is set to true when the selected sortColumn should be sorted in ascending order, and false otherwise. The method which is bound to the "value" attribute of this table (ie which provides the DataModel used) is expected to use this property to determine how to sort the DataModel's contents. | String |
| sortColumn | Value reference to a model property that gives the current sort column name. The target String property is set to the "columnName" of whichever column has been chosen to sort by, and the method which is bound to the "value" attribute of this table (ie which provides the DataModel used) is expected to use this property to determine how to sort the DataModel's contents. | String |
| sortable | Define if the table is sortable or not | String |
| sortedColumnVar | A parameter name, under which the a boolean is set in request scope similar to the var parameter. TRUE for the column that is currently sorted, FALSE otherwise. | String |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| summary | HTML: Provides a summary of the contents of the table, for accessibility purposes. | String |
| title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
| value | An EL expression that specifies the data model that backs this table. The value can be of any type. A value of type DataModel is used directly. Array-like parameters of type java.util.List, array of Object, java.sql.ResultSet, or javax.servlet.jsp.jstl.sql.Result are wrapped in a DataModel. Other values are wrapped in a DataModel as a single row. | String |
| var* | Defines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value. | String |
| varDetailToggler | This variable has the boolean property "currentdetailExpanded" which is true if the current detail row is expanded and the action method "toggleDetail" which expand/collapse the current detail row. | String |
| visibleOnUserRole | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. | String |
| width | HTML: Specifies the desired width of the table, as a pixel length or a percentage of available space. | String |
<s:commandButtonAjax>
Extends standard commandButton allowing for dynamic ajax submitting of the form.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| accesskey | HTML: Sets the access key for this element. | String |
| action | Specifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal. | String |
| actionFor | Comma separated list of subForm-ids for which validation and model update should take place when this command is executed. You need to wrap your input components in org.apache.myfaces.custom.subform.SubForm instances for this to work. | String |
| actionListener | A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute. | String |
| alt | HTML: Specifies alternative text that can be used by a browser that can't show this element. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| disabled | HTML: When true, this element cannot receive focus. | String |
| enabledOnUserRole | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| image | HTML: The URL of an image that renders in place of the button. | String |
| immediate | A boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| lang | HTML: The base language of this document. | String |
| onFailure | Javascript method to call on failed ajax update | String |
| onStart | Javascript method to call on start of ajax update | String |
| onSuccess | Javascript method to call on successful ajax update | String |
| onblur | HTML: Specifies a script to be invoked when the element loses focus. | String |
| onchange | HTML: Specifies a script to be invoked when the element is modified. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onfocus | HTML: Specifies a script to be invoked when the element receives focus. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is released over this element. | String |
| onselect | HTML: Specifies a script to be invoked when the element is selected. | String |
| readonly | HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| tabindex | HTML: Specifies the position of this element within the tab order of the document. | String |
| title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
| type | HTML: A hint to the user agent about the content type of the linked resource. | String |
| value | The initial value of this component. | String |
| visibleOnUserRole | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. | String |
<s:conversation>
puts a bean into the conversation context add a bean under context control
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| action | Specifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal. | String |
| actionListener | A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| immediate | A boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| name | the name of the conversation. Notice: required if tag not as child of startConversation tag. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| value | The initial value of this component. | String |
<s:convertBoolean>
Converter that translates between boolean values (true/false) and alternate versions of those boolean values like (yes/no), (1/0), and (way/no way). <p/> To customize the representation of a boolean true and false, use {@link #setTrueValue(String)} and {@link #setFalseValue(String)} respectively. If not configured with these setter methods, it defaults to <code>true</code> and <code>false</code>. <p/> The values are case sensitive. <p/>
Can contain: empty
Attributes
| Name | Description | Type |
|---|---|---|
| falseValue | Value representing a boolean false, e.g. FALSE, no, 0, etc. | String |
| trueValue | Value representing a boolean true, e.g. TRUE, yes, 1, etc. | String |
<s:convertDateTime>
Simple convert that overrides the spec DateTimeConverter and uses TimeZone.getDefault() as the base timezone, rather than GMT. Convert date time using normal system timezone like it should
Can contain: empty
Attributes
| Name | Description | Type |
|---|---|---|
| dateStyle | longDesc = "default|short|medium|long|full" | String |
| locale | longDesc = "locale" | String |
| pattern | Custom formatting pattern | String |
| timeStyle | default|short|medium|long|full | String |
| timeZone | timeZome | String |
| type | date|time|both | String |
<s:convertNumber>
Converter which uses either the manually set <code>destType</code> or the value binding to determine the correct destination type to convert the number to This tag creates a number formatting converter and associates it with the nearest parent UIComponent. It uses either the manually set destType or the value binding to determine the correct destination type to convert the number to. Unless otherwise specified, all attributes accept static values or EL expressions.
Can contain: empty
Attributes
| Name | Description | Type |
|---|---|---|
| currencyCode | ISO 4217 currency code | String |
| currencySymbol | The currency symbol used to format a currency value. Defaults to the currency symbol for locale. | String |
| destType | The java class name the value should be converted to. Default: automatically determined through valueBinding | String |
| groupingUsed | Specifies whether output will contain grouping separators. Default: true. | String |
| integerOnly | Specifies whether only the integer part of the input will be parsed. Default: false. | String |
| locale | The name of the locale to be used, instead of the default as specified in the faces configuration file. | String |
| maxFractionDigits | The maximum number of digits in the fractional portion of the number. | String |
| maxIntegerDigits | The maximum number of digits in the integer portion of the number. | String |
| minFractionDigits | The minimum number of digits in the fractional portion of the number. | String |
| minIntegerDigits | The minimum number of digits in the integer portion of the number. | String |
| pattern | A custom Date formatting pattern, in the format used by java.text.SimpleDateFormat. | String |
| type | The type of formatting/parsing to be performed. Values include: number, currency, and percentage. Default: number. | String |
<s:convertStringUtils>
Converts the format of a string Provides runtime modification of a string. Uses Apache Lang StringUtils and WordUtils to peform operations. <p> Example: <code> <h:outputText value="#{backingBean.customer.name}"> <t:convertStringUtils format="capitalize" trim="true" maxLength="50"/> </h:outputText> </code> <p>
Can contain: empty
Attributes
| Name | Description | Type |
|---|---|---|
| appendEllipsesDuringInput | Boolean value determining if data should be truncated with ellipses during input conversion. Default = false | String |
| appendEllipsesDuringOutput | Boolean value determining if data should be truncated with ellipses during output conversion. Default = false | String |
| format | Specifies the output case of the string. One of uppercase | lowercase | capitalize | String |
| maxLength | Integer value for the maximum length of the rendered string. Strings longer than maxValue will be truncated at (maxValue - 3) and an ellipsis '...' will be appended. | String |
| trim | Boolean value determining is the string should be trimmed before any other formatting takes place. Default = false | String |
<s:effect>
provides javascript effects which are from the script.aculo.us library and from the fat fade anything technique library
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| duration | String | |
| enabledOnUserRole | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. | String |
| fade | String | |
| fadeColor | String | |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| lang | HTML: The base language of this document. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is released over this element. | String |
| puff | String | |
| pulsate | String | |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| scale | String | |
| scaleSize | String | |
| squish | String | |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
| visibleOnUserRole | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. | String |
<s:endConversation>
end a conversation
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| action | Specifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal. | String |
| actionListener | A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| errorOutcome | on exception use the given outcome for further navigation | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| immediate | A boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| name | the name of the conversation. Notice: required if tag not as child of startConversation tag. | String |
| onOutcome | end the conversation only if the action outcome matches the given onOutcome. This can be a comma separated list. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| restart | true|false|valueBinding - true if the conversation should be restarted immediately | String |
| restartAction | the action which should be called in case of a restart | String |
| value | The initial value of this component. | String |
<s:ensureConversation>
<p> Ensures a named conversation is running </p> <p> check if a conversation is active. </p> <p> The way this is done here is sub-optimal, once we are on jsf 1.2 it should be possible to check this before ANY rendering - and maybe to invoke a navigation then </p>
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| action | the action which should be called in case of a not running conversation | String |
| actionListener | A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| immediate | A boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| name | the name of the conversation. Notice: required if tag not as child of startConversation tag. | String |
| preCheck | Delegate the check to the action method at all. The user has to check if a conversation is running. A action method is mandatory. | String |
| redirectTo | redirect to the given view if the conversation is not running | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| value | The initial value of this component. | String |
<s:exporterActionListener>
Export datatable contents to an excel file or a pdf file.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| fileType | String | |
| filename | String | |
| for | String | |
| showDisplayedPageOnly | String |
<s:fieldset>
Renders an HTML Fieldset
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| enabledOnUserRole | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| legend | The fieldset's legend. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| visibleOnUserRole | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. | String |
<s:filterTable>
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| alternateRows | default=true see http://dojotoolkit.org filterTable | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| border | default=0 | String |
| cellpadding | default=0 | String |
| cellspacing | default=0 | String |
| first | The index of the first row to be displayed, where 0 is the first row. | String |
| headClass | default=fixedHeader see http://dojotoolkit.org filterTable | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| maxSortable | default=1 see http://dojotoolkit.org filterTable | String |
| multiple | default=true see http://dojotoolkit.org filterTable | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| rows | The number of rows to be displayed. Specify zero for all remaining rows in the table. | String |
| styleClass | CSS style class attribute | String |
| tbodyClass | default=scrollContent see http://dojotoolkit.org filterTable | String |
| value | An EL expression that specifies the data model that backs this table. The value can be of any type. A value of type DataModel is used directly. Array-like parameters of type java.util.List, array of Object, java.sql.ResultSet, or javax.servlet.jsp.jstl.sql.Result are wrapped in a DataModel. Other values are wrapped in a DataModel as a single row. | String |
| var* | Defines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value. | String |
<s:fishEyeCommandLink>
CommandLink component that can be used in nodeStamp facet
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| action | Specifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal. | String |
| actionListener | A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| caption | String | |
| iconSrc | String | |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| immediate | A boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| target | String | |
| value | The initial value of this component. | String |
<s:fishEyeNavigationMenu>
Provide a FishEye toolbar component from the DOJO toolkit A Mac OSX-style toolbar, using the DOJO toolkit.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| attachEdge | String | |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| conservativeTrigger | String | |
| effectUnits | String | |
| first | The index of the first row to be displayed, where 0 is the first row. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| itemHeight | String | |
| itemMaxHeight | String | |
| itemMaxWidth | String | |
| itemPadding | String | |
| itemWidth | String | |
| labelEdge | String | |
| orientation | String | |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| rows | The number of rows to be displayed. Specify zero for all remaining rows in the table. | String |
| value | An EL expression that specifies the data model that backs this table. The value can be of any type. A value of type DataModel is used directly. Array-like parameters of type java.util.List, array of Object, java.sql.ResultSet, or javax.servlet.jsp.jstl.sql.Result are wrapped in a DataModel. Other values are wrapped in a DataModel as a single row. | String |
| var* | Defines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value. | String |
| visibleWindow | String |
<s:floatingPane>
PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| constrainToContainer | limit to parent container | String |
| converter | The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. | String |
| displayCloseAction | if true a close button is displayed | String |
| displayMinimizeAction | if true a minimize button is displayed | String |
| hasShadow | Shadow drawn or not | String |
| iconSrc | The pane icon source | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| modal | Description for the attribute | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| resizable | Window resizable | String |
| style | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| taskBarId | The taskbar id | String |
| title | the floating pane Title | String |
| titleBarDisplay | Displays the title bar of the Window | String |
| value | The initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed | String |
| widgetId | Optional enforced dojo widgetId | String |
| widgetVar | optional widget var name, if this is not used only an autogenerated value is set | String |
| windowState | Display state of the window | String |
<s:focus>
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| converter | The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. | String |
| for | The JSF id of the component to receive focus. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| immediate | A boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| rememberClientFocus | String | |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| required | A boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted. | String |
| validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
| value | The initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed | String |
| valueChangeListener | A method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute. | String |
<s:form>
Renders a HTML form element which allow defining a different scheme, servername or port for the action url to which the form is submited
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| accept | HTML: Provides a comma-separated list of content types that the server processing this form can handle. | String |
| acceptcharset | HTML: The list of character encodings accepted by the server for this form. | String |
| action | This attribute can be used to set an entirely different action (might be something JSF-unspecific) to the form. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| enctype | HTML: The content type used to submit this form to the server. | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| lang | HTML: The base language of this document. | String |
| method | This attribute can be used to set a method to the form which is different to the regular POST method used. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is released over this element. | String |
| onreset | HTML: Script to be invoked when this form is reset. | String |
| onsubmit | HTML: Script to be invoked when this form is submitted. | String |
| port | This attribute can be used to set the port for the action attribute | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| scheme | This attribute can be used to set the url scheme for the action attribute | String |
| serverName | This attribute can be used to set the url server name or ip address for the action attribute | String |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| target | HTML: Names the frame that should display content generated by invoking this action. | String |
| title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
<s:graphicImageDynamic>
Extends standard graphicImage.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| align | HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01. | String |
| alt | HTML: Specifies alternative text that can be used by a browser that can't show this element. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| border | HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01. | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| enabledOnUserRole | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| height | HTML: Overrides the natural height of this image, by specifying height in pixels. | String |
| hspace | HTML: The amount of white space to be inserted to the left and right of this element, in undefined units. Deprecated in HTML 4.01. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| imageRendererClass | The class which implements org.apache.myfaces.custom.graphicimagedynamic.ImageRenderer. The image renderer is responsible for loading the image. The class must have a default constructor. Any request scoped attribute or managed bean is not available when this image renderer is instantiated and used. The image renderer must render the binary data for the image by using the parameters passed by nested f:param elements and/or using session or application scoped beans. | String |
| ismap | HTML: Specifies server-side image map handling for this image. | String |
| lang | HTML: The base language of this document. | String |
| longdesc | HTML: A link to a long description of the image. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is released over this element. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
| url | An alias for the "value" attribute. | String |
| usemap | HTML: Specifies an image map to use with this image. | String |
| value | A value binding which will be called to get the instance of an org.apache.myfaces.custom.graphicimagedynamic.ImageRenderer. | String |
| visibleOnUserRole | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. | String |
| vspace | HTML: The amount of white space to be inserted above and below this element, in undefined units. Deprecated in HTML 4.01. | String |
| width | HTML: Overrides the natural width of this image, by specifying width in pixels. | String |
<s:ifMessage>
Provide a component that will optionally render its children if the specified component(s) specified has a message. Renders children if any of the component(s) specified in "for" has a message in the context.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| for | String | |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
<s:imageLoop>
HTML image loop component. Image loop/slide show component. Provides Javascript methods to control image loop behaviour. Methods: getImageLoop(id) - get image loop object with id, play() - play loop, stop() - stop loop, accelerate() - accelerate loop until minDelay reached, decelerate() - decelerate loop until maxDelay reached, setImageIndex(index) - show image with index, reset() - reset settings to origin values, getImageCount() - get number of images loaded
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| delay | The delay between transitions | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| height | Height | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| maxDelay | The maximum delay allowed when increasing delay time | String |
| minDelay | The minimum delay allowed when decreasing delay time | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| transitionTime | Transition time in milliseconds. Set to -1 for immediate image switch. | String |
| width | Width | String |
<s:imageLoopItem>
Image loop item.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| url | An alias for the "value" attribute. | String |
| value | The URL of the image. If the URL starts with a '/', it is relative to the context path of the web application. | String |
<s:imageLoopItems>
Image loop items.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| value | An EL expression that specifies the elements of the image loop. The expression can refer to one of the following: <ol> <li>A single GraphicItem</li> <li>An array or Collection of GraphicItem instances</li> </ol> The value properties of each of the ImageLoopItems must be of the same basic type as the parent component's value. | String |
<s:inputSuggest>
Provides an input textbox with "suggest" functionality.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| accesskey | HTML: Sets the access key for this element. | String |
| alt | HTML: Specifies alternative text that can be used by a browser that can't show this element. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| converter | The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| disabled | HTML: When true, this element cannot receive focus. | String |
| forceId | Gets If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | Gets If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| imageLocation | Gets An alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter. | String |
| immediate | A boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| javascriptLocation | Gets An alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter. | String |
| lang | HTML: The base language of this document. | String |
| maxlength | HTML: The maximum number of characters allowed to be entered. | String |
| onblur | HTML: Specifies a script to be invoked when the element loses focus. | String |
| onchange | HTML: Specifies a script to be invoked when the element is modified. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onfocus | HTML: Specifies a script to be invoked when the element receives focus. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is released over this element. | String |
| onselect | HTML: Specifies a script to be invoked when the element is selected. | String |
| readonly | HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled. | String |
| rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
| required | A boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted. | String |
| size | HTML: The initial width of this control, in characters. | String |
| style | HTML: CSS styling instructions. | String |
| styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
| styleLocation | Gets An alternate location to find stylesheet resources. If no values is specified, stylesheets will be loaded from the resources directory using AddResource and ExtensionsFilter. | String |
| tabindex | HTML: Specifies the position of this element within the tab order of the document. | String |
| title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
| validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
| value | The initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed | String |
| valueChangeListener | A method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute. | String |
<s:inputSuggestAjax>
Provides an input textbox with "suggest" functionality, using an ajax request to the server.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|---|---|
| accesskey | HTML: Sets the access key for this element. | String |
| align | HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01. | String |
| alt | HTML: Specifies alternative text that can be used by a browser that can't show this element. | String |
| autoComplete | If false, the input field is not automatically populated with the first suggested value. Default: true | String |
| autocomplete | Non HTML standard attribute to disable browser's autocomplete function. | String |
| binding | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. | String |
| charset | Force the charset of the Response | String |
| converter | The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. | String |
| datafld | Reserved for future use. | String |
| dataformatas | Reserved for future use. | String |
| datasrc | Reserved for future use. | String |
| dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
| disabled | HTML: When true, this element cannot receive focus. | String |
| disabledOnClientSide | If true the input is rendered disabled on the client side and a hidden input is used to actualy submit his value back to the server. | String |
| displayValueOnly | If true, renders only the value of the component, but no input widget. Default is false. | String |
| displayValueOnlyStyle | Style used when displayValueOnly is true. | String |
| displayValueOnlyStyleClass | Style class used when displayValueOnly is true. | String |
| enabledOnUserRole | If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered. | String |
| forceId | If true, this component will force the use of the specified id when rendering. | String |
| forceIdIndex | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) | String |
| id | An identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. | String |
| imageLocation | An alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter. | String |
| immediate | A boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. | String |
| itemLabelMethod | Method which gets a suggested Object as an argument and returns a calculated String label. With this attribute it is possible to achieve the same mechanism as it can be found at select menues with the label/value pair. | String |
| javascriptLocation | An alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter. | String |
| lang | HTML: The base language of this document. | String |
| maxSuggestedItems | optional attribute to identify the max size of suggested Values. If specified in tableSuggestAjax, paginator functionality is used. | String |
| maxlength | HTML: The maximum number of characters allowed to be entered. | String |
| onblur | HTML: Specifies a script to be invoked when the element loses focus. | String |
| onchange | HTML: Specifies a script to be invoked when the element is modified. | String |
| onclick | HTML: Script to be invoked when the element is clicked. | String |
| ondblclick | HTML: Script to be invoked when the element is double-clicked. | String |
| onfocus | HTML: Specifies a script to be invoked when the element receives focus. | String |
| onkeydown | HTML: Script to be invoked when a key is pressed down over this element. | String |
| onkeypress | HTML: Script to be invoked when a key is pressed over this element. | String |
| onkeyup | HTML: Script to be invoked when a key is released over this element. | String |
| onmousedown | HTML: Script to be invoked when the pointing device is pressed over this element. | String |
| onmousemove | HTML: Script to be invoked when the pointing device is moved while it is in this element. | String |
| onmouseout | HTML: Script to be invoked when the pointing device is moves out of this element. | String |
| onmouseover | HTML: Script to be invoked when the pointing device is moved into this element. | String |
| onmouseup | HTML: Script to be invoked when the pointing device is release |