Tag reference sheet

Tag library reference for the following tag libraries:

Tobago Components 1.5.x

Tobago Framework Component Tag Library 1.5.x - (C) Copyright 2005-2012 The Apache Software Foundation

This is version 1.2.

  • attribute Add an attribute on the UIComponent associated with the closest parent UIComponent custom action
  • box Renders a panel with border and title
  • button Renders a button element
  • calendar Renders a calendar
  • column Renders a UIComponent that represents a single column of data within a parent UISheet component
  • columnEvent This component creates an event in a UISheet for each row
  • columnNode Creates a tree node inside of a sheet (also known as tree table)
  • columnSelector Renders a column with checkboxes to mark selected rows
  • command Use this tag only as a facet for click, change in selectOneRadio, selectBooleanCheckbox, selectManyCheckbox and selectOneChoiceUIComponentClass: org
  • converter Register an Converter instance on the UIComponent associated with the closest parent UIComponent
  • date Renders a date input field
  • datePicker Renders a date picker
  • file Renders a file input field
  • flowLayout XXX Warning: Still in progress! Please do not use it until other announcement
  • form UIComponentClass: org
  • gridLayout Renders a GridLayout
  • gridLayoutConstraint Add GridLayoutConstraints to the parent UIComponent
  • hidden Renders a hidden input element
  • image Renders an image
  • in Renders a text input field
  • label Renders a label component
  • link Renders a link element
  • loadBundle Load a resource bundle localized for the locale of the current view from the tobago resource path, and expose it (as a Map) in the session attributes (session scope is needed to support ajax requests)
  • mediator Component to put other components from other frameworks into
  • menu Container component to hold submenus and items
  • menuBar Renders a menu bar
  • menuCommand Renders a menu item
  • menuSeparator Renders a separator inside of a menu
  • messages Renders error/validation messages
  • object UIComponentClass: org
  • out Renders a textUIComponentClass: org
  • page Renders a page element
  • panel Intended for use in situations when only one UIComponent child can be nested, such as in the case of facets
  • popup Renders a popup panel
  • popupReference Register an PopupActionListener instance on the UIComponent associated with the closest parent UIComponent
  • progress Renders a progress bar
  • reload Update the parent componentUIComponentClass: org
  • resetInputActionListener TODO document me!
  • script This tag add client side script to the rendered page
  • selectBooleanCheckbox Renders a checkbox
  • selectItem Add a child UISelectItem component to the UIComponent associated with the closed parent UIComponent custom action
  • selectItems Add a child UISelectItems component to the UIComponent associated with the closed parent UIComponent custom action
  • selectManyCheckbox Render a group of checkboxes
  • selectManyListbox Render a multi selection option listbox
  • selectManyShuttle UIComponentClass: org
  • selectOneChoice Render a single selection dropdown list
  • selectOneListbox Render a single selection option listbox
  • selectOneRadio Render a set of radio buttons
  • selectReference Renders a set of option related to and same type as the for component
  • separator Renders a separator
  • sheet Render a sheet element
  • sheetLayout Creates a SheetLayout, which is a internal layout manager of a sheet
  • style Add a style tag
  • tab Renders a tab within a tabgroup
  • tabChangeListener Register an TabChangedListener instance on the UIComponent associated with the closest parent UIComponent custom action
  • tabGroup Renders a tab group which contains tab panels
  • tabGroupLayout Creates a TabGroupLayout, which is a internal layout manager of a tabGroup
  • textarea Renders a multi line text input control
  • time Renders a time input field
  • toolBar Renders a toolbar
  • toolBarCheck Renders a selectable command button within a toolbar
  • toolBarCommand Renders a command button within a toolbar
  • toolBarSelectOne Renders a set of radio command button's within a toolbar
  • toolBarSeparator Renders a separator inside of a tool bar
  • tree A tree with classical look
  • treeCommand Renders a command inside of a tree
  • treeIcon Renders an image beside a tree node
  • treeIndent Renders an indent beside a tree node
  • treeLabel Renders a label inside of a tree
  • treeListbox A tree data structure displayed as a set of list boxes
  • treeMenu A tree which will be displayed like a flat menu
  • treeNode Creates a tree node
  • treeSelect Makes a tree node selectable
  • validateFileItem Register an FileItemValidator instance on the UIComponent associated with the closest parent UIComponent custom action
  • validateSubmittedValueLength Register an SubmittedValueLengthValidator instance on the UIComponent associated with the closest parent UIComponent custom action
  • wizard Renders a flexible wizard
  • cell **** @deprecated
  • menuItem **** @deprecated
  • treeData **** @deprecated

Required attributes are marked with a *

<tc:attribute>

Add an attribute on the UIComponent associated with the closest parent UIComponent custom action.

Can contain: empty

Attributes

NameDescriptionType
modeWarning: The mode is only available when using Facelets. Allowed values are "action", "actionListener", "actionFromValue", "isNotSet", "isSet", "valueIfSet". "action" (method binding) evaluate the expression to find the method binding which is referenced with the template. "actionListener" same as "action" but for the method signature of ActionListeners. "isSet" (boolean) checks, if the expression is set from the composition caller. "isNotSet" (boolean) negation of "isSet" "actionFromValue" Evaluates the ValueBinding to get an outcome set directly (no action method) "valueIfSet" set the attribute only if the value is set.String
name*The name of the attribute in the parent component.String
value*The value of the attribute in the parent component.String

<tc:box>

Renders a panel with border and title.

UIComponentClass: org.apache.myfaces.tobago.component.UIBox

RendererType: Box

Supported facets:

toolBarContains an instance of UIToolBarlayoutContains an instance of AbstractUILayoutBase

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
collapsedFlag indicating whether or not this component is collapsed.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString

<tc:button>

Renders a button element.

UIComponentClass: org.apache.myfaces.tobago.component.UIButton

RendererType: Button

Supported facets:

confirmationContains a UIOutput instance with the confirmation message.popupContains a UIPopup instance.

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
defaultCommandIf true the command is executed as default -- for example if the user presses the enter key inside a related input field.Type: booleanDefault: falseString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
imageUrl to an image to display.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
tipText value to display as tooltip.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:calendar>

Renders a calendar.

UIComponentClass: org.apache.myfaces.tobago.component.UICalendar

RendererType: Calendar

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
valueThe current value of this component.Type: [java.util.Calendar, java.util.Date]String

<tc:column>

Renders a UIComponent that represents a single column of data within a parent UISheet component.

UIComponentClass: org.apache.myfaces.tobago.component.UIColumn

RendererType: Column

Supported facets:

menupopupDeprecated. Please use dropDownMenu facet.dropDownMenuContains a UIMenu instance to render a drop down menu. (not implemented yet, work in progress)

Can contain: JSP

Attributes

NameDescriptionType
alignAlignment of this column.Type: java.lang.StringString
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
resizableFlag indicating whether or not the width of this column in a sheet is resizable, by the user.Type: booleanDefault: trueString
sortableFlag indicating whether or not this column is sortable. To make a column sortable the data of the sheet must be one of java.util.List or Object[].Type: booleanDefault: falseString
tipText value to display as tooltip.Type: java.lang.StringString
widthThe layout token for this column. Allowd layout tokens ('*', '<x>*', '<x>px' or '<x>%'). Where '*' is equvalent to '1*'.Type: java.lang.StringString

<tc:columnEvent>

This component creates an event in a UISheet for each row.

UIComponentClass: org.apache.myfaces.tobago.component.UIColumnEvent

RendererType:

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
eventType: java.lang.StringAllowed Values: [click, dblclick]String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString

<tc:columnNode>

Creates a tree node inside of a sheet (also known as tree table). This component represents a single node inside a tree structure.

UIComponentClass: org.apache.myfaces.tobago.component.UIColumnNode

RendererType: TreeNode

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
resizableFlag indicating whether or not the width of this column in a sheet is resizable, by the user.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString

<tc:columnSelector>

Renders a column with checkboxes to mark selected rows.

UIComponentClass: org.apache.myfaces.tobago.component.UIColumnSelector

RendererType: ColumnSelector

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString

<tc:command>

Use this tag only as a facet for click, change in selectOneRadio, selectBooleanCheckbox, selectManyCheckbox and selectOneChoice

UIComponentClass: org.apache.myfaces.tobago.component.UICommand

RendererType: Command

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
valueThe current value of this component.Type: java.lang.ObjectString

<tc:converter>

Register an Converter instance on the UIComponent associated with the closest parent UIComponent.

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression to a converter.String
converterIdThe converterId of a registered converter.String

<tc:date>

Renders a date input field.

UIComponentClass: org.apache.myfaces.tobago.component.UIDate

RendererType: Date

Supported facets:

changeThis facet can contain a UICommand that is invoked in a case of a change event from the component

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:datePicker>

Renders a date picker. The component needs a DateFormat Pattern from a converter. The converter should be an instance of DateTimeConverter and return a valid pattern from the method getPattern()

UIComponentClass: org.apache.myfaces.tobago.component.UIDatePicker

RendererType: DatePicker

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
forId of the component, this is related to.Type: java.lang.StringString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString

<tc:file>

Renders a file input field. You need to define an org.apache.myfaces.tobago.webapp.TobagoMultipartFormdataFilter in your web.xml or add the tobago-fileupload.jar to your project. The tobago-fileupload.jar contains a FacesContextFactory that wraps the multipart-formdata request inside the facesContext.

For content constraints please use tc:validateFileItem.

UIComponentClass: org.apache.myfaces.tobago.component.UIFile

RendererType: File

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueValue binding expression pointing to a org.apache.commons.fileupload.FileItem property to store the uploaded file.Type: org.apache.commons.fileupload.FileItemString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:flowLayout>

XXX Warning: Still in progress! Please do not use it until other announcement. Renders a FlowLayout that positions the content components in there natural order.

UIComponentClass: org.apache.myfaces.tobago.component.UIFlowLayout

RendererType: FlowLayout

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
marginMargin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
marginBottomBottom margin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
marginLeftLeft margin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
marginRightRight margin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
marginTopTop margin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
textAlignThe alignment of the elements inside of the container, possible values are: {@value TextAlign#STRING_LEFT}, {@value TextAlign#STRING_RIGHT}, {@value TextAlign#STRING_CENTER} und {@value TextAlign#STRING_JUSTIFY}.Type: org.apache.myfaces.tobago.layout.TextAlignDefault: TextAlign.LEFTAllowed Values: [left, right, center, justify]String

<tc:form>

UIComponentClass: org.apache.myfaces.tobago.component.UIForm

RendererType: Form

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString

<tc:gridLayout>

Renders a GridLayout.
 columns/rows ::= LAYOUT
 LAYOUT       ::= TOKEN [";" TOKEN]+
 TOKEN        ::= AUTO | PIXEL | PROPORTIONAL
 AUTO         ::= "auto" | "fixed"
 PIXEL        ::= NUMBER "px"
 PROPORTIONAL ::= [NUMBER] "*"
 

Parent Child Okay? Remarks
AUTO any combination of AUTO or PIXEL but no PROPORTIONAL okay -
AUTO any combination with at least one PROPORTIONAL wrong LayoutManager cannot compute the auto value.
PIXEL any combination of AUTO or PIXEL but no PROPORTIONAL potentially wrong The values depend on each other, the programmer has to keep consistency manually.
PIXEL any combination with at least one PROPORTIONAL okay -
PROPORTIONAL any combination of AUTO or PIXEL but no PROPORTIONAL potentially wrong No automatic matching:
  • too little space: scroll bar
  • too much space: elements will be spread.
PROPORTIONAL any combination with at least one PROPORTIONAL okay -

UIComponentClass: org.apache.myfaces.tobago.component.UIGridLayout

RendererType: GridLayout

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
borderBorder size of this component.Type: java.lang.StringString
columnOverflowThis attribute is a hint for the layout manager. Should not be used in most cases.Type: booleanString
columnSpacingSpacing between the columns in the actual layout.Type: org.apache.myfaces.tobago.layout.MeasureString
columnsThis value defines the layout constraints for column layout. It is a semicolon separated list of layout tokens '[<n>]*', '<n>px' or 'auto'. Where <n> is a non negative integer and the square brackets means optional. Example: '2*;*;100px;auto'.Type: java.lang.StringDefault: 1*String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
marginMargin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
marginBottomBottom margin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
marginLeftLeft margin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
marginRightRight margin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
marginTopTop margin between container component and the children.Type: org.apache.myfaces.tobago.layout.MeasureString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
rowOverflowThis attribute is a hint for the layout manager. Should not be used in most cases.Type: booleanString
rowSpacingSpacing between the rows in the actual layout.Type: org.apache.myfaces.tobago.layout.MeasureString
rowsThis value defines the layout constraints for column layout. It is a semicolon separated list of layout tokens '[<n>]*', '<n>px' or 'auto'. Where <n> is a non negative integer and the square brackets means optional. Example: '2*;*;100px;auto'.Type: java.lang.StringDefault: 1*String
cellspacing

**** @deprecated. Will be removed in a future version ****

Use columnSpacing and/or rowSpacing instead.

Spacing between component and layout cell's. Can be overwritten by columnSpacing and rowSpacing.Type: org.apache.myfaces.tobago.layout.Measure
String

<tc:gridLayoutConstraint>

Add GridLayoutConstraints to the parent UIComponent.

Can contain: empty

Attributes

NameDescriptionType
borderBottomThe bottom border area for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.MeasureString
borderLeftThe left border area for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.MeasureString
borderRightThe right border area for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.MeasureString
borderTopThe top border area for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.MeasureString
columnSpanThe number of horizontal cells this component should use.String
heightThe height for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
marginBottomThe bottom margin for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
marginLeftThe left margin for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
marginRightThe right margin for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
marginTopThe top margin for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
maximumHeightThe maximum height for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
maximumWidthThe maximum width for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
minimumHeightThe minimum height for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
minimumWidthThe minimum width for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
paddingBottomThe bottom padding for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.MeasureString
paddingLeftThe left padding for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.MeasureString
paddingRightThe right padding for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.MeasureString
paddingTopThe top padding for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.MeasureString
preferredHeightThe preferred height for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
preferredWidthThe preferred width for this component.Type: org.apache.myfaces.tobago.layout.MeasureString
rowSpanThe number of vertical cells this component should use.String
widthThe width for this component.Type: org.apache.myfaces.tobago.layout.MeasureString

<tc:hidden>

Renders a hidden input element.

UIComponentClass: org.apache.myfaces.tobago.component.UIHidden

RendererType: Hidden

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
valueThe current value of this component.Type: java.lang.ObjectString

<tc:image>

Renders an image.

UIComponentClass: org.apache.myfaces.tobago.component.UIImage

RendererType: Image

Can contain: JSP

Attributes

NameDescriptionType
altAlternate textual description of the image rendered by this component.Type: java.lang.StringString
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
borderBorder size of this component.Type: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
heightThe height of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.Type: org.apache.myfaces.tobago.layout.MeasureString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
value*Absolute url to an image or image name to lookup in tobago resource pathType: java.lang.StringString
widthThe width of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.Type: org.apache.myfaces.tobago.layout.MeasureString

<tc:in>

Renders a text input field.

UIComponentClass: org.apache.myfaces.tobago.component.UIIn

RendererType: In

Supported facets:

changeThis facet can contain a UICommand that is invoked in a case of a change event from the component

Can contain: JSP

Attributes

NameDescriptionType
autocompleteType: booleanDefault: trueString
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelA localized user presentable name for this component.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
passwordFlag indicating whether or not this component should be rendered as password field , so you will not see the typed charakters.Type: booleanDefault: falseString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
suggestMethodMethodBinding which generates a list of suggested input values based on the currently entered text, which could be retrieved via getSubmittedValue() on the UIInput. The expression has to evaluate to a public method which has a javax.faces.component.UIInput parameter and returns a List<String>(deprecated), a List<org.apache.myfaces.tobago.model.AutoSuggestItem> or a org.apache.myfaces.tobago.model.AutoSuggestItems.String
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String

<tc:label>

Renders a label component.

UIComponentClass: org.apache.myfaces.tobago.component.UILabel

RendererType: Label

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
forId of the component, this is related to.Type: java.lang.StringString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
valueText value to display as label. Overwritten by 'labelWithAccessKey'Type: java.lang.StringString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:link>

Renders a link element.

UIComponentClass: org.apache.myfaces.tobago.component.UILink

RendererType: Link

Supported facets:

confirmationContains a UIOutput instance with the confirmation message.popupContains a UIPopup instance.

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
imageUrl to an image to display.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
tipText value to display as tooltip.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:loadBundle>

Load a resource bundle localized for the locale of the current view from the tobago resource path, and expose it (as a Map) in the session attributes (session scope is needed to support ajax requests).

The main difference to the JSF tag f:localBundle is the support of Tobago themes and the XML formal for properties files.

Since JSF 1.2 it is possible to use a {@link org.apache.myfaces.tobago.context.TobagoBundle} and configure it in the faces-config.xml.

Can contain: empty

Attributes

NameDescriptionType
basename*Base name of the resource bundle to be loaded.String
var*Name of a session-scope attribute under which the bundle data will be exposed.String

<tc:mediator>

Component to put other components from other frameworks into. Gives the possibility, to interchange layout information.

UIComponentClass: org.apache.myfaces.tobago.component.UIMediator

RendererType: Mediator

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
varName of a request-scope attribute under which this component is accessible.Type: java.lang.StringString

<tc:menu>

Container component to hold submenus and items.

UIComponentClass: org.apache.myfaces.tobago.component.UIMenu

RendererType: Menu

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
imageUrl to an image to display.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:menuBar>

Renders a menu bar. Add menu bar as facet name="menuBar" to page tag or use it anywhere on page.

UIComponentClass: org.apache.myfaces.tobago.component.UIMenuBar

RendererType: MenuBar

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString

<tc:menuCommand>

Renders a menu item.

UIComponentClass: org.apache.myfaces.tobago.component.UIMenuCommand

RendererType: MenuCommand

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
imageUrl to an image to display.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:menuSeparator>

Renders a separator inside of a menu.

UIComponentClass: org.apache.myfaces.tobago.component.UIMenuSeparator

RendererType: MenuSeparator

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString

<tc:messages>

Renders error/validation messages.

UIComponentClass: org.apache.myfaces.tobago.component.UIMessages

RendererType: Messages

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
confirmationHas the user to confirm this message? This attributes handles the case, if the application wants to warn the user about a problem, and the user has to confirm the message before he/she can continue.Type: booleanDefault: falseString
forId of the component, this is related to.Type: java.lang.StringString
globalOnlyFlag indicating that only messages that are not associated to any particular UIComponent should be displayed. That are messages without clientId.Type: java.lang.StringDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
maxNumberSets the maximum number of messages to show.Type: java.lang.IntegerDefault: 2147483647String
maxSeveritySets the maximum severity to be shown. E. g. "warn" shows only "warn" and "info". When setting this attribute you usually shoud take care, that you have a second message tag to show the higher severity levels.Type: javax.faces.application.FacesMessage$SeverityDefault: fatalString
minSeveritySets the mininum severity to be shown. E. g. "warn" shows only "warn", "error" and "fatal".Type: javax.faces.application.FacesMessage$SeverityDefault: infoString
orderBySets the order of the messages.Type: org.apache.myfaces.tobago.component.UIMessages$OrderByDefault: occurrenceAllowed Values: [occurrence, severity]String
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
showDetailFlag indicating whether the detail should be includedType: booleanDefault: falseString
showSummaryFlag indicating whether the summary should be includedType: booleanDefault: trueString

<tc:object>

UIComponentClass: org.apache.myfaces.tobago.component.UIObject

RendererType: Object

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
srcURI to object sourceType: java.lang.StringString

<tc:out>

Renders a text

UIComponentClass: org.apache.myfaces.tobago.component.UIOut

RendererType: Out

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
escapeFlag indicating that characters that are sensitive in HTML and XML markup must be escaped.Type: booleanDefault: trueString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String

<tc:page>

Renders a page element.

UIComponentClass: org.apache.myfaces.tobago.component.UIPage

RendererType: Page

Supported facets:

actionContains an instance of UICommand (tc:command) for an auto-actionresizeContains an instance of UICommand which will be executed when thesize of the user agent was changed. Typically a resizeActionDeprecated name for 'resize'menuBarMenubarlayoutContains an instance of AbstractUILayoutBase

Can contain: JSP

Attributes

NameDescriptionType
applicationIconAbsolute URL to an image or image name to lookup in tobago resource path representing the application. In HTML it is used as a favicon.Type: java.lang.StringString
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
focusIdContains the id of the component which should have the focus after loading the page. Set to empty string for disabling setting of focus. Default (null) enables the "auto focus" feature.Type: java.lang.StringString
heightThe height of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.Type: org.apache.myfaces.tobago.layout.MeasureString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
widthThe width of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.Type: org.apache.myfaces.tobago.layout.MeasureString
state

**** @deprecated. Will be removed in a future version ****

since Tobago 1.5.0. Please set the min/max values with e. g. a tc:gridLayoutConstraint tag.

ValueBindingExpression pointing to a object to save the component's state.Type: java.lang.Object
String

<tc:panel>

Intended for use in situations when only one UIComponent child can be nested, such as in the case of facets.

UIComponentClass: org.apache.myfaces.tobago.component.UIPanel

RendererType: Panel

Supported facets:

reloadContains an instance of UIReloadlayoutContains an instance of AbstractUILayoutBase

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString

<tc:popup>

Renders a popup panel. The popup gets a grid layout manager with columns="auto" and rows="auto" as definition. So a popup should contain only one layout component. The default layout manager can be overwritten with the layout facet.

UIComponentClass: org.apache.myfaces.tobago.component.UIPopup

RendererType: Popup

Supported facets:

layoutContains an instance of AbstractUILayoutBase

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
heightThe height of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.Type: org.apache.myfaces.tobago.layout.MeasureString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
leftThis value will usually be set by the layout manager.Type: org.apache.myfaces.tobago.layout.MeasureString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
modalType: booleanDefault: trueString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
topThis value will usually be set by the layout manager.Type: org.apache.myfaces.tobago.layout.MeasureString
widthThe width of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.Type: org.apache.myfaces.tobago.layout.MeasureString

<tc:popupReference>

Register an PopupActionListener instance on the UIComponent associated with the closest parent UIComponent.

Can contain: empty

Attributes

NameDescriptionType
for*The id of a Popup.String

<tc:progress>

Renders a progress bar.

UIComponentClass: org.apache.myfaces.tobago.component.UIProgress

RendererType: Progress

Supported facets:

completeContains an instance of UICommand (tc:command). The action is invoked if the full progress has reached

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
valueThe current value of this component.Type: javax.swing.BoundedRangeModelString

<tc:reload>

Update the parent component

UIComponentClass: org.apache.myfaces.tobago.component.UIReload

RendererType:

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
frequencyTime in milliseconds after which the parent component is automatically reloaded.Type: java.lang.IntegerDefault: 5000String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
immediateFlag indicating that the update check should be performed immediately (that is, during Apply Request Values phase) rather than waiting until Render Response phase.Type: booleanDefault: trueString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
updateIs update required.Type: booleanDefault: trueString

<tc:resetInputActionListener>

TODO document me!

Can contain: empty

Attributes

NameDescriptionType
executeThe .String

<tc:script>

This tag add client side script to the rendered page.

UIComponentClass: org.apache.myfaces.tobago.component.UIScript

RendererType: Script

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
fileType: java.lang.StringString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
onexitType: java.lang.StringString
onloadType: java.lang.StringString
onsubmitType: java.lang.StringString
onunloadType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
scriptType: java.lang.StringString

<tc:selectBooleanCheckbox>

Renders a checkbox.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectBooleanCheckbox

RendererType: SelectBooleanCheckbox

Supported facets:

clickThis facet can contain a UICommand that is invoked in case of a click event from the componentchangeThis facet can contain a UICommand that is invoked in case of a change event from the component

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
itemLabelLabel to be displayed to the user for this option.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:selectItem>

Add a child UISelectItem component to the UIComponent associated with the closed parent UIComponent custom action.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectItem

RendererType:

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
itemDescriptionDescription of an item for use in tools.Type: java.lang.StringString
itemDisabledFlag indicating whether the option created by this component is disabled.Type: booleanDefault: falseString
itemImageImage to be displayed to the user for this option.Type: java.lang.StringString
itemLabelLabel to be displayed to the user for this option.Type: java.lang.StringString
itemValueValue to be returned to the server if this option is selected by the user.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
valueValue binding expression pointing at a SelectItem instance containing the information for this option.Type: javax.faces.model.SelectItemString

<tc:selectItems>

Add a child UISelectItems component to the UIComponent associated with the closed parent UIComponent custom action.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectItems

RendererType:

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
valueValue binding expression pointing at a List or array of SelectItem instances containing the information for this option.Type: javax.faces.model.SelectItem[]String

<tc:selectManyCheckbox>

Render a group of checkboxes.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectManyCheckbox

RendererType: SelectManyCheckbox

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
inlineFlag indicating this component should rendered as an inline element.Type: booleanDefault: falseString
labelA localized user presentable name for this component.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderRangeRange of items to render.Type: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe value of the multi select.Type: [java.lang.Object[], java.util.List]String
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String

<tc:selectManyListbox>

Render a multi selection option listbox.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectManyListbox

RendererType: SelectManyListbox

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe value of the multi select.Type: [java.lang.Object[], java.util.List]String
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:selectManyShuttle>

UIComponentClass: org.apache.myfaces.tobago.component.UISelectManyShuttle

RendererType: SelectManyShuttle

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelA localized user presentable name for this component.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
selectedLabelA localized user presentable label for the right select box.Type: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
unselectedLabelA localized user presentable label for the left select box.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe value of the multi select.Type: [java.lang.Object[], java.util.List]String
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String

<tc:selectOneChoice>

Render a single selection dropdown list.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectOneChoice

RendererType: SelectOneChoice

Supported facets:

clickThis facet can contain a UICommand that is invoked in case of a click event from the componentchangeThis facet can contain a UICommand that is invoked in case of a change event from the component

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that selecting an Item representing a value is required. If an SelectItem was chosen which underling value is an empty string an ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:selectOneListbox>

Render a single selection option listbox.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectOneListbox

RendererType: SelectOneListbox

Supported facets:

clickThis facet can contain a UICommand that is invoked in case of a click event from the componentchangeThis facet can contain a UICommand that is invoked in case of a change event from the component

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that selecting an Item representing a Value is Required. If an SelectItem was chosen which underling value is an empty string an ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:selectOneRadio>

Render a set of radio buttons.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectOneRadio

RendererType: SelectOneRadio

Supported facets:

clickThis facet can contain a UICommand that is invoked in case of a click event from the componentchangeThis facet can contain a UICommand that is invoked in case of a change event from the component

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
inlineFlag indicating this component should rendered as an inline element.Type: booleanDefault: falseString
labelA localized user presentable name for this component.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderRangeRange of items to render.Type: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that selecting an Item representing a Value is Required. If an SelectItem was chosen which underling value is an empty string an ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String

<tc:selectReference>

Renders a set of option related to and same type as the for component.

UIComponentClass: org.apache.myfaces.tobago.component.UISelectReference

RendererType: SelectReference

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
for*Id of the component, this is related to.Type: java.lang.StringString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
renderRange*Range of items to render.Type: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString

<tc:separator>

Renders a separator.

UIComponentClass: org.apache.myfaces.tobago.component.UISeparator

RendererType: Separator

Supported facets:

labelThis facet contains a UILabel

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString

<tc:sheet>

Render a sheet element.

UIComponentClass: org.apache.myfaces.tobago.component.UISheet

RendererType: Sheet

Supported facets:

reloadContains an instance of UIReload

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
columnsLayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%').Type: java.lang.StringString
directLinkCountThe count of rendered direct paging links in the sheet's footer.Type: java.lang.IntegerDefault: 9String
firstZero-relative row number of the first row to be displayed.Type: java.lang.IntegerDefault: 0String
forceVerticalScrollbarFlag indicating whether or not this sheet should reserve space for vertical toolbar when calculating column width's. Possible values are:
      'auto'  : sheet try to estimate the need of scrollbar.
      'true'  : space for scroolbar is reserved.
      'false' : no space is reserved.
      
Type: java.lang.StringDefault: autoAllowed Values: [auto, true, false]
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
rowsThe number of rows to display, starting with the one identified by the "first" property. The default has been changed from 100 to 0 because this is the default of the JSF standard (Tobago 1.5).Type: java.lang.IntegerDefault: 0String
selectableFlag indicating whether or not the sheet should be selectable.Type: java.lang.StringDefault: multiAllowed Values: [none, single, singleOrNone, multi]String
showDirectLinksFlag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.Type: java.lang.StringDefault: centerAllowed Values: [left, center, right, none]String
showHeaderFlag indicating the header should be rendered.Type: booleanDefault: trueString
showPageRangeFlag indicating whether and where the range pages should rendered in the sheet's footer. Rendering this range also offers the capability to enter the index displayed page directly.Type: java.lang.StringDefault: rightAllowed Values: [left, center, right, none]String
showPagingAlwaysFlag indicating whether or not the paging panel should be display, if it is not needed for paging.
  • showPagingAlways="false" which is the default means, that the paging footer should be displayed, only when it is needed.
    • When the rows="0" paging is not needed, so the footer will not be rendered,
String
showRootOnly applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.Type: booleanDefault: falseString
showRootJunctionOnly applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch.Type: booleanDefault: falseString
showRowRangeFlag indicating whether or not the range of displayed rows should rendered in the sheet's footer. Rendering this range also offers the capability to enter the index of the start row directly.Type: java.lang.StringDefault: leftAllowed Values: [left, center, right, none]String
sortActionListenerMethod binding representing an actionListener method that will be invoked when sorting was requested by the user. Use this if your application needs special handling for sorting columns. If this is not set and the sortable attribute column is set to true the sheet implementation will use a default sort method. The expression must evaluate to a public method which takes an ActionEvent as parameter and with a return type of void. The method will receive a {@link org.apache.myfaces.tobago.event.SortActionEvent}. The method should sort according to the sortColumnId and direction getting from the sheet's {@link org.apache.myfaces.tobago.model.SheetState} object.String
stateSheet state saving object.Type: org.apache.myfaces.tobago.model.SheetStateString
stateChangeListenerMethod binding representing a stateChangeListener method that will be notified when the state was changed by the user. The expression must evaluate to a public method that takes a SheetStateChangeEvent parameter, with a return type of void.String
valueThe sheet's data.Type: [java.lang.Object[], java.util.List, javax.servlet.jsp.jstl.sql.Result, java.sql.ResultSet, java.lang.Object, javax.faces.model.DataModel]String
var*Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed.Type: java.lang.StringString

<tc:sheetLayout>

Creates a SheetLayout, which is a internal layout manager of a sheet.

UIComponentClass: org.apache.myfaces.tobago.component.UISheetLayout

RendererType: SheetLayout

Can contain: empty

Attributes

NameDescriptionType
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString

<tc:style>

Add a style tag. Collected bodyContent is rendered as content into a style tag.

UIComponentClass: org.apache.myfaces.tobago.component.UIStyle

RendererType: Style

Can contain: tagdependent

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
fileName of the stylesheet file to add to page.Type: java.lang.StringString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
stylestylesheet to add to page.Type: java.lang.StringString

<tc:tab>

Renders a tab within a tabgroup.

UIComponentClass: org.apache.myfaces.tobago.component.UITab

RendererType: Tab

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:tabChangeListener>

Register an TabChangedListener instance on the UIComponent associated with the closest parent UIComponent custom action.

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression to a TabChangeListener.String
type*Fully qualified Java class name of a TabChangeListener to be created and registered.String

<tc:tabGroup>

Renders a tab group which contains tab panels.

UIComponentClass: org.apache.myfaces.tobago.component.UITabGroup

RendererType: TabGroup

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
selectedIndexValueBindingExpression pointing to a Integer to save the component's selected Tab.Type: java.lang.IntegerDefault: 0String
showNavigationBarFlag indicating that the tab navigation bar is rendered.Type: booleanDefault: trueString
switchTypeIndicating how tab switching should be done.

Possible values are: client Tab switching is done on client, no server Request. reloadPage Tab switching is done by server request. Full page is reloaded. reloadTab Tab switching is done by server request. Only the Tab is reloaded. Type: java.lang.StringDefault: clientAllowed Values: [client, reloadPage, reloadTab]
String
tabChangeListenernullString

<tc:tabGroupLayout>

Creates a TabGroupLayout, which is a internal layout manager of a tabGroup.

UIComponentClass: org.apache.myfaces.tobago.component.UITabGroupLayout

RendererType: TabGroupLayout

Can contain: empty

Attributes

NameDescriptionType
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString

<tc:textarea>

Renders a multi line text input control.

UIComponentClass: org.apache.myfaces.tobago.component.UITextarea

RendererType: Textarea

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
rowsThe row count for this component.Type: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:time>

Renders a time input field.

UIComponentClass: org.apache.myfaces.tobago.component.UITime

RendererType: Time

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
focusFlag indicating this component should receive the focus.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onchangeClientside script function to add to this component's onchange handler.Type: java.lang.StringString
readonlyFlag indicating that this component will prohibit changes by the user.Type: booleanDefault: falseString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
tipText value to display as tooltip.Type: java.lang.StringString
validatorA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.String
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:toolBar>

Renders a toolbar.

Allowed subcomponents are subtypes of UICommand i.e. 'button' and 'link' tags. These are rendered by ToolbarRenderer, so the result has no difference.

To add an dropdown menu to a button add a facet 'menupopup' containing a <tc:menu> tag to the button. Label's and Image's on those menu tag's are ignored and replaced by the renderer.
      <tc:button onclick="alert('test 0')"
          label="Alert 0" >
        <f:facet name="menupopup">
          <tc:menu>
            <tc:menuCommand onclick="alert('test 1')" label="Alert 1"/>
            <tc:menuCommand onclick="alert('test 2')" label="Alert 2"/>
            <tc:menuCommand onclick="alert('test 3')" label="Alert 3"/>
          </tc:menu>
        </f:facet>
      </tc:button>
      

UIComponentClass: org.apache.myfaces.tobago.component.UIToolBar

RendererType: ToolBar

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
iconSizeSize of button images, possible values are: small, big, off.Type: java.lang.StringDefault: smallAllowed Values: [small, big, off]String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelPositionPosition of the button label, possible values are: right, bottom, off. If toolbar is facet of box: bottom is changed to right!Type: java.lang.StringDefault: bottomAllowed Values: [bottom, right, off]String
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
orientationOrientation of toolbarType: java.lang.StringDefault: leftAllowed Values: [left, right]String
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString

<tc:toolBarCheck>

Renders a selectable command button within a toolbar.

UIComponentClass: org.apache.myfaces.tobago.component.UIToolBarCheck

RendererType: MenuCommand

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
imageUrl to an image to display.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
tipText value to display as tooltip.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
valueThe current value of this component.Type: java.lang.ObjectString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:toolBarCommand>

Renders a command button within a toolbar.

UIComponentClass: org.apache.myfaces.tobago.component.UIToolBarCommand

RendererType: Button

Supported facets:

confirmationContains a UIOutput instance with the confirmation message.popupContains a UIPopup instance.menupopupDeprecated. Please use dropDownMenu facet.dropDownMenuContains a UIMenu instance to render a drop down menu.

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
imageUrl to an image to display.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
tipText value to display as tooltip.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:toolBarSelectOne>

Renders a set of radio command button's within a toolbar.

UIComponentClass: org.apache.myfaces.tobago.component.UIToolBarSelectOne

RendererType: MenuCommand

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
valueThe current value of this component.Type: java.lang.ObjectString

<tc:toolBarSeparator>

Renders a separator inside of a tool bar.

UIComponentClass: org.apache.myfaces.tobago.component.UIToolBarSeparator

RendererType:

Can contain: empty

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString

<tc:tree>

A tree with classical look. Usually used with icons and junction lines to open folder, etc.

UIComponentClass: org.apache.myfaces.tobago.component.UITree

RendererType: Tree

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
selectableFlag indicating whether or not this component should be render selectable items. Possible values are:
  • multi : a multi section tree is rendered
  • single : a single section tree is rendered
  • multiLeafOnly : a multi section tree is rendered, only Leaf's are selectable
  • singleLeafOnly : a single section tree is rendered, only Leaf's are selectable
For any other value or if this attribute is omitted the items are not selectable.Type: java.lang.StringDefault: offAllowed Values: [multi, single, multiLeafOnly, singleLeafOnly, off]
String
showRootOnly applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.Type: booleanDefault: falseString
showRootJunctionOnly applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch.Type: booleanDefault: falseString
stateValueBindingExpression pointing to a object to save the component's state.Type: org.apache.myfaces.tobago.model.TreeStateString
valueThe current value of this component.Type: java.lang.ObjectString
var*Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed.Type: java.lang.StringString

<tc:treeCommand>

Renders a command inside of a tree.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeCommand

RendererType: TreeCommand

Supported facets:

confirmationContains a UIOutput instance with the confirmation message.popupContains a UIPopup instance.

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
tabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.Type: java.lang.IntegerString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
tipText value to display as tooltip.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
inline

**** @deprecated. Will be removed in a future version ****

This should be handled by e.g. a flow layout manager (since 1.5.0)

Flag indicating this component should rendered as an inline element.Type: booleanDefault: false
String

<tc:treeIcon>

Renders an image beside a tree node.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeIcon

RendererType: TreeIcon

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
valueAbsolute url to an image or image name to lookup in tobago resource pathType: java.lang.StringString

<tc:treeIndent>

Renders an indent beside a tree node.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeIndent

RendererType: TreeIndent

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
showJunctionsShow the lines and icons which are defining the tree structure.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString

<tc:treeLabel>

Renders a label inside of a tree.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeLabel

RendererType: TreeLabel

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
valueText value to display as label.Type: java.lang.StringString

<tc:treeListbox>

A tree data structure displayed as a set of list boxes.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeListbox

RendererType: TreeListbox

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
selectableFlag indicating whether or not this component should be render selectable items. Possible values are:
  • single : a single section tree is rendered
  • multiLeafOnly : a multi section tree is rendered, only Leaf's are selectable
  • singleLeafOnly : a single section tree is rendered, only Leaf's are selectable
For any other value or if this attribute is omitted the items are not selectable.Type: java.lang.StringDefault: offAllowed Values: [single, multiLeafOnly, singleLeafOnly, off]
String
stateValueBindingExpression pointing to a object to save the component's state.Type: org.apache.myfaces.tobago.model.TreeStateString
valueThe current value of this component.Type: java.lang.ObjectString
var*Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed.Type: java.lang.StringString

<tc:treeMenu>

A tree which will be displayed like a flat menu. This menu is often used for navigation on the left side of an application.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeMenu

RendererType: TreeMenu

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
showRootOnly applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.Type: booleanDefault: falseString
stateValueBindingExpression pointing to a object to save the component's state.Type: org.apache.myfaces.tobago.model.TreeStateString
valueThe current value of this component.Type: java.lang.ObjectString
var*Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed.Type: java.lang.StringString

<tc:treeNode>

Creates a tree node. This component represents a single node inside a tree structure.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeNode

RendererType: TreeNode

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
treeExpansionListenerMethod binding representing a expansionListener method that ....String
treeMarkedListenerMethod binding representing a markedListener method that ....String
expanded

**** @deprecated. Will be removed in a future version ****

since 1.6.0. Please use the state attribute of the tree with a TreeState

Flag indicating if the subnodes are to be displayed.Type: booleanDefault: false
String
marked

**** @deprecated. Will be removed in a future version ****

since 1.6.0. Please use the state attribute of the tree with a TreeState

Flag indicating if the node is marked, and should be displayed in a special way.Type: booleanDefault: false
String
selected

**** @deprecated. Will be removed in a future version ****

since 1.6.0. Please use <tc:treeSelect>

Flag indicating if the node is selected (only possible, when the tree component allows it).Type: booleanDefault: false
String

<tc:treeSelect>

Makes a tree node selectable.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeSelect

RendererType: TreeSelect

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
converterAn expression that specifies the Converter for this component. If the value binding expression is a String, the String is used as an ID to look up a Converter. If the value binding expression is a Converter, uses that instance as the converter. The value can either be a static value (ID case only) or an EL expression.Type: javax.faces.convert.ConverterString
converterMessageAn expression that specifies the converter messageType: java.lang.StringString
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
requiredFlag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: falseString
requiredMessageAn expression that specifies the required messageType: java.lang.StringString
showCheckboxShow a checkbox to visualize the selection state.Type: booleanDefault: trueString
tipText value to display as tooltip.Type: java.lang.StringString
validatorMessageAn expression that specifies the validator messageType: java.lang.StringString
valueThe current value of this component.Type: java.lang.ObjectString
valueChangeListenerMethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.String

<tc:validateFileItem>

Register an FileItemValidator instance on the UIComponent associated with the closest parent UIComponent custom action.

Can contain: JSP

Attributes

NameDescriptionType
contentTypenullString
maxSizenullString

<tc:validateSubmittedValueLength>

Register an SubmittedValueLengthValidator instance on the UIComponent associated with the closest parent UIComponent custom action. The standard LengthValidator validate the length on the converted value.toString() not on the submitted value. Sometime you need to check the length of the submitted value.

Can contain: JSP

Attributes

NameDescriptionType
maximumnullString
minimumnullString

<tc:wizard>

Renders a flexible wizard.

UIComponentClass: org.apache.myfaces.tobago.component.UIWizard

RendererType: Wizard

Can contain: JSP

Attributes

NameDescriptionType
allowJumpForwardIs a jump forward to following pages allowed?Type: booleanDefault: falseString
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
controller*Type: org.apache.myfaces.tobago.model.WizardString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
outcome*Outcome to navigate to this page.Type: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
titleTitle of this pageType: java.lang.StringString
var*Name of a request-scope attribute under which the model data will be exposed.Type: java.lang.StringString

<tc:cell>

**** @deprecated. Will be removed in a future version ****

The Cell is deprecated since Tobago 1.5.0

Renders a panel-like layout element with the ability to span over more than one layout cell. A cell may only contain one child.

UIComponentClass: org.apache.myfaces.tobago.component.UICell

RendererType: Cell

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
markupIndicate markup of this component. The allowed markups can be defined or overridden in the theme. The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.Type: org.apache.myfaces.tobago.context.MarkupString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
scrollbarspossible values are:
  • 'false' : no scrollbars should be rendered
  • 'true' : scrollbars should always be rendered
  • 'auto' : scrollbars should be rendered when needed
Type: java.lang.StringDefault: falseAllowed Values: [false, true, auto]
String
spanXCount of layout columns to span over.Type: java.lang.IntegerDefault: 1String
spanYCount of layout rows to span over.Type: java.lang.IntegerDefault: 1String

<tc:menuItem>

**** @deprecated. Will be removed in a future version ****

Renders a menu item.

Please use menuCommand instead!

UIComponentClass: org.apache.myfaces.tobago.component.UIMenuItem

RendererType: MenuCommand

Can contain: JSP

Attributes

NameDescriptionType
actionAction to invoke when clicked. This must be a MethodBinding or a String representing the application action to invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. The string is directly passed to the navigation handler.String
actionListenerMethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.String
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
disabledFlag indicating that this element is disabled.Type: booleanDefault: falseString
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
imageUrl to an image to display.Type: java.lang.StringString
immediateFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.Type: booleanDefault: falseString
jsfResourceFlag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.Type: booleanDefault: falseString
labelText value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.StringString
linkLink to an arbitrary URL, either an internal link or an external link. internal absolute link Starts with a slash '/' character. The context path will be added. A session id will be added, if needed. external link Contains a colon ':' character. The link will not be modified. internal relative link Any other strings. A session id will be added, if needed. Type: java.lang.StringString
onclickScript to be invoked when clickedType: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
renderedPartiallyIndicate the partially rendered Components in a case of a submit.Type: java.lang.String[]String
resourceLink to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.Type: java.lang.StringString
targetName of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.StringString
transitionSpecify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: trueString
accessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Has not longer any function.Type: java.lang.Character
String
labelWithAccessKey

**** @deprecated. Will be removed in a future version ****

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.Type: java.lang.String
String

<tc:treeData>

**** @deprecated. Will be removed in a future version ****

since 1.6.0. Please use the "var" and "value" attribute of the parent tree tag.

Describes a sub tree of nodes. The value has to be a javax.swing.tree.TreeNode object to use as rootNode in the tree.

UIComponentClass: org.apache.myfaces.tobago.component.UITreeData

RendererType: TreeData

Can contain: JSP

Attributes

NameDescriptionType
bindingThe value binding expression linking this component to a property in a backing bean.

Warning: For the tobago extension library tx the binding differs from JSP and Facelets:
  • JSP: The component is the inner main control (e. g. UIInput).
  • Facelets: The component is the outer UIPanel.
Type: javax.faces.component.UIComponent
String
idThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.StringString
renderedFlag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: trueString
valueThe current value of this component.Type: java.lang.ObjectString
var*Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed.Type: java.lang.StringString