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. - version 1.1.7
Enhanced standard JSP actions and custom MyFaces actions.
Namespace definition: xmlns:s="http://myfaces.apache.org/sandbox"
Tags
- 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
- 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 Converter which modifies a string by changing the input text into upper case, lower case, capitalized
- effect provides javascript effects which are from the script
- exporterActionListener Export datatable contents to an excel file or a pdf file
- filterTable
- fishEyeCommandLink CommandLink component that can be used in nodeStamp facet
- fishEyeNavigationMenu Provide a FishEye toolbar component from the DOJO toolkit A navigation menu/toolbar with a nice mouse-over effect, similar to the Mac OS X Dock
- floatingPane PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad
- focus
- focus2
- 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
- globalId A simple container-component that causes its child components to render a clientId value without any prefix
- 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
- 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 Embeds into the current page a javascript object with methods which can be called to display (and hide) a modal popup window
- 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 The passwordStrength component is needed by the web sites which ask the user to enter a powerful password for the purpose of the registration stuff
- 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
- renderOne Tag that allows rendering the first child either by index or the first rendered one
- 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
- sortableColumn
- 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
- 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
- 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
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | String |
label | A display name for this component. | 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. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | 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 which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | 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 |
captionClass | A comma separated list of CSS class names to apply to all captions. If there are less classes than the number of rows, apply the same sequence of classes to the remaining captions, so the pattern is repeated. More than one class can be applied to a row by separating the classes with a space. | String |
captionStyle | Gets The CSS class to be applied to the Caption. | 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 |
derivedRowKeyPrefix | This attribute is used to append an unique prefix when rowKey is not used, to prevent a key match a existing component id (note two different components can't have the same unique id). | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 |
rowKey | Used to assign a value expression that identify in a unique way a row. This value will be used later instead of rowIndex as a key to be appended to the container client id using getDerivedSubClientId() method. | 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. <p> The value referenced by the EL expression can be of any type. </p> <ul> <li>A value of type DataModel is used directly.</li> <li>Array-like parameters of type array-of-Object, java.util.List, java.sql.ResultSet or javax.servlet.jsp.jstl.sql.Result are wrapped in a corresponding DataModel that knows how to iterate over the elements.</li> <li>Other values are wrapped in a DataModel as a single row.</li> </ul> <p> Note in particular that unordered collections, eg Set are not supported. Therefore if the value expression references such an object then the table will be considered to contain just one element - the collection itself. </p> | String |
valueType | Indicate the expected type of the EL expression pointed by value property. It is useful when vb.getType() cannot found the type, like when a map value is resolved on the expression. | String |
var | Defines the name of the request-scope variable that will hold the current row during iteration. <p> During rendering of child components of this UIData, the variable with this name can be read to learn what the "rowData" object for the row currently being rendered is. </p> <p> This value must be a static value, ie an EL expression is not permitted. </p> | 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 | The action to take when this command is invoked. <p> 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. </p> <p> 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. </p> | 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 | * | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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. <p> 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. </p> | String |
label | A display name for this component. | 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 text to display to the user for this command 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: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
<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 |
---|---|---|
binding | A ValueExpression that evaluates to a DateTimeConverter. | String |
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 <p> Converter which modifies a string by changing the input text into upper case, lower case, capitalized. The input string can be optionally trimmed and truncated at some max length. Ellipses (...) can be added to a truncated string. </p> <p> Provides runtime modification of a string. Uses Apache Lang StringUtils and WordUtils to peform operations. </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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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: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 | Defines the index of the first row to be displayed, starting from 0. | String |
headClass | default=fixedHeader see http://dojotoolkit.org filterTable | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 | Defines the maximum number of rows of data to be displayed. <p> Specify zero to display all rows from the "first" row to the end of available data. </p> | 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. <p> The value referenced by the EL expression can be of any type. </p> <ul> <li>A value of type DataModel is used directly.</li> <li>Array-like parameters of type array-of-Object, java.util.List, java.sql.ResultSet or javax.servlet.jsp.jstl.sql.Result are wrapped in a corresponding DataModel that knows how to iterate over the elements.</li> <li>Other values are wrapped in a DataModel as a single row.</li> </ul> <p> Note in particular that unordered collections, eg Set are not supported. Therefore if the value expression references such an object then the table will be considered to contain just one element - the collection itself. </p> | String |
var | Defines the name of the request-scope variable that will hold the current row during iteration. <p> During rendering of child components of this UIData, the variable with this name can be read to learn what the "rowData" object for the row currently being rendered is. </p> <p> This value must be a static value, ie an EL expression is not permitted. </p> | String |
<s:fishEyeCommandLink>
CommandLink component that can be used in nodeStamp facet
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
action | The action to take when this command is invoked. <p> 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. </p> <p> 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. </p> | String |
actionListener | * | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
target | * | String |
value | The text to display to the user for this command component. | String |
<s:fishEyeNavigationMenu>
Provide a FishEye toolbar component from the DOJO toolkit <p> A navigation menu/toolbar with a nice mouse-over effect, similar to the Mac OS X Dock. It is actually a JSF implementation of the Fisheye List widget from the <a href="http://dojotoolkit.org/">Dojo Toolkit</a>. </p> <p> The component makes use of the Tomahawk navigation framework, so the menu items can be added using t:navigationMenuItem child components. </p>
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 | Defines the index of the first row to be displayed, starting from 0. | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 | Defines the maximum number of rows of data to be displayed. <p> Specify zero to display all rows from the "first" row to the end of available data. </p> | String |
value | An EL expression that specifies the data model that backs this table. <p> The value referenced by the EL expression can be of any type. </p> <ul> <li>A value of type DataModel is used directly.</li> <li>Array-like parameters of type array-of-Object, java.util.List, java.sql.ResultSet or javax.servlet.jsp.jstl.sql.Result are wrapped in a corresponding DataModel that knows how to iterate over the elements.</li> <li>Other values are wrapped in a DataModel as a single row.</li> </ul> <p> Note in particular that unordered collections, eg Set are not supported. Therefore if the value expression references such an object then the table will be considered to contain just one element - the collection itself. </p> | String |
var | Defines the name of the request-scope variable that will hold the current row during iteration. <p> During rendering of child components of this UIData, the variable with this name can be read to learn what the "rowData" object for the row currently being rendered is. </p> <p> This value must be a static value, ie an EL expression is not permitted. </p> | 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 | An expression that specifies the Converter for this component. <p> 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. </p> | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 | Gets The initial value of this component. | 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 | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | String |
for | The JSF id of the component to receive focus. | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | 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. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | String |
validator | A method-binding EL expression which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | String |
<s:focus2>
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 | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | String |
focusAndSubmitOnEnter | Defines an id of a command-button or command-link that will be focussed and submitted when the enter-key is pressed. | String |
focusOnError | Defines that the first element of the form with an associated error should receive the focus by default (if the override focus-id attribute wasn't set). | String |
focusOnFirst | Defines that the first element of the form should receive the focus by default (if the overrideFocusId-attribute is not specified, no error has been queued and the focus has not already been set). | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | String |
overrideFocusId | The id (locally in this naming container) of the component which should receive the focus. Overrides all other behaviour if set. | 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. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | String |
validator | A method-binding EL expression which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | The client-id (fully specified as a concatenation of the id of this component and all naming container parent ids) of the component which receives the focus (works only if overrideFocusId hasn't been set and no error has been queued). The value will automatically be updated when the focus is changed. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 |
prependId | * | 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:globalId>
A simple container-component that causes its child components to render a clientId value without any prefix. <p> Important: this component works only when run in a JSF-1.2 (or later) environment. When run in a JSF-1.1 environment it will not cause an error, but will instead act like a NamingContainer itself, ie will <i>add</i> its own id to the child component's clientId. </p> <p> Every JSF component has a "clientId" property; when the component is rendered, many components output this as part of the rendered representation. In particular, when rendering HTML, many components write an "id" attribute on their html element which contains the clientId. The clientId is defined as being the clientId value of the nearest NamingContainer ancestor plus ":" plus the component's id. </p> <p> The prefixing of the parent container's clientId is important for safely building views from multiple files (eg using Facelets templating or JSP includes). However in some cases it is necessary or useful to render a clientId which is just the raw id of the component without any naming-container prefix; this component can be used to do that simply by adding an instance of this type as an ancestor of the problem components. This works for <i>all</i> JSF components, not just Tomahawk ones. </p> <p> Use of this component should be a "last resort"; having clientIds which contain the id of the ancestor NamingContainer is important and useful behaviour. It allows a view to be built from multiple different files (using facelets templating or jsp includes); without this feature, component ids would need to be very carefully managed to ensure the same id was not used in two places. In addition, it would not be possible to include the same page fragment twice. </p> <p> Ids are sometimes used by Cascading Style Sheets to address individual components, and JSF compound ids are not usable by CSS. However wherever possible use a style <i>class</i> to select the component rather than using this component to assign a "global" id. </p> <p> Ids are sometimes used by javascript "onclick" handlers to locate HTML elements associated with the clicked item (document.getById). Here, the onclick handler method can be passed the id of the clicked object, and some simple string manipulation can then compute the correct clientId for the target component, rather than using this component to assign a "global" id to the component to be accessed. </p> <p> This component is similar to the "forceId" attribute available on many Tomahawk components. Unlike the forceId attribute this (a) can be used with all components, not just Tomahawk ones, and (b) applies to all its child components. </p> <p> Note that since JSF1.2 forms have the property prefixId which can be set to false to make a UIForm act as if it is not a NamingContainer. This is a good idea; the form component should probably never have been a NamingContainer, and disabling this has no significant negative effects. </p>
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
<s:graphicImageDynamic>
Extends standard graphicImage. <p> This tag renders a html img tag and can be used to render dynamic images. </p> <p> Embedding images into html pages requires a second request to get the binary data stream of the image. The result is that the state of the view including the state of request scoped beans will not be available when the image is requested. </p> <p> The image data is written by an image renderer which can be defined by the imageRendererClass attribute. </p> <p> This component is able to use nested f:param elements to pass parameters to the image renderer. </p>
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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. <p> If the URL starts with a '/', it is relative to the context path of the web application. </p> | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 |
autocomplete | If the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing. | 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 | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 action events should fire. <p> 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. </p> | 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 |
label | A display name for this component. | 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. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | 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 which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | 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 | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 action events should fire. <p> 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. </p> | 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 |
label | A display name for this component. | 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 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. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | 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 | 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 |
suggestedItemsMethod | Reference to the method which returns the suggested items | 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 which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | 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:inputTextAjax>
Extends standard inputText allowing for dynamic ajax submitting.
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 | 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 |
cancelText | Text for cancel | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | 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 |
errorStyle | Style for the input field where the error occures. Useful if there is only one messages area for a few inputTextAjax fields | String |
errorStyleClass | StyleClass for the input field where the error occures. Useful if there is only one messages area for a few inputTextAjax fields | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | String |
label | A display name for this component. | String |
lang | HTML: The base language of this document. | String |
maxlength | HTML: The maximum number of characters allowed to be entered. | String |
okText | Test for button | 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 |
required | A boolean value that indicates whether an input value is required. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | String |
showCancelButton | Whether to show cancel button | String |
showOkButton | Whether to show an ok button before sending update. | 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 |
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 which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | 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:layoutingContentPane>
Base content pane for the dojo layouts jsfed dojo content pane
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
adjustPaths | Path adjustment as defined by dojo | 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 |
cacheContent | * | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
executeScripts | If true scripts will be evaled after rendering | String |
extractContent | Defined by dojo, see the examples | String |
handler | Javascript function which should generate the content | String |
href | Remote href for iframe simulation | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
layoutAlign | Layoutalignment usable in conjunction with a layout container | String |
parseContent | Defined by dojo see the examples | String |
preload | Content Preloading | String |
refreshOnShow | Description for the attribute | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
scriptScope | Scopecontainer for downloaded Scripts | String |
sizeShare | Size share value describing the place the content pane wants from its parent | 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 |
value | Gets The initial value of this component. | String |
widgetId | Optional enforced dojo widgetId | String |
widgetVar | optional widget var name, if this is not used only an autogenerated value is set | String |
<s:layoutingSplitPane>
PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
activeSizing | Size share value describing the place the content pane wants from its parent | 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 | An expression that specifies the Converter for this component. <p> 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. </p> | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
lastPoint | Last point of the split pane | String |
orientation | horizontal or vertical | String |
persist | If true, cookie persisting of the split pane is enabled | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
sizeShare | Size share value describing the place the content pane wants from its parent | String |
sizerWidth | width of the sizer bar | String |
startPoint | Starting Point of the split pane as defined by dojo | 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 |
value | Gets The initial value of this component. | String |
widgetId | Optional enforced dojo widgetId | String |
widgetVar | optional widget var name, if this is not used only an autogenerated value is set | String |
<s:layoutingTitlePane>
Title Pane layouting element. TitlePane Component class
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 |
containerNodeClass | the css node class for the container part of the element | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
label | Label for the titled paned element | String |
labelNodeClass | the css node class for the label part of the pane | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | 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 |
value | Gets The initial value of this component. | String |
widgetId | Optional enforced dojo widgetId | String |
widgetVar | optional widget var name, if this is not used only an autogenerated value is set | String |
<s:listener>
Allows a component to listen for events on another component with AJAX input elements. On is the id of the component you want to listen on. eventType is what happened to the component, for instance "onChange" action is what to do if the event occurs, default is "update". Will be able to call arbitrary javascript functions too. NOTE: eventType and action are NOT implemented yet
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
action | NOT IMPLEMENTED - Action to take (ie: update, submit, call (call a javascript 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 |
eventType | NOT IMPLEMENTED - Type of event (ie: onchange, onclick) | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
on | Id of another component. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
<s:loadBundle>
Extended loadbundle which does its job in all life-cycle phases or even on calling LoadBundle.loadBundle() - not only when rendering happens... A load-bundle alternative which allows to use load-bundle even on AJAX-enabled pages. <p/> A component that allows to load bundles not only on rendering, but whenever the page author needs it. By default, it loads it on every lifecycle phase except restore-state and save-state.* <p/> The core-load-bundle only loads its message-bundle on rendering - this load-bundle does it on every life-cycle, and optionally whenever the method loadBundle is called.
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
basename | Path to the bundle-file in the class-path, e.g.: org.apache.myfaces.i18n.myprops | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
var | Variable this bundle will be stored under, e.g. mybundle. Use #{mybundle.propertykey} or #{mybundle['propertykey']} to access the keys of the bundle. | String |
<s:media>
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 |
contentType | Determines the media content type. | String |
height | Integer to indicate the media height. | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
source | Determines the path of the media file. | String |
width | Integer to indicate the media weight. | String |
<s:message>
MyFaces extension to the standard messages tag: see summaryDetailSeparator attribute
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 |
detailFormat | If present, instead of rendering the message detail, a MessageFormat with this attribute as pattern is created. The format method of this MessageFormat is called with the message detail as the first argument and the label of the associated component (if any) as the second argument. Example: "The input in field {1} is wrong: {0}" | 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 |
errorClass | CSS class to be used for messages with severity "ERROR". | String |
errorStyle | CSS style to be used for messages with severity "ERROR". | String |
fatalClass | CSS class to be used for messages with severity "FATAL". | String |
fatalStyle | CSS style to be used for messages with severity "FATAL". | String |
for* | The ID of the component whose attached FacesMessage object (if present) should be diplayed by this component. <p> This is a required property on the component. </p> | 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 |
forceSpan | If set to true, an empty span element is rendered. Useful if there is an inputAjax field and the corresponding error message is displayed there. | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
infoClass | CSS class to be used for messages with severity "INFO". | String |
infoStyle | CSS style to be used for messages with severity "INFO". | 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 |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
replaceIdWithLabel | If present, all occurrences of the id of the component for which the message is rendered will be replaced by the label. Default: true. | String |
showDetail | Specifies whether the detailed information from the message should be shown. Default to true. | String |
showSummary | Specifies whether the summary information from the message should be shown. Defaults to false. | String |
style | HTML: CSS styling instructions. | String |
styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
summaryFormat | If present, instead of rendering the message summary, a MessageFormat with this attribute as pattern is created. The format method of this MessageFormat is called with the message summary as the first argument and the label of the associated component (if any) as the second argument. Example: "{0}:" | String |
title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
tooltip | If true, the message summary will be rendered as a tooltip (i.e. HTML title 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 |
warnClass | CSS class to be used for messages with severity "WARN". | String |
warnStyle | CSS style to be used for messages with severity "WARN". | String |
<s:modalDialog>
Embeds into the current page a javascript object with methods which can be called to display (and hide) a modal popup window. <p> When the popup window is displayed, the current window contents become "greyed out" and the new window appears on top of the original. The original window does not respond to keys or clicks; only the new window can be accessed by the user. When the popup window is closed then the original window is again accessable. </p> <p> When this component has a child facet named "titleBar" then the contents of that facet are rendered at the top of the popup window. This facet is intended to allow users to define their own custom window "decoration". </p> <p> When this component has no "titleBar" facet, but does have a "dialogTitle" property, then a default window decoration is generated. It consists of a table row with two cells. The left cell contains the dialogTitle text. If property renderCloseButton is true, then the right cell holds a "close" icon. Styles are defined for the row and cells so that the look-and-feel can be customised. </p> <p> The new window can optionally load a page from the server when it is displayed. If one of viewId or contentURL is defined, then an internal frame is inserted after the titleBar, and the specified contents is immediately loaded into the popup window when it is displayed. </p> <p> The rest of the child components (ie other than titleBar) are displayed after the titlebar (and after the contents of viewId or contentURL if it is defined). </p> <p> This component internally uses the Dojo modal window widget. </p>
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 |
closeButton | Specifies whether there should be a "close" icon to the right of the popup window title. <p> Ignored if there is a "titleBar" facet as a child, or dialogTitle is not defined. </p> <p> Defaults to true. </p> | String |
contentURL | The URL to show within the content area of the dialog. <p> This may be: </p> <ul> <li>an absolute url ("http://..")</li> <li>a url relative to the current webapp</li> <li>a url relative to the current page</li> </ul> | String |
dialogAttr | A space separated list with attribute='value' pairs, which control the behaviour of the dojo dialog. | String |
dialogId | An optional raw id to assign to the html div that encloses the modal dialog. <p> This id can be useful for controlling the dialog with javascript. However in most cases it is not necessary. </p> <p> If this is property is not defined then an id will be automatically generated. </p> | String |
dialogTitle | The title text to show in the title area of the popup window (ie the "window decoration"). <p> Ignored if there is a "titleBar" facet as a child. </p> | String |
dialogVar | Specifies the name of the javascript variable which provides access to the dialog functionality. <p> For example, if this is "myDialog" then a javascript object with name "myDialog" will be defined. This exposes the following methods: </p> <ul> <li>myDialog.show() will display the modal dialog window</li> <li>myDialog.hide() will hide it (though this is not normally needed).</li> </ul> | String |
hiderIds | A list of ids of components which, when activated, should cause the popup dialog to be hidden. <p> If the standard title-bar is displayed (ie no custom titleBar facet exists, and property dialogTitle is defined) then the standard close-button in that bar is automatically included. </p> <p> If the child components of this component (which will appear in the popup) include other items that should cause the window to close (ie a button) then their ids should be defined via this property. This component will then automatically wire them up to the necessary functions to cause the popup to be closed when they are activated. </p> | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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. <p> This value is also used as a base for defining style classes for parts of the standard window "title bar" decoration. </p> | String |
viewId | The URL of the view to show within the content area of the dialog. <p> Optional; when not defined (or defined as an EL expression, but that expression returns null) then the popup dialog will be opened with no content. Presumably custom javascript in the calling page will arrange to populate the window content appropriately. </p> <p> The modalDialog component treats this as a <i>url</i> relative to the webapp base. The value should not start with a slash. </p> <p> Note that technically this value is not a viewId. A viewId is the internal path to the page definition (eg "foo.jsp" or "foo.xhtml"). What the browser accesses is a URL (which contains the path that triggers the facelets servlet, eg "foo.faces" or "foo.jsf" or "/faces/foo". </p> The valueIt should not start with a slash. | String |
widgetId | Optional enforced dojo widgetId | String |
widgetVar | An alias for the "dialogVar" property. | String |
<s:outputLinkDynamic>
Extends standard outputLink but links to a dynamically rendered resource (image, file, ...).
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
accesskey | HTML: Sets the access key for 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 |
charset | HTML: Specifies the character encoding of the linked resource. | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
coords | HTML: The coordinates of regions within a client side image map. | String |
dir | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). | String |
disabled | 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 |
hreflang | HTML: The language of the linked resource. | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
lang | HTML: The base language of this document. | String |
onblur | HTML: Specifies a script to be invoked when the element loses focus. | 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 |
rel | HTML: The relationship between the current document and the linked resource. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
resourceRendererClass | The class which implements org.apache.myfaces.custom.dynamicResources.ResourceRenderer. The resource renderer is responsible for resource the image. The class must have a default constructor. Any request scoped attribute or managed bean is not available when this resource renderer is instantiated and used. The resource renderer must render the binary data for the resource by using the parameters passed by nested f:param elements and/or using session or application scoped beans. | String |
rev | HTML: The type(s) describing the reverse link for the linked resource. | String |
shape | HTML: The shape of a region in a client side image map. | 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 |
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 |
type | HTML: A hint to the user agent about the content type of the linked resource. | String |
value | Gets 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:outputText>
Extending the outputText component in order to introduce the for attribute.
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 | An expression that specifies the Converter for this component. <p> 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. </p> | 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 |
escape | Indicates whether rendered markup should be escaped. Default: true | String |
for | Specify the id of the dom element where the label should be put in | String |
forValue | Specify the id of the dom element where the value should be put in. This value is also included in the suggested table, but only in a hidden span element following the span for the label in one row. | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
label | To provide a second value in form of a label. Usage like SelectItem. Label is brought to client in a hidden span element near the value. | 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 |
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 |
value | Gets 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:passwordStrength>
The passwordStrength component is needed by the web sites which ask the user to enter a powerful password for the purpose of the registration stuff. <p> The component enables its user to know the strength of the password while (he/she) types it before even submit the form to the server [please see the screenshots]. </p> <p> The component enables its user to define his custom security policy for his password in an easy manner. </p> <p> The component also have 2 types of presenting the password strength. Till now the strength can be represented as text or progressbar. </p>
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 the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing. | 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 | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | String |
customSecurityExpression | This string determines the expression of the custom security rule of the password <p> Note that the expression has the following format : </p> <p> ******************************************************* </p> <p> S (Number) N (Number) A (Number) </p> <ul> <li>Where S stands for Symbols</li> <li>Where N stands for Numbers</li> <li>Where A stands for Alphabets</li> </ul> <p> ******************************************************* </p> <p> For example) A4N2S3A2 Means that the password will be as following : </p> <ul> <li>4 or more Alphabets followed by</li> <li>2 or more Numbers followed by</li> <li>3 or more Symbols followed by</li> <li>2 or more Alphabets</li> </ul> <p> ******************************************************* </p> <p> Note also that the useCustomSecurity should be set to true. </p> | 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 |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | String |
label | A display name for this component. | 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 |
penaltyRatio | This attribute determines the penalty ratio that will decrease the password Strength if the custom security expression is not met. Note also that the useCustomSecurity should be set to true to apply this flag. Possible values from 0 to 100. Default value is 50. | String |
preferredPasswordLength | The prefered length of the password | String |
prefixText | The prefix of the component message | 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. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | String |
showDetails | This flag {true | false} determines whether to show the details (left characters). default is true | String |
size | HTML: The initial width of this control, in characters. | String |
strengthIndicatorType | This flag determines the indicator type. It can be {text or bar}. Default is text | 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 |
textStrengthDescriptions | The text strength descriptions | String |
title | HTML: An advisory title for this element. Often used by the user agent as a tooltip. | String |
useCustomSecurity | This flag determines whether to user custom security rules instead of just depending on the password length. The default is false. | String |
validator | A method-binding EL expression which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | String |
<s:pprPanelGroup>
AJAX component which supports updating its children via AJAX calls. These updates can occur regularly or based on triggering input components.
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
afterUpdateJSHook | Javascript code executed after a ppr update has been completed | String |
appendMessages | comma separated List of client Ids that specify the messages components in the page to which messages are appended by this PPRPanelGroup | 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 |
colspan | standard html colspan attribute for table cell | String |
componentUpdateFunction | client javascript function which will do the actual dom update. function signature: function(formNodeElement, updateTargetElement, pprResponseElement) | 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 |
excludeFromStoppingPeriodicalUpdate | Normally when a link is clicked during periodical update, the update is stopped in order to prevent the server from getting unexpected requests. For any POST-request this is the wanted behaviour because the screen is completely refreshed and periodical updating starts again after the response. However, this behaviour may be unwanted e.g. in case of opening a new window with a link where the main screen should stay refreshed. This attribute takes a regular expression of link-client-ids for which the periodical update should not be stopped. If this value is given, there will be a default timeout of 2000 milliseconds before any periodical update will start again. This is done as mentioned before in order to prevent the server from getting unexpected requests. This timeout can be influenced via the waitBeforePeriodicalUpdate attribute. | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
inlineLoadingMessage | If this attribute is set the content of the PPRPanelGroup will be replaced by the provided Loading-Message during partial update | String |
lang | HTML: The base language of this document. | String |
layout | Determines the type of layout that is used when rendering a panelGroup: when 'block' is specified, an HTML div is rendered instead of the default HTML span. | 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 |
partialTriggerPattern | Regular Expression If the client Id of a submitting Component matches this Pattern the corresponding pprPanelGroup is updated via AJAX | String |
partialTriggers | Comma or Space seperated List of ids from ui_command-items which trigger a partial update of this PanelGroup | String |
periodicalTriggers | If a periodicalUpdate is set this trigger starts the periodical requests. No partialTriggers are needed. | String |
periodicalUpdate | Does a periodical refresh of the partial page inside the ppr group. In milliseconds. No partialTriggers are needed. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
replaceMessages | comma separated List of client Ids that specify the messages components in the page which messages are replaced by this PPRPanelGroup | String |
showDebugMessages | If false, alert messages which can be fired after a ppr response are not displayed in the browser. May switched to true in test environments. Default: false | String |
stateUpdate | If set to false, there will be no stateUpdate on server side due to the partialPage refresh. Default: 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 |
waitBeforePeriodicalUpdate | This attribute only works in combination with the excludeFromStoppingPeriodicalUpdate attribute. The value in milliseconds tells the periodical update mechanism to stop for the given amount of time after clicking a link, specified by the excludeFromStoppingPeriodicalUpdate attribute. The default value is 2000 milliseconds. | String |
<s:pprSubmit>
PPRSubmitTag can be attached to command components, enabling PPR-request inside UIData components
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
processComponentIds | comma separated List of component ids to process. As usual the whole form will be transmitted and rerendered, but only for the components configured validation and update-model will happen. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
<s:renderOne>
Tag that allows rendering the first child either by index or the first rendered one. <p> A component that only renders the first child either by index or the first visible one.. </p>
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
type | The filter type: first|index. first: the first list value should evaluate to a Number or a value that can be parsed into an integer. index: A collection, array or comma-separated list of numbers. (Default: "first") | String |
value | The value valid for the type. If this evaluates to null, the first child will be rendered. If the type is "first", this value will be ignored, as "first" always renders the first rendered item. If the type is "index", the value must be a number. | String |
<s:roundedDiv>
Component that allows for a rounded border effect on DIV tags that is supported in CSS2 compatible browsers and IE6. <p> Component that generates a DIV tag with rounded corners that may be either 3D or 2D in appearence. </p><p> The "roundedDiv" component creates a DIV tag that contains images to produce rounded corners. The rounded effect can be either 3D with lighting effects or 2D with a solid color border. </p>
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
backgroundColor | Background color to give the corners. Leave blank (null) to have a transparent background. If the user is using IE6, this has to be set, or the corners will not look good due to IE6's lack of PNG support. | 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 |
borderColor | The color of the border. If specified, this will cause the DIV to be 2D, if it isn't the border with have a 3D effect with lighting effects to produce the border color. | String |
borderWidth | The width of the border in pixels. (Default: 8) | String |
color | The foreground color of the DIV | String |
contentStyle | The CSS style to give to the content DIV or TD (based on layout) | String |
contentStyleClass | The CSS style class to give to the content DIV or TD (based on layout) | String |
corners | This allows you to specify a comma-separated list of corners to include. If not given, all four corners will be rendered. The corners include the sides they touch. So for example, if used as a tab for a tabbed pane, you could specify "topleft,topright" to have everything but the bottom corners and side have the border. Valid values are: topleft, topright, bottomright, bottomleft | 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 |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
inverse | Flips the lightening/darkening effect for 3D borders. (Default: false) | String |
lang | HTML: The base language of this document. | String |
layout | Either "table" or "div". Specifies how the output should be rendered. Size must be null if using "table" (if it is not, a div will be rendered). (Default: div) | 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 |
radius | The radius of the corners in pixels. (Default: 8) | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
size | If given, a static size image will be produced. This could be useful for older browsers. If not given, the DIV that will be created will stretch to its contents using CSS2 (and CSS expressions in IE6). Value must contain two numbers, with width first. Example: 640x480 | 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:scope>
Scope control which does basically the same as savestate but bypasses the serialization and utilizes the session directly
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
name | The name under which the value is stored. | String |
value | The value of this component. | String |
<s:script>
Adds (java)script to the browser
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
language | script language | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
src | URL for script file. | String |
type | type of script source | String |
<s:selectBooleanCheckboxAjax>
Extends standard selectBooleanCheckbox by user role support.
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 | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | 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 |
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 |
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | String |
label | A display name for this component. | String |
lang | HTML: The base language of this document. | String |
offImage | Image to show instead of checkox when boolean value is false | String |
onFailure | Javascript method to call on failed ajax update | String |
onImage | Image to show instead of checkox when boolean value is true | 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 |
required | A boolean value that indicates whether an input value is required. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | 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 which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | 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:selectManyCheckboxAjax>
Extends standard selectManyCheckbox allowing for dynamic ajax submitting. Current limitations - Bound value must be a Collection of Strings!
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 |
border | HTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01. | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | String |
label | A display name for this component. | String |
lang | HTML: The base language of this document. | String |
layout | Controls the layout direction of the child elements. Values include: lineDirection (vertical) and pageDirection (horzontal). | String |
layoutWidth | A integer representing the number of checkbox rows if the layout is lineDirection and checkbox columns if the layout is pageDirection. | 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 |
required | A boolean value that indicates whether an input value is required. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | 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 which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | 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:selectOneRadioAjax>
Extends standard selectOneRadio allowing for dynamic ajax submitting.
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 |
border | Width in pixels of the border to be drawn around the table containing the options list. | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | 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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | String |
label | A display name for this component. | String |
lang | HTML: The base language of this document. | String |
layout | Orientation of the options list. Valid values are "pageDirection" for a vertical layout, or "lineDirection" for horizontal. The default value is "lineDirection". | 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 |
required | A boolean value that indicates whether an input value is required. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | 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 which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | 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:sortableColumn>
Can contain:JSP
Attributes
Name | Description | Type |
---|---|---|
align | {asc, desc} see http://dojotoolkit.org 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 |
dataType | default=String {Number,Date,html,String} see http://dojotoolkit.org org filterTable | String |
escape | default=true escape text | String |
field | see http://dojotoolkit.org org filterTable | String |
format | {asc, desc} see http://dojotoolkit.org org filterTable | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
sort | {asc, desc} see http://dojotoolkit.org org filterTable | String |
text | column header text | String |
valign | {asc, desc} see http://dojotoolkit.org org filterTable | String |
<s: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
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 |
confirmationMessage | Confirmation message to show if something in the form has changed | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | String |
disabled | If disabled, the confirmation window will not be shown | String |
excludedIds | Comma-separated list of cliend id of the commands which will be excluded from the confirmation message | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
immediate | A boolean value that identifies the phase during which action events should fire. <p> 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. </p> | 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. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | String |
validator | A method-binding EL expression which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | String |
<s: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
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 |
callback | User defined javascript callback function. This function will be called to decide if the event should trigger the submit. (Default: fire on "Enter") | String |
event | The event: keypress|keydown|keyup|change|focus|blur|click|mousedown|mouseup|mousemove|mouseover|mouseout|select (Default: keypress) | String |
for | The component (commandLink or commandButton) to "click" on | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
<s:tableSuggestAjax>
Provides an input textbox with "suggest" functionality, using an ajax request to the server. The popUp contains a table where each column value can be set to a specific dom node (through dom node id).
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 | Non HTML standard attribute to disable browser's autocomplete function. | String |
betweenKeyUp | If the time between two keyup events is lower than this given value, the ajax request will not be fired. In milliseconds. Prevents stressing the server with too much user inputs. In driven tests the component seems to be more stable if this value is set. A recommended value in which case the component works very well is about 300ms. | 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 |
comboBoxStyleClass | StyleClass for dropdown box and arrow. | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
converterMessage | Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails. <p> </p> | 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 |
evenRowStyleClass | StyleClass which only applies to even rows in the suggested table. | 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 |
hoverRowStyleClass | StyleClass for the rows for onmouseover events. | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | 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 action events should fire. <p> 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. </p> | 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 |
label | A display name for this component. | 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 |
oddRowStyleClass | StyleClass which only applies to odd rows in the suggested table. | 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 |
popupId | Id for the pop up window | String |
popupStyleClass | StyleClass for the window with a suggested list of items; pop up for each incoming Ajax response | 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. <p> If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. </p> <p> Default value: false. </p> | String |
requiredMessage | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). | String |
rowStyleClass | StyleClass which applies to every row in the suggested table. | String |
size | HTML: The initial width of this control, in characters. | String |
startRequest | The AJAX Request is only triggered if the number of chars typed in is equal or greater than this given value. | String |
style | HTML: CSS styling instructions. | String |
styleClass | The CSS class for this element. Corresponds to the HTML 'class' attribute. | String |
styleLocation | 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 |
suggestedItemsMethod | Reference to the method which returns the suggested items | String |
tabindex | HTML: Specifies the position of this element within the tab order of the document. | String |
tableStyleClass | StyleClass for the suggested table. | 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 which is invoked during the validation phase for this component. <p> The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. </p> <p> The method is expected to have the prototype </p> <code>public void aMethod(FacesContext, UIComponent,Object)</code> | String |
validatorMessage | Text which will be shown if validation fails. | String |
value | Gets The initial value of this component. | String |
valueChangeListener | A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns. <p> The phase in which this method is invoked can be controlled via the immediate attribute. </p> | String |
var | Same principle as it can be found in dataTable. SuggestedItemsMethod returns a list of objects, where the class variables can be accessed with the alias after the dot of the var. | 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:timedNotifier>
Displays a timed notifier tag
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 |
confirmationMessage | confirmation message to be displayed | String |
converter | An expression that specifies the Converter for this component. <p> 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. </p> | String |
disabled | HTML: When true, this element cannot receive focus. | String |
hideDelay | Delay to being visible | String |
id | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
showDelay | Delay from show to hide | String |
value | Gets The initial value of this component. | String |
<s:validateCompareTo>
Validates this component against another component. <p> Specify the foreign component with the for={foreign-component-id} attribute. </p> <p> Valid operator attribute values: </p> <ul> <li>equals: eq, ==, =,</li> <li>not equals: ne, !=,</li> <li>greater than: gt, >,</li> <li>less than: lt, <,</li> <li>greater than or equals: ge, >=,</li> <li>less than or equals: le, <=</li> </ul> <p> If the comparator attribute is specified, the component values are compared using the specified java.util.Comparator object. If no comparator is specified, the component values must implement Comparable and are compared using compareTo(). If either value or foreign value does not implement Comparable and no Comparator is specified, validation always succeeds. </p> <p> Put this validator on the bottom-most component to insure that the foreign component's value has been converted and validated first. </p> <p> However, this validator will attempt to convert and validate the foreign component's value if this has not already occurred. This process may not be identical to the standard JSF conversion and validation process. </p><p> The validation error message key is currently hardcoded as </p> <p> "{0} value <{1}> must be {2} {3} value <{4}>" </p> where <ul> <li>{0} is the parent component id,</li> <li>{1} is the parent component value,</li> <li>{2} is the operator name,</li> <li>{3} is the foreign component id, and</li> <li>{4} is the foreign component value.</li> </ul> <p> The alternateOperatorName attribute can specify a custom operator name. For example, use "after" instead of "greater than" when comparing dates. </p><p> The message attribute can specify an alternate validation error message key. For example, use "{0} must be {2} {3}" to remove values from the message. </p> <p> Known issues: </p> <ul> <li> Operator names should be localized.</li> <li> The default message key should be localized.</li> <li> Perhaps an exception should be thrown if the two values are not Comparable and no Comparator is specified.</li> </ul>
Can contain:empty
Attributes
Name | Description | Type |
---|---|---|
alternateOperatorName | custom operator name in error message (ie "after" instead of "greater than" for dates) | String |
comparator | Value binding for an alternate java.util.Comparator object if component values don't implement Comparable | String |
detailMessage | * | String |
for | The JSF id of the component with which to compare values. | String |
message | * | String |
operator | Operator for comparison: equals: eq, ==, =, not equals: ne, !=, greater than: gt, >, less than: lt, <, greater than or equals: ge, >=, less than or equals: le, <= | String |
summaryMessage | * | String |
<s:validateUrl>
A custom validator for url format, based upons Jakarta Commons.
Can contain:empty
Attributes
Name | Description | Type |
---|---|---|
allow2Slashes | Allow two slashes in the path component of the URL. | String |
allowAllSchemas | Allows all validly formatted schemes to pass validation instead of supplying a set of valid schemes. | String |
detailMessage | * | String |
message | * | String |
schemes | CSV values that indicates the set of schemes to check this url. If allowAllSchemas = true, the values of this field are ignored. If no schemes are provided, default to this set ("http", "https", "ftp"). | String |
summaryMessage | * | String |
<s:validationScript>
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 | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. | String |
rendered | A boolean value that indicates whether this component should be rendered. Default value: true. | String |
<s:valueChangeNotifier>
<p>ValueChangeNotifier</p> Like valueChangeListener, but will send valueChange events after the UPDATE_MODEL phase. <br /> This simply means you CAN update your model values within such an event now. <br /> <ul> <li>It wont be overwritten by the model update</li> <li>And wont trigger another valueChange if you update a value with an valueChangeListener attached</li> </ul>
Can contain:JSP