Foundation

Tag reference sheet

Tag library reference for the following tag libraries:

Tomahawk sandbox tag library. - version 1.0

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
  • conversation puts a bean into the conversation context add a bean under context control
  • convertBoolean Converter that translates between boolean values (true/false) and alternate versions of those boolean values like (yes/no), (1/0), and (way/no way)
  • convertDateTime Simple convert that overrides the spec DateTimeConverter and uses TimeZone
  • convertNumber Converter which uses either the manually set destType or the value binding to determine the correct destination type to convert the number to This tag creates a number formatting converter and associates it with the nearest parent UIComponent
  • convertStringUtils Converts the format of a string 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
  • endConversation end a conversation
  • ensureConversation Ensures a named conversation is running check if a conversation is active
  • exporterActionListener Export datatable contents to an excel file or a pdf file
  • 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
  • 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
  • separateConversationContext Separates the current context from the children
  • sortableColumn
  • startConversation start a conversation
  • stateChangedNotifier A component that listens to changes in the components Shows a confirmation window if some of the input fields of the form have changed its value
  • 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
borderColorDefines the color of the border.String
collapsedBackColorDefines the background color for collapsed state.String
collapsedFontWeightDefines the font weight for collapsed state.String
collapsedTextColorDefines the text color for collapsed state.String
colspanstandard html colspan attribute for table cellString
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledOnUserRoleIf 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
expandedBackColorDefines the background color for expanded state.String
expandedFontWeightDefines the font weight for expanded state.String
expandedTextColorDefines the text color for expanded state.String
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
hoverBackColorDefines the background color on hover.String
hoverTextColorDefines the text color on hover.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
langHTML: The base language of this document.String
layoutDefines 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
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
visibleOnUserRoleIf 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

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
ajaxSelectItemsMethodMethod to call via ajax to reload the combo boxString
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
datafldReserved for future use.String
dataformatasReserved for future use.String
datasrcReserved for future use.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
disabledClassThe CSS class assigned to the label element for enabled choices.String
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledClassThe CSS class assigned to the label element for enabled choices.String
enabledOnUserRoleIf 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
escapeIndicates whether rendered markup should be escaped. Default: trueString
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
langHTML: The base language of this document.String
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
parentComboBoxid 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
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String
visibleOnUserRoleIf 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

NameDescriptionType
alignHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.String
bgcolorHTML: The background color of this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
bodyStyleCorresponds to the HTML style attribute for the table body tagString
bodyStyleClassCorresponds to the HTML class attribute for the table body tag.String
borderHTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.String
cellpaddingHTML: Specifies the amount of empty space between the cell border and its contents. It can be either a pixel length or a percentage.String
cellspacingHTML: 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
columnClassesA comma separated list of CSS class names to apply to td elements in each column.String
datafldReserved for future use.String
dataformatasReserved for future use.String
datasrcReserved for future use.String
derivedRowKeyPrefixThis 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
detailStampExpandedDefaulttrue|false - true if the detailStamp should be expanded by default. default: falseString
detailStampLocationbefore|after - where to render the detailStamp, before the actual row or after it. default: afterString
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
embeddedAvoids 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
enabledOnUserRoleIf 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
firstThe index of the first row to be displayed, where 0 is the first row.String
footerClassThe CSS class to be applied to footer cells.String
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
forceIdIndexFormulaA 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
frameHTML: 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
frequencyDefines in seconds the interval of reloads. if no value is specified 2 seconds will be default.String
headerClassThe CSS class to be applied to header cells.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
langHTML: The base language of this document.String
newspaperColumnsThe number of columns to wrap the table over. Default: 1 Set the number of columns the table will be divided over.String
newspaperOrientationThe orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical". Default: verticalString
onSuccessDefine javascript function to call after successful refresh.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
preserveDataModelIndicates 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: falseString
preserveRowStatesIndicates 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: falseString
preserveSortIndicates 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: trueString
previousRowDataVarA 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
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
renderedIfEmptyIndicates 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: trueString
rowClassesA comma separated list of CSS class names to apply to td elements in each row.String
rowCountVarA parameter name, under which the rowCount is set in request scope similar to the var parameter.String
rowGroupStyleCorresponds to the HTML style attribute for grouped rows.String
rowGroupStyleClassStyleClass for grouped rows.String
rowIdThe id to use forString
rowIndexVarA parameter name, under which the current rowIndex is set in request scope similar to the var parameter.String
rowKeyUsed 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
rowOnClickDefines a JavaScript onclick event handler for each table rowString
rowOnDblClickDefines a JavaScript ondblclick event handler for each table rowString
rowOnKeyDownDefines a JavaScript onkeydown event handler for each table rowString
rowOnKeyPressDefines a JavaScript onkeypress event handler for each table rowString
rowOnKeyUpDefines a JavaScript onkeyup event handler for each table rowString
rowOnMouseDownDefines a JavaScript onmpusedown event handler for each table rowString
rowOnMouseMoveDefines a JavaScript onmousemove event handler for each table rowString
rowOnMouseOutDefines a JavaScript onmouseout event handler for each table rowString
rowOnMouseOverDefines a JavaScript onmouseover event handler for each table rowString
rowOnMouseUpDefines a JavaScript onmouseup event handler for each table rowString
rowStyleCorresponds to the HTML style attribute for the row tr tag.String
rowStyleClassCorresponds to the HTML class attribute for the row tr tag.String
rowsThe number of rows to be displayed. Specify zero for all remaining rows in the table.String
rulesHTML: Controls how rules are rendered between cells. Values include: none, groups, rows, cols, and all.String
sortAscendingValue 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
sortColumnValue 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
sortableDefine if the table is sortable or notString
sortedColumnVarA 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
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
summaryHTML: Provides a summary of the contents of the table, for accessibility purposes.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
valueAn EL expression that specifies the data model that backs this table. The value can be of any type. A value of type DataModel is used directly. Array-like parameters of type java.util.List, array of Object, java.sql.ResultSet, or javax.servlet.jsp.jstl.sql.Result are wrapped in a DataModel. Other values are wrapped in a DataModel as a single row.String
valueTypeIndicate 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. This value must be a static value.String
varDetailTogglerThis 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
visibleOnUserRoleIf 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
widthHTML: 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

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
actionSpecifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal.String
actionForComma 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
actionListenerA method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
enabledOnUserRoleIf 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
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
imageHTML: The URL of an image that renders in place of the button.String
immediateA boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
langHTML: The base language of this document.String
onFailureJavascript method to call on failed ajax updateString
onStartJavascript method to call on start of ajax updateString
onSuccessJavascript method to call on successful ajax updateString
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
typeHTML: A hint to the user agent about the content type of the linked resource.String
valueThe initial value of this component.String
visibleOnUserRoleIf user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.String

<s:conversation>

puts a bean into the conversation context add a bean under context control

Can contain:JSP

Attributes

NameDescriptionType
actionSpecifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal.String
actionListenerA method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
namethe name of the conversation. Notice: required if tag not as child of startConversation tag.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
valueThe initial value of this component.String

<s:convertBoolean>

Converter that translates between boolean values (true/false) and alternate versions of those boolean values like (yes/no), (1/0), and (way/no way). <p/> To customize the representation of a boolean true and false, use {@link #setTrueValue(String)} and {@link #setFalseValue(String)} respectively. If not configured with these setter methods, it defaults to <code>true</code> and <code>false</code>. <p/> The values are case sensitive. <p/>

Can contain:empty

Attributes

NameDescriptionType
falseValueValue representing a boolean false, e.g. FALSE, no, 0, etc.String
trueValueValue representing a boolean true, e.g. TRUE, yes, 1, etc.String

<s:convertDateTime>

Simple convert that overrides the spec DateTimeConverter and uses TimeZone.getDefault() as the base timezone, rather than GMT. Convert date time using normal system timezone like it should

Can contain:empty

Attributes

NameDescriptionType
dateStylelongDesc = "default|short|medium|long|full"String
localelongDesc = "locale"String
patternCustom formatting patternString
timeStyledefault|short|medium|long|fullString
timeZonetimeZomeString
typedate|time|bothString

<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

NameDescriptionType
currencyCodeISO 4217 currency codeString
currencySymbolThe currency symbol used to format a currency value. Defaults to the currency symbol for locale.String
destTypeThe java class name the value should be converted to. Default: automatically determined through valueBindingString
groupingUsedSpecifies whether output will contain grouping separators. Default: true.String
integerOnlySpecifies whether only the integer part of the input will be parsed. Default: false.String
localeThe name of the locale to be used, instead of the default as specified in the faces configuration file.String
maxFractionDigitsThe maximum number of digits in the fractional portion of the number.String
maxIntegerDigitsThe maximum number of digits in the integer portion of the number.String
minFractionDigitsThe minimum number of digits in the fractional portion of the number.String
minIntegerDigitsThe minimum number of digits in the integer portion of the number.String
patternA custom Date formatting pattern, in the format used by java.text.SimpleDateFormat.String
typeThe 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

NameDescriptionType
appendEllipsesDuringInputBoolean value determining if data should be truncated with ellipses during input conversion. Default = falseString
appendEllipsesDuringOutputBoolean value determining if data should be truncated with ellipses during output conversion. Default = falseString
formatSpecifies the output case of the string. One of uppercase | lowercase | capitalizeString
maxLengthInteger 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
trimBoolean value determining is the string should be trimmed before any other formatting takes place. Default = falseString

<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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
duration*String
enabledOnUserRoleIf 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
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
langHTML: The base language of this document.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
puff*String
pulsate*String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
scale*String
scaleSize*String
squish*String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
visibleOnUserRoleIf user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.String

<s:endConversation>

end a conversation

Can contain:JSP

Attributes

NameDescriptionType
actionSpecifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal.String
actionListenerA method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
errorOutcomeon exception use the given outcome for further navigationString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
namethe name of the conversation. Notice: required if tag not as child of startConversation tag.String
onOutcomeend the conversation only if the action outcome matches the given onOutcome. This can be a comma separated list.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
restarttrue|false|valueBinding - true if the conversation should be restarted immediatelyString
restartActionthe action which should be called in case of a restartString
valueThe initial value of this component.String

<s:ensureConversation>

<p> Ensures a named conversation is running </p> <p> check if a conversation is active. </p> <p> The way this is done here is sub-optimal, once we are on jsf 1.2 it should be possible to check this before ANY rendering - and maybe to invoke a navigation then </p>

Can contain:JSP

Attributes

NameDescriptionType
actionthe action which should be called in case of a not running conversationString
actionListenerA method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
namethe name of the conversation. Notice: required if tag not as child of startConversation tag.String
preCheckDelegate the check to the action method at all. The user has to check if a conversation is running. A action method is mandatory.String
redirectToredirect to the given view if the conversation is not runningString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
valueThe initial value of this component.String

<s:exporterActionListener>

Export datatable contents to an excel file or a pdf file.

Can contain:JSP

Attributes

NameDescriptionType
fileType*String
filename*String
for*String

<s:filterTable>

Can contain:JSP

Attributes

NameDescriptionType
alternateRowsdefault=true see http://dojotoolkit.org filterTableString
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
borderdefault=0String
cellpaddingdefault=0String
cellspacingdefault=0String
firstThe index of the first row to be displayed, where 0 is the first row.String
headClassdefault=fixedHeader see http://dojotoolkit.org filterTableString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
maxSortabledefault=1 see http://dojotoolkit.org filterTableString
multipledefault=true see http://dojotoolkit.org filterTableString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
rowsThe number of rows to be displayed. Specify zero for all remaining rows in the table.String
styleClassCSS style class attributeString
tbodyClassdefault=scrollContent see http://dojotoolkit.org filterTableString
valueAn EL expression that specifies the data model that backs this table. The value can be of any type. A value of type DataModel is used directly. Array-like parameters of type java.util.List, array of Object, java.sql.ResultSet, or javax.servlet.jsp.jstl.sql.Result are wrapped in a DataModel. Other values are wrapped in a DataModel as a single row.String
var*Defines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value.String

<s:fishEyeCommandLink>

CommandLink component that can be used in nodeStamp facet

Can contain:JSP

Attributes

NameDescriptionType
actionSpecifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal.String
actionListenerA method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.String
bindingIdentifies 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
target*String
valueThe initial value of this 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

NameDescriptionType
attachEdge*String
bindingIdentifies 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
firstThe index of the first row to be displayed, where 0 is the first row.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
itemHeight*String
itemMaxHeight*String
itemMaxWidth*String
itemPadding*String
itemWidth*String
labelEdge*String
orientation*String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
rowsThe number of rows to be displayed. Specify zero for all remaining rows in the table.String
valueAn EL expression that specifies the data model that backs this table. The value can be of any type. A value of type DataModel is used directly. Array-like parameters of type java.util.List, array of Object, java.sql.ResultSet, or javax.servlet.jsp.jstl.sql.Result are wrapped in a DataModel. Other values are wrapped in a DataModel as a single row.String
var*Defines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value.String
visibleWindow*String

<s:floatingPane>

PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
constrainToContainerlimit to parent containerString
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
displayCloseActionif true a close button is displayedString
displayMinimizeActionif true a minimize button is displayedString
hasShadowShadow drawn or notString
iconSrcThe pane icon sourceString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
modalDescription for the attributeString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
resizableWindow resizableString
styleThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
taskBarIdThe taskbar idString
titlethe floating pane TitleString
titleBarDisplayDisplays the title bar of the WindowString
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
widgetIdOptional enforced dojo widgetIdString
widgetVaroptional widget var name, if this is not used only an autogenerated value is setString
windowStateDisplay state of the windowString

<s:focus>

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
forThe JSF id of the component to receive focus.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
rememberClientFocus*String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String

<s:form>

Renders a HTML form element which allow defining a different scheme, servername or port for the action url to which the form is submited

Can contain:JSP

Attributes

NameDescriptionType
acceptHTML: Provides a comma-separated list of content types that the server processing this form can handle.String
acceptcharsetHTML: The list of character encodings accepted by the server for this form.String
actionThis attribute can be used to set an entirely different action (might be something JSF-unspecific) to the form.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
enctypeHTML: The content type used to submit this form to the server.String
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
langHTML: The base language of this document.String
methodThis attribute can be used to set a method to the form which is different to the regular POST method used.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onresetHTML: Script to be invoked when this form is reset.String
onsubmitHTML: Script to be invoked when this form is submitted.String
portThis attribute can be used to set the port for the action attributeString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
schemeThis attribute can be used to set the url scheme for the action attributeString
serverNameThis attribute can be used to set the url server name or ip address for the action attributeString
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
targetHTML: Names the frame that should display content generated by invoking this action.String
titleHTML: 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA 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

NameDescriptionType
alignHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
borderHTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
enabledOnUserRoleIf 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
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
heightHTML: Overrides the natural height of this image, by specifying height in pixels.String
hspaceHTML: 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
imageRendererClassThe 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
ismapHTML: Specifies server-side image map handling for this image.String
langHTML: The base language of this document.String
longdescHTML: A link to a long description of the image.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
urlAn alias for the "value" attribute.String
usemapHTML: Specifies an image map to use with this image.String
valueA value binding which will be called to get the instance of an org.apache.myfaces.custom.graphicimagedynamic.ImageRenderer.String
visibleOnUserRoleIf 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
vspaceHTML: The amount of white space to be inserted above and below this element, in undefined units. Deprecated in HTML 4.01.String
widthHTML: 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

NameDescriptionType
bindingIdentifies 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
delayThe delay between transitionsString
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
heightHeightString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
maxDelayThe maximum delay allowed when increasing delay timeString
minDelayThe minimum delay allowed when decreasing delay timeString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
transitionTimeTransition time in milliseconds. Set to -1 for immediate image switch.String
widthWidthString

<s:imageLoopItem>

Image loop item.

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
urlAn alias for the "value" attribute.String
valueThe URL of the image. If the URL starts with a '/', it is relative to the context path of the web application.String

<s:imageLoopItems>

Image loop items.

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
valueAn 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

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
forceIdGets If true, this component will force the use of the specified id when rendering.String
forceIdIndexGets 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
imageLocationGets 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
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
javascriptLocationGets 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
langHTML: The base language of this document.String
maxlengthHTML: The maximum number of characters allowed to be entered.String
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
sizeHTML: The initial width of this control, in characters.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
styleLocationGets 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
tabindexHTML: Specifies the position of this element within the tab order of the document.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String

<s:inputSuggestAjax>

Provides an input textbox with "suggest" functionality, using an ajax request to the server. <p> A tag that defines an autosuggest control complete with Ajax binding.<br/> This allows you to do real time autocompletion via asynchronous server requests. Note, this control is experimental and it is currently located in the MyFaces sandbox and can be subject to alteration in the immediate future. So use it with care. </p>

Can contain:JSP

Attributes

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
alignHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
autoCompleteIf false, the input field is not automatically populated with the first suggested value. Default: trueString
autocompleteNon HTML standard attribute to disable browser's autocomplete function.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
charsetForce the charset of the ResponseString
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
datafldReserved for future use.String
dataformatasReserved for future use.String
datasrcReserved for future use.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
disabledOnClientSideIf 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
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledOnUserRoleIf 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
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
imageLocationAn alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter.String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
itemLabelMethodMethod 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
javascriptLocationAn alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter.String
langHTML: The base language of this document.String
maxSuggestedItemsoptional attribute to identify the max size of suggested Values. If specified in tableSuggestAjax, paginator functionality is used.String
maxlengthHTML: The maximum number of characters allowed to be entered.String
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
sizeHTML: The initial width of this control, in characters.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
styleLocationAn alternate location to find stylesheet resources. If no values is specified, stylesheets will be loaded from the resources directory using AddResource and ExtensionsFilter.String
suggestedItemsMethodReference to the method which returns the suggested itemsString
tabindexHTML: Specifies the position of this element within the tab order of the document.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String
visibleOnUserRoleIf 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

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
alignHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
autocompleteNon HTML standard attribute to disable browser's autocomplete function.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
cancelTextText for cancelString
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
datafldReserved for future use.String
dataformatasReserved for future use.String
datasrcReserved for future use.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
disabledOnClientSideIf 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
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledOnUserRoleIf 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
errorStyleStyle for the input field where the error occures. Useful if there is only one messages area for a few inputTextAjax fieldsString
errorStyleClassStyleClass for the input field where the error occures. Useful if there is only one messages area for a few inputTextAjax fieldsString
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
langHTML: The base language of this document.String
maxlengthHTML: The maximum number of characters allowed to be entered.String
okTextTest for buttonString
onFailureJavascript method to call on failed ajax updateString
onStartJavascript method to call on start of ajax updateString
onSuccessJavascript method to call on successful ajax updateString
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
showCancelButtonWhether to show cancel buttonString
showOkButtonWhether to show an ok button before sending update.String
sizeHTML: The initial width of this control, in characters.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String
visibleOnUserRoleIf 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

NameDescriptionType
adjustPathsPath adjustment as defined by dojoString
bindingIdentifies 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
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
executeScriptsIf true scripts will be evaled after renderingString
extractContentDefined by dojo, see the examplesString
handlerJavascript function which should generate the contentString
hrefRemote href for iframe simulationString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
layoutAlignLayoutalignment usable in conjunction with a layout containerString
parseContentDefined by dojo see the examplesString
preloadContent PreloadingString
refreshOnShowDescription for the attributeString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
scriptScopeScopecontainer for downloaded ScriptsString
sizeShareSize share value describing the place the content pane wants from its parentString
styleThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
widgetIdOptional enforced dojo widgetIdString
widgetVaroptional widget var name, if this is not used only an autogenerated value is setString

<s:layoutingSplitPane>

PanelGroup which supports a partialTriggers Attribute similar to the one in Trinidad

Can contain:JSP

Attributes

NameDescriptionType
activeSizingSize share value describing the place the content pane wants from its parentString
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
lastPointLast point of the split paneString
orientationhorizontal or verticalString
persistIf true, cookie persisting of the split pane is enabledString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
sizeShareSize share value describing the place the content pane wants from its parentString
sizerWidthwidth of the sizer barString
startPointStarting Point of the split pane as defined by dojoString
styleThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
widgetIdOptional enforced dojo widgetIdString
widgetVaroptional widget var name, if this is not used only an autogenerated value is setString

<s:layoutingTitlePane>

Title Pane layouting element. TitlePane Component class

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
containerNodeClassthe css node class for the container part of the elementString
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
labelLabel for the titled paned elementString
labelNodeClassthe css node class for the label part of the paneString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
styleThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
widgetIdOptional enforced dojo widgetIdString
widgetVaroptional widget var name, if this is not used only an autogenerated value is setString

<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

NameDescriptionType
actionNOT IMPLEMENTED - Action to take (ie: update, submit, call (call a javascript function))String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
eventTypeNOT IMPLEMENTED - Type of event (ie: onchange, onclick)String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
onId of another component.String
renderedA 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

NameDescriptionType
basenamePath to the bundle-file in the class-path, e.g.: org.apache.myfaces.i18n.mypropsString
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
varVariable 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
contentTypeDetermines the media content type.String
heightInteger to indicate the media height.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
sourceDetermines the path of the media file.String
widthInteger to indicate the media weight.String

<s:message>

MyFaces extension to the standard messages tag: see summaryDetailSeparator attribute

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
detailFormatIf 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
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
enabledOnUserRoleIf 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
errorClassCSS class to be used for messages with severity "ERROR".String
errorStyleCSS style to be used for messages with severity "ERROR".String
fatalClassCSS class to be used for messages with severity "FATAL".String
fatalStyleCSS style to be used for messages with severity "FATAL".String
for*An EL expression, returning a String, with the unique ID of the component for which messages should be displayed. This string has the same format as that accepted by the UIComponent.findComponent() method.String
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
forceSpanIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
infoClassCSS class to be used for messages with severity "INFO".String
infoStyleCSS style to be used for messages with severity "INFO".String
langHTML: The base language of this document.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
replaceIdWithLabelIf present, all occurrences of the id of the component for which the message is rendered will be replaced by the label. Default: true.String
showDetailAn EL expression, returning a boolean, that controls whether the detail text of the associated messages is displayed. Default: false.String
showSummaryAn EL expression, returning a boolean, that controls whether the summary text of the associated messages is displayed. Default: true.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
summaryFormatIf 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
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
tooltipIf true, the message summary will be rendered as a tooltip (i.e. HTML title attribute).String
visibleOnUserRoleIf 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
warnClassCSS class to be used for messages with severity "WARN".String
warnStyleCSS 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
closeButtonSpecifies 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
contentURLThe 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
dialogAttrA space separated list with attribute='value' pairs, which control the behaviour of the dojo dialog.String
dialogIdAn 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
dialogTitleThe 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
dialogVarSpecifies 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
hiderIdsA 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
styleHTML: CSS styling instructions.String
styleClassThe 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
viewIdThe 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
widgetIdOptional enforced dojo widgetIdString
widgetVarAn alias for the "dialogVar" property.String

<s:outputLinkDynamic>

Extends standard outputLink but links to a dynamically rendered resource (image, file, ...).

Can contain:JSP

Attributes

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
charsetHTML: Specifies the character encoding of the linked resource.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
coordsHTML: The coordinates of regions within a client side image map.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
enabledOnUserRoleIf 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
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
hreflangHTML: The language of the linked resource.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
langHTML: The base language of this document.String
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
relHTML: The relationship between the current document and the linked resource.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
resourceRendererClassThe 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
revHTML: The type(s) describing the reverse link for the linked resource.String
shapeHTML: The shape of a region in a client side image map.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
targetHTML: Names the frame that should display content generated by invoking this action.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
typeHTML: A hint to the user agent about the content type of the linked resource.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
visibleOnUserRoleIf 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
enabledOnUserRoleIf 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
escapeIndicates whether rendered markup should be escaped. Default: trueString
forSpecify the id of the dom element where the label should be put inString
forValueSpecify 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
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
labelTo 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
langHTML: The base language of this document.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
visibleOnUserRoleIf 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

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
alignHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
customSecurityExpressionThis 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
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
langHTML: The base language of this document.String
maxlengthHTML: The maximum number of characters allowed to be entered.String
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
penaltyRatioThis 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
preferredPasswordLengthThe prefered length of the passwordString
prefixTextThe prefix of the component messageString
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
showDetailsThis flag {true | false} determines whether to show the details (left characters). default is trueString
sizeHTML: The initial width of this control, in characters.String
strengthIndicatorTypeThis flag determines the indicator type. It can be {text or bar}. Default is textString
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
textStrengthDescriptionsThe text strength descriptionsString
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
useCustomSecurityThis flag determines whether to user custom security rules instead of just depending on the password length. The default is false.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String

<s: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

NameDescriptionType
afterUpdateJSHookJavascript code executed after a ppr update has been completedString
appendMessagescomma separated List of client Ids that specify the messages components in the page to which messages are appended by this PPRPanelGroupString
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
colspanstandard html colspan attribute for table cellString
componentUpdateFunctionclient javascript function which will do the actual dom update. function signature: function(formNodeElement, updateTargetElement, pprResponseElement)String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledOnUserRoleIf 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
excludeFromStoppingPeriodicalUpdateNormally 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
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
inlineLoadingMessageIf this attribute is set the content of the PPRPanelGroup will be replaced by the provided Loading-Message during partial updateString
langHTML: The base language of this document.String
layoutDetermines 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
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
partialTriggerPatternRegular Expression If the client Id of a submitting Component matches this Pattern the corresponding pprPanelGroup is updated via AJAXString
partialTriggersComma or Space seperated List of ids from ui_command-items which trigger a partial update of this PanelGroupString
periodicalTriggersIf a periodicalUpdate is set this trigger starts the periodical requests. No partialTriggers are needed.String
periodicalUpdateDoes a periodical refresh of the partial page inside the ppr group. In milliseconds. No partialTriggers are needed.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
replaceMessagescomma separated List of client Ids that specify the messages components in the page which messages are replaced by this PPRPanelGroupString
showDebugMessagesIf 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: falseString
stateUpdateIf set to false, there will be no stateUpdate on server side due to the partialPage refresh. Default: trueString
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
visibleOnUserRoleIf 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
waitBeforePeriodicalUpdateThis 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
processComponentIdscomma 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
renderedA 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
typeThe 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
valueThe 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

NameDescriptionType
backgroundColorBackground 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
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
borderColorThe 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
borderWidthThe width of the border in pixels. (Default: 8)String
colorThe foreground color of the DIVString
contentStyleThe CSS style to give to the content DIV or TD (based on layout)String
contentStyleClassThe CSS style class to give to the content DIV or TD (based on layout)String
cornersThis 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, bottomleftString
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
enabledOnUserRoleIf 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
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
inverseFlips the lightening/darkening effect for 3D borders. (Default: false)String
langHTML: The base language of this document.String
layoutEither "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
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
radiusThe radius of the corners in pixels. (Default: 8)String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
sizeIf 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: 640x480String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
visibleOnUserRoleIf 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:empty

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
nameA String containing the name of the parameter.String
value*The value of this parameter.String

<s:script>

Adds (java)script to the browser

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
languagescript languageString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
srcURL for script file.String
typetype of script sourceString

<s:selectBooleanCheckboxAjax>

Extends standard selectBooleanCheckbox by user role support.

Can contain:JSP

Attributes

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
datafldReserved for future use.String
dataformatasReserved for future use.String
datasrcReserved for future use.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledOnUserRoleIf 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
escapeIndicates whether rendered markup should be escaped. Default: trueString
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
langHTML: The base language of this document.String
offImageImage to show instead of checkox when boolean value is falseString
onFailureJavascript method to call on failed ajax updateString
onImageImage to show instead of checkox when boolean value is trueString
onStartJavascript method to call on start of ajax updateString
onSuccessJavascript method to call on successful ajax updateString
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String
visibleOnUserRoleIf 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

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
borderHTML: Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
datafldReserved for future use.String
dataformatasReserved for future use.String
datasrcReserved for future use.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
disabledClassThe CSS class assigned to the label element for enabled choices.String
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledClassThe CSS class assigned to the label element for enabled choices.String
enabledOnUserRoleIf 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
escapeIndicates whether rendered markup should be escaped. Default: trueString
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
langHTML: The base language of this document.String
layoutControls the layout direction of the child elements. Values include: lineDirection (vertical) and pageDirection (horzontal).String
layoutWidthA integer representing the number of checkbox rows if the layout is lineDirection and checkbox columns if the layout is pageDirection.String
onFailureJavascript method to call on failed ajax updateString
onStartJavascript method to call on start of ajax updateString
onSuccessJavascript method to call on successful ajax updateString
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String
visibleOnUserRoleIf 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

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
borderWidth in pixels of the border to be drawn around the table containing the options list.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
datafldReserved for future use.String
dataformatasReserved for future use.String
datasrcReserved for future use.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
disabledClassThe CSS class assigned to the label element for enabled choices.String
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledClassThe CSS class assigned to the label element for enabled choices.String
enabledOnUserRoleIf 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
escapeIndicates whether rendered markup should be escaped. Default: trueString
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
langHTML: The base language of this document.String
layoutOrientation of the options list. Valid values are "pageDirection" for a vertical layout, or "lineDirection" for horizontal. The default value is "lineDirection".String
onFailureJavascript method to call on failed ajax updateString
onStartJavascript method to call on start of ajax updateString
onSuccessJavascript method to call on successful ajax updateString
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
tabindexHTML: Specifies the position of this element within the tab order of the document.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String
visibleOnUserRoleIf 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:separateConversationContext>

Separates the current context from the children. e.g. commandLinks will start a new conversation context separate the current context from the to be rendered children. E.g. when you render commandLinks they will start a new conversationContext

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String

<s:sortableColumn>

Can contain:JSP

Attributes

NameDescriptionType
align{asc, desc} see http://dojotoolkit.org org filterTableString
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
dataTypedefault=String {Number,Date,html,String} see http://dojotoolkit.org org filterTableString
escapedefault=true escape textString
fieldsee http://dojotoolkit.org org filterTableString
format{asc, desc} see http://dojotoolkit.org org filterTableString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
sort{asc, desc} see http://dojotoolkit.org org filterTableString
textcolumn header textString
valign{asc, desc} see http://dojotoolkit.org org filterTableString

<s:startConversation>

start a conversation

Can contain:JSP

Attributes

NameDescriptionType
actionSpecifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal.String
actionListenerA method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.String
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which action events should fire. During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
namethe name of the conversation. Notice: required if tag not as child of startConversation tag.String
persistencetrue|false - if this conversation requires a persistence manager. Default: falseString
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
valueThe initial value of this component.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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
confirmationMessageConfirmation message to show if something in the form has changedString
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
disabledIf disabled, the confirmation window will not be shownString
excludedIdsComma-separated list of cliend id of the commands which will be excluded from the confirmation messageString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String

<s: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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
callbackUser defined javascript callback function. This function will be called to decide if the event should trigger the submit. (Default: fire on "Enter")String
eventThe event: keypress|keydown|keyup|change|focus|blur|click|mousedown|mouseup|mousemove|mouseover|mouseout|select (Default: keypress)String
forThe component (commandLink or commandButton) to "click" onString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA 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

NameDescriptionType
accesskeyHTML: Sets the access key for this element.String
alignHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.String
altHTML: Specifies alternative text that can be used by a browser that can't show this element.String
autocompleteNon HTML standard attribute to disable browser's autocomplete function.String
betweenKeyUpIf 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
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
charsetForce the charset of the ResponseString
comboBoxStyleClassStyleClass for dropdown box and arrow.String
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
datafldReserved for future use.String
dataformatasReserved for future use.String
datasrcReserved for future use.String
dirHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).String
disabledHTML: When true, this element cannot receive focus.String
disabledOnClientSideIf 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
displayValueOnlyIf true, renders only the value of the component, but no input widget. Default is false.String
displayValueOnlyStyleStyle used when displayValueOnly is true.String
displayValueOnlyStyleClassStyle class used when displayValueOnly is true.String
enabledOnUserRoleIf 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
evenRowStyleClassStyleClass which only applies to even rows in the suggested table.String
forceIdIf true, this component will force the use of the specified id when rendering.String
forceIdIndexIf 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
hoverRowStyleClassStyleClass for the rows for onmouseover events.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
imageLocationAn alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter.String
immediateA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.String
javascriptLocationAn alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter.String
langHTML: The base language of this document.String
maxSuggestedItemsoptional attribute to identify the max size of suggested Values. If specified in tableSuggestAjax, paginator functionality is used.String
maxlengthHTML: The maximum number of characters allowed to be entered.String
oddRowStyleClassStyleClass which only applies to odd rows in the suggested table.String
onblurHTML: Specifies a script to be invoked when the element loses focus.String
onchangeHTML: Specifies a script to be invoked when the element is modified.String
onclickHTML: Script to be invoked when the element is clicked.String
ondblclickHTML: Script to be invoked when the element is double-clicked.String
onfocusHTML: Specifies a script to be invoked when the element receives focus.String
onkeydownHTML: Script to be invoked when a key is pressed down over this element.String
onkeypressHTML: Script to be invoked when a key is pressed over this element.String
onkeyupHTML: Script to be invoked when a key is released over this element.String
onmousedownHTML: Script to be invoked when the pointing device is pressed over this element.String
onmousemoveHTML: Script to be invoked when the pointing device is moved while it is in this element.String
onmouseoutHTML: Script to be invoked when the pointing device is moves out of this element.String
onmouseoverHTML: Script to be invoked when the pointing device is moved into this element.String
onmouseupHTML: Script to be invoked when the pointing device is released over this element.String
onselectHTML: Specifies a script to be invoked when the element is selected.String
popupIdId for the pop up windowString
popupStyleClassStyleClass for the window with a suggested list of items; pop up for each incoming Ajax responseString
readonlyHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
requiredA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.String
rowStyleClassStyleClass which applies to every row in the suggested table.String
sizeHTML: The initial width of this control, in characters.String
startRequestThe AJAX Request is only triggered if the number of chars typed in is equal or greater than this given value.String
styleHTML: CSS styling instructions.String
styleClassThe CSS class for this element. Corresponds to the HTML 'class' attribute.String
styleLocationAn alternate location to find stylesheet resources. If no values is specified, stylesheets will be loaded from the resources directory using AddResource and ExtensionsFilter.String
suggestedItemsMethodReference to the method which returns the suggested itemsString
tabindexHTML: Specifies the position of this element within the tab order of the document.String
tableStyleClassStyleClass for the suggested table.String
titleHTML: An advisory title for this element. Often used by the user agent as a tooltip.String
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString
valueChangeListenerA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.String
varSame 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
visibleOnUserRoleIf 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

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
confirmationMessageconfirmation message to be displayedString
converterThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.String
disabledHTML: When true, this element cannot receive focus.String
hideDelayDelay to being visibleString
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA boolean value that indicates whether this component should be rendered. Default value: true.String
showDelayDelay from show to hideString
valueThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processedString

<s:validateCSV>

Validation by validating comma separated values individually.

Can contain:empty

Attributes

NameDescriptionType
detailMessagealternate validation error detail message format string (use 'message' and 'detailMessage' alternatively)String
messagealternate validation error detail message format string (use 'message' and 'detailMessage' alternatively)String
separator*String
subvalidatorId*String
summaryMessagealternate validation error summary message format stringString

<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, &gt;,</li> <li>less than: lt, &lt;,</li> <li>greater than or equals: ge, &gt;=,</li> <li>less than or equals: le, &lt;=</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 &lt;{1}&gt; must be {2} {3} value &lt;{4}&gt;" </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

NameDescriptionType
alternateOperatorNamecustom operator name in error message (ie "after" instead of "greater than" for dates)String
comparatorValue binding for an alternate java.util.Comparator object if component values don't implement ComparableString
detailMessagealternate validation error detail message format string (use 'message' and 'detailMessage' alternatively)String
forThe JSF id of the component with which to compare values.String
messagealternate validation error detail message format string (use 'message' and 'detailMessage' alternatively)String
operatorOperator for comparison: equals: eq, ==, =, not equals: ne, !=, greater than: gt, &gt;, less than: lt, &lt;, greater than or equals: ge, &gt;=, less than or equals: le, &lt;=String
summaryMessagealternate validation error summary message format stringString

<s:validateISBN>

A custom validator for isbn codes, based upons Jakarta Commons.

Can contain:empty

Attributes

NameDescriptionType
detailMessagealternate validation error detail message format string (use 'message' and 'detailMessage' alternatively)String
messagealternate validation error detail message format string (use 'message' and 'detailMessage' alternatively)String
summaryMessagealternate validation error summary message format stringString

<s:validateUrl>

A custom validator for url format, based upons Jakarta Commons.

Can contain:empty

Attributes

NameDescriptionType
allow2SlashesAllow two slashes in the path component of the URL.String
allowAllSchemasAllows all validly formatted schemes to pass validation instead of supplying a set of valid schemes.String
detailMessagealternate validation error detail message format string (use 'message' and 'detailMessage' alternatively)String
messagealternate validation error detail message format string (use 'message' and 'detailMessage' alternatively)String
schemesCSV 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
summaryMessagealternate validation error summary message format stringString

<s:validationScript>

Can contain:JSP

Attributes

NameDescriptionType
bindingIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.String
idAn identifier for this particular component instance within a component view. <p> The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view </p> <p> This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. </p>String
renderedA 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

Attributes

NameDescriptionType
method**String