Tag reference sheet
Tag library reference for the following tag libraries:
- Tobago Components 1.5.x (tobago.tld) - uri: http://myfaces.apache.org/tobago/component
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
Name | Description | Type |
---|---|---|
mode | Warning: 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 AbstractUILayoutBaseCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
collapsed | Flag indicating whether or not this component is collapsed.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
<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
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
defaultCommand | If true the command is executed as default -- for example if the user presses the enter key inside a related input field.Type: booleanDefault: false | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
image | Url to an image to display.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
link | Link 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.String | String |
markup | Indicate 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.Markup | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
tabIndex | Controls 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.Integer | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | 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:calendar>
Renders a calendar.UIComponentClass: org.apache.myfaces.tobago.component.UICalendar
RendererType: Calendar
Can contain: empty
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
value | The 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
Name | Description | Type |
---|---|---|
align | Alignment of this column.Type: java.lang.String | String |
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
resizable | Flag indicating whether or not the width of this column in a sheet is resizable, by the user.Type: booleanDefault: true | String |
sortable | Flag 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: false | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
width | The layout token for this column. Allowd layout tokens ('*', '<x>*', '<x>px' or '<x>%'). Where '*' is equvalent to '1*'.Type: java.lang.String | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
event | Type: java.lang.StringAllowed Values: [click, dblclick] | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
resizable | Flag indicating whether or not the width of this column in a sheet is resizable, by the user.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
<tc:columnSelector>
Renders a column with checkboxes to mark selected rows.UIComponentClass: org.apache.myfaces.tobago.component.UIColumnSelector
RendererType: ColumnSelector
Can contain: empty
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
<tc:command>
Use this tag only as a facet for click, change in selectOneRadio, selectBooleanCheckbox, selectManyCheckbox and selectOneChoiceUIComponentClass: org.apache.myfaces.tobago.component.UICommand
RendererType: Command
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
link | Link 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.String | String |
markup | Indicate 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.Markup | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | String |
value | The current value of this component.Type: java.lang.Object | String |
<tc:converter>
Register an Converter instance on the UIComponent associated with the closest parent UIComponent.Can contain: empty
<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 componentCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
for | Id of the component, this is related to.Type: java.lang.String | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tabIndex | Controls 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.Integer | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | Value binding expression pointing to a org.apache.commons.fileupload.FileItem property to store the uploaded file.Type: org.apache.commons.fileupload.FileItem | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
margin | Margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginBottom | Bottom margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginLeft | Left margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginRight | Right margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginTop | Top margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
markup | Indicate 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.Markup | String |
textAlign | The 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
<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:
|
PROPORTIONAL | any combination with at least one PROPORTIONAL | okay | - |
UIComponentClass: org.apache.myfaces.tobago.component.UIGridLayout
RendererType: GridLayout
Can contain: empty
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
border | Border size of this component.Type: java.lang.String | String |
columnOverflow | This attribute is a hint for the layout manager. Should not be used in most cases.Type: boolean | String |
columnSpacing | Spacing between the columns in the actual layout.Type: org.apache.myfaces.tobago.layout.Measure | String |
columns | This 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 |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
margin | Margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginBottom | Bottom margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginLeft | Left margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginRight | Right margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginTop | Top margin between container component and the children.Type: org.apache.myfaces.tobago.layout.Measure | String |
markup | Indicate 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.Markup | String |
rowOverflow | This attribute is a hint for the layout manager. Should not be used in most cases.Type: boolean | String |
rowSpacing | Spacing between the rows in the actual layout.Type: org.apache.myfaces.tobago.layout.Measure | String |
rows | This 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
Name | Description | Type |
---|---|---|
borderBottom | The bottom border area for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.Measure | String |
borderLeft | The left border area for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.Measure | String |
borderRight | The right border area for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.Measure | String |
borderTop | The top border area for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.Measure | String |
columnSpan | The number of horizontal cells this component should use. | String |
height | The height for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginBottom | The bottom margin for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginLeft | The left margin for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginRight | The right margin for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
marginTop | The top margin for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
maximumHeight | The maximum height for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
maximumWidth | The maximum width for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
minimumHeight | The minimum height for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
minimumWidth | The minimum width for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
paddingBottom | The bottom padding for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.Measure | String |
paddingLeft | The left padding for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.Measure | String |
paddingRight | The right padding for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.Measure | String |
paddingTop | The top padding for this component. Its only applicably for containers.Type: org.apache.myfaces.tobago.layout.Measure | String |
preferredHeight | The preferred height for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
preferredWidth | The preferred width for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
rowSpan | The number of vertical cells this component should use. | String |
width | The width for this component.Type: org.apache.myfaces.tobago.layout.Measure | String |
<tc:hidden>
Renders a hidden input element.UIComponentClass: org.apache.myfaces.tobago.component.UIHidden
RendererType: Hidden
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
value | The current value of this component.Type: java.lang.Object | String |
<tc:image>
Renders an image.UIComponentClass: org.apache.myfaces.tobago.component.UIImage
RendererType: Image
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
alt | Alternate textual description of the image rendered by this component.Type: java.lang.String | String |
binding | The 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:
| String |
border | Border size of this component.Type: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
height | The 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.Measure | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
value* | Absolute url to an image or image name to lookup in tobago resource pathType: java.lang.String | String |
width | The 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.Measure | String |
<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 componentCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
autocomplete | Type: booleanDefault: true | String |
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | A localized user presentable name for this component.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
password | Flag indicating whether or not this component should be rendered as password field , so you will not see the typed charakters.Type: booleanDefault: false | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
suggestMethod | MethodBinding 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 |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
for | Id of the component, this is related to.Type: java.lang.String | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
value | Text value to display as label. Overwritten by 'labelWithAccessKey'Type: java.lang.String | 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: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
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
image | Url to an image to display.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
link | Link 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.String | String |
markup | Indicate 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.Markup | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
tabIndex | Controls 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.Integer | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | 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: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
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
var | Name of a request-scope attribute under which this component is accessible.Type: java.lang.String | String |
<tc:menu>
Container component to hold submenus and items.UIComponentClass: org.apache.myfaces.tobago.component.UIMenu
RendererType: Menu
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
image | Url to an image to display.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | 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: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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
<tc:menuCommand>
Renders a menu item.UIComponentClass: org.apache.myfaces.tobago.component.UIMenuCommand
RendererType: MenuCommand
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
image | Url to an image to display.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
link | Link 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.String | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | 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:menuSeparator>
Renders a separator inside of a menu.UIComponentClass: org.apache.myfaces.tobago.component.UIMenuSeparator
RendererType: MenuSeparator
Can contain: empty
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
<tc:messages>
Renders error/validation messages.UIComponentClass: org.apache.myfaces.tobago.component.UIMessages
RendererType: Messages
Can contain: empty
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
confirmation | Has 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: false | String |
for | Id of the component, this is related to.Type: java.lang.String | String |
globalOnly | Flag indicating that only messages that are not associated to any particular UIComponent should be displayed. That are messages without clientId.Type: java.lang.StringDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
maxNumber | Sets the maximum number of messages to show.Type: java.lang.IntegerDefault: 2147483647 | String |
maxSeverity | Sets 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: fatal | String |
minSeverity | Sets the mininum severity to be shown. E. g. "warn" shows only "warn", "error" and "fatal".Type: javax.faces.application.FacesMessage$SeverityDefault: info | String |
orderBy | Sets the order of the messages.Type: org.apache.myfaces.tobago.component.UIMessages$OrderByDefault: occurrenceAllowed Values: [occurrence, severity] | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
showDetail | Flag indicating whether the detail should be includedType: booleanDefault: false | String |
showSummary | Flag indicating whether the summary should be includedType: booleanDefault: true | String |
<tc:object>
UIComponentClass: org.apache.myfaces.tobago.component.UIObject
RendererType: Object
Can contain: empty
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
src | URI to object sourceType: java.lang.String | String |
<tc:out>
Renders a textUIComponentClass: org.apache.myfaces.tobago.component.UIOut
RendererType: Out
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
escape | Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.Type: booleanDefault: true | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | 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: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 AbstractUILayoutBaseCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
applicationIcon | Absolute 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.String | String |
binding | The 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:
| String |
focusId | Contains 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.String | String |
height | The 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.Measure | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
width | The 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.Measure | String |
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 AbstractUILayoutBaseCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
<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 AbstractUILayoutBaseCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
height | The 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.Measure | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
left | This value will usually be set by the layout manager.Type: org.apache.myfaces.tobago.layout.Measure | String |
markup | Indicate 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.Markup | String |
modal | Type: booleanDefault: true | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
top | This value will usually be set by the layout manager.Type: org.apache.myfaces.tobago.layout.Measure | String |
width | The 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.Measure | String |
<tc:popupReference>
Register an PopupActionListener instance on the UIComponent associated with the closest parent UIComponent.Can contain: empty
<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 reachedCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
value | The current value of this component.Type: javax.swing.BoundedRangeModel | String |
<tc:reload>
Update the parent componentUIComponentClass: org.apache.myfaces.tobago.component.UIReload
RendererType:
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
frequency | Time in milliseconds after which the parent component is automatically reloaded.Type: java.lang.IntegerDefault: 5000 | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
immediate | Flag 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: true | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
update | Is update required.Type: booleanDefault: true | 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
file | Type: java.lang.String | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
onexit | Type: java.lang.String | String |
onload | Type: java.lang.String | String |
onsubmit | Type: java.lang.String | String |
onunload | Type: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
script | Type: java.lang.String | String |
<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 componentCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
itemLabel | Label to be displayed to the user for this option.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
itemDescription | Description of an item for use in tools.Type: java.lang.String | String |
itemDisabled | Flag indicating whether the option created by this component is disabled.Type: booleanDefault: false | String |
itemImage | Image to be displayed to the user for this option.Type: java.lang.String | String |
itemLabel | Label to be displayed to the user for this option.Type: java.lang.String | String |
itemValue | Value to be returned to the server if this option is selected by the user.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
value | Value binding expression pointing at a SelectItem instance containing the information for this option.Type: javax.faces.model.SelectItem | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
value | Value 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
inline | Flag indicating this component should rendered as an inline element.Type: booleanDefault: false | String |
label | A localized user presentable name for this component.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
renderRange | Range of items to render.Type: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The value of the multi select.Type: [java.lang.Object[], java.util.List] | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The value of the multi select.Type: [java.lang.Object[], java.util.List] | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | A localized user presentable name for this component.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
selectedLabel | A localized user presentable label for the right select box.Type: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
unselectedLabel | A localized user presentable label for the left select box.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The value of the multi select.Type: [java.lang.Object[], java.util.List] | String |
valueChangeListener | MethodBinding 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 componentCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag 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: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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 componentCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag 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: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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 componentCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
inline | Flag indicating this component should rendered as an inline element.Type: booleanDefault: false | String |
label | A localized user presentable name for this component.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
renderRange | Range of items to render.Type: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag 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: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
for* | Id of the component, this is related to.Type: java.lang.String | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
renderRange* | Range of items to render.Type: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
<tc:separator>
Renders a separator.UIComponentClass: org.apache.myfaces.tobago.component.UISeparator
RendererType: Separator
Supported facets:
labelThis facet contains a UILabelCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
<tc:sheet>
Render a sheet element.UIComponentClass: org.apache.myfaces.tobago.component.UISheet
RendererType: Sheet
Supported facets:
reloadContains an instance of UIReloadCan contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
columns | LayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%').Type: java.lang.String | String |
directLinkCount | The count of rendered direct paging links in the sheet's footer.Type: java.lang.IntegerDefault: 9 | String |
first | Zero-relative row number of the first row to be displayed.Type: java.lang.IntegerDefault: 0 | String |
forceVerticalScrollbar | Flag 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. | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
rows | The 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: 0 | String |
selectable | Flag indicating whether or not the sheet should be selectable.Type: java.lang.StringDefault: multiAllowed Values: [none, single, singleOrNone, multi] | String |
showDirectLinks | Flag 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 |
showHeader | Flag indicating the header should be rendered.Type: booleanDefault: true | String |
showPageRange | Flag 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 |
showPagingAlways | Flag indicating whether or not the paging panel should be display, if it is not needed for paging.
| String |
showRoot | Only 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: false | String |
showRootJunction | Only 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: false | String |
showRowRange | Flag 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 |
sortActionListener | Method 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 |
state | Sheet state saving object.Type: org.apache.myfaces.tobago.model.SheetState | String |
stateChangeListener | Method 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 |
value | The 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.String | String |
<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
Name | Description | Type |
---|---|---|
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
file | Name of the stylesheet file to add to page.Type: java.lang.String | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
style | stylesheet to add to page.Type: java.lang.String | String |
<tc:tab>
Renders a tab within a tabgroup.UIComponentClass: org.apache.myfaces.tobago.component.UITab
RendererType: Tab
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | 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:tabChangeListener>
Register an TabChangedListener instance on the UIComponent associated with the closest parent UIComponent custom action.Can contain: empty
<tc:tabGroup>
Renders a tab group which contains tab panels.UIComponentClass: org.apache.myfaces.tobago.component.UITabGroup
RendererType: TabGroup
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
immediate | Flag 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: false | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
selectedIndex | ValueBindingExpression pointing to a Integer to save the component's selected Tab.Type: java.lang.IntegerDefault: 0 | String |
showNavigationBar | Flag indicating that the tab navigation bar is rendered.Type: booleanDefault: true | String |
switchType | Indicating 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 |
tabChangeListener | null | String |
<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
Name | Description | Type |
---|---|---|
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
<tc:textarea>
Renders a multi line text input control.UIComponentClass: org.apache.myfaces.tobago.component.UITextarea
RendererType: Textarea
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
rows | The row count for this component.Type: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
focus | Flag indicating this component should receive the focus.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
onchange | Clientside script function to add to this component's onchange handler.Type: java.lang.String | String |
readonly | Flag indicating that this component will prohibit changes by the user.Type: booleanDefault: false | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
tabIndex | Controls 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.Integer | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validator | A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value. | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
iconSize | Size of button images, possible values are: small, big, off.Type: java.lang.StringDefault: smallAllowed Values: [small, big, off] | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
labelPosition | Position 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 |
markup | Indicate 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.Markup | String |
orientation | Orientation of toolbarType: java.lang.StringDefault: leftAllowed Values: [left, right] | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
<tc:toolBarCheck>
Renders a selectable command button within a toolbar.UIComponentClass: org.apache.myfaces.tobago.component.UIToolBarCheck
RendererType: MenuCommand
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
image | Url to an image to display.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
link | Link 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.String | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | String |
value | The current value of this component.Type: java.lang.Object | 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: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
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
image | Url to an image to display.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
link | Link 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.String | String |
markup | Indicate 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.Markup | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | 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: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
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
link | Link 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.String | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | String |
value | The current value of this component.Type: java.lang.Object | String |
<tc:toolBarSeparator>
Renders a separator inside of a tool bar.UIComponentClass: org.apache.myfaces.tobago.component.UIToolBarSeparator
RendererType:
Can contain: empty
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
selectable | Flag indicating whether or not this component should be render selectable items.
Possible values are:
| String |
showRoot | Only 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: false | String |
showRootJunction | Only 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: false | String |
state | ValueBindingExpression pointing to a object to save the component's state.Type: org.apache.myfaces.tobago.model.TreeState | String |
value | The current value of this component.Type: java.lang.Object | 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.String | String |
<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
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
link | Link 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.String | String |
markup | Indicate 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.Markup | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
tabIndex | Controls 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.Integer | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | 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:treeIcon>
Renders an image beside a tree node.UIComponentClass: org.apache.myfaces.tobago.component.UITreeIcon
RendererType: TreeIcon
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
value | Absolute url to an image or image name to lookup in tobago resource pathType: java.lang.String | String |
<tc:treeIndent>
Renders an indent beside a tree node.UIComponentClass: org.apache.myfaces.tobago.component.UITreeIndent
RendererType: TreeIndent
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
showJunctions | Show the lines and icons which are defining the tree structure.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
<tc:treeLabel>
Renders a label inside of a tree.UIComponentClass: org.apache.myfaces.tobago.component.UITreeLabel
RendererType: TreeLabel
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
value | Text value to display as label.Type: java.lang.String | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
selectable | Flag indicating whether or not this component should be render selectable items.
Possible values are:
| String |
state | ValueBindingExpression pointing to a object to save the component's state.Type: org.apache.myfaces.tobago.model.TreeState | String |
value | The current value of this component.Type: java.lang.Object | 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.String | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
showRoot | Only 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: false | String |
state | ValueBindingExpression pointing to a object to save the component's state.Type: org.apache.myfaces.tobago.model.TreeState | String |
value | The current value of this component.Type: java.lang.Object | 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.String | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
treeExpansionListener | Method binding representing a expansionListener method that .... | String |
treeMarkedListener | Method 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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
converter | An 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.Converter | String |
converterMessage | An expression that specifies the converter messageType: java.lang.String | String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
required | Flag indicating that a value is required. If the value is an empty string a ValidationError occurs and a Error Message is rendered.Type: booleanDefault: false | String |
requiredMessage | An expression that specifies the required messageType: java.lang.String | String |
showCheckbox | Show a checkbox to visualize the selection state.Type: booleanDefault: true | String |
tip | Text value to display as tooltip.Type: java.lang.String | String |
validatorMessage | An expression that specifies the validator messageType: java.lang.String | String |
value | The current value of this component.Type: java.lang.Object | String |
valueChangeListener | MethodBinding 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
<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
<tc:wizard>
Renders a flexible wizard.UIComponentClass: org.apache.myfaces.tobago.component.UIWizard
RendererType: Wizard
Can contain: JSP
Attributes
Name | Description | Type |
---|---|---|
allowJumpForward | Is a jump forward to following pages allowed?Type: booleanDefault: false | String |
binding | The 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:
| String |
controller* | Type: org.apache.myfaces.tobago.model.Wizard | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
outcome* | Outcome to navigate to this page.Type: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
title | Title of this pageType: java.lang.String | String |
var* | Name of a request-scope attribute under which the model data will be exposed.Type: java.lang.String | String |
<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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
markup | Indicate 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.Markup | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
scrollbars | possible values are:
| String |
spanX | Count of layout columns to span over.Type: java.lang.IntegerDefault: 1 | String |
spanY | Count of layout rows to span over.Type: java.lang.IntegerDefault: 1 | String |
<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
Name | Description | Type |
---|---|---|
action | Action 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 |
actionListener | MethodBinding 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 |
binding | The 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:
| String |
disabled | Flag indicating that this element is disabled.Type: booleanDefault: false | String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
image | Url to an image to display.Type: java.lang.String | String |
immediate | Flag 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: false | String |
jsfResource | Flag 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: false | String |
label | Text value to display as label. If text contains an underscore the next character is used as accesskey.Type: java.lang.String | String |
link | Link 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.String | String |
onclick | Script to be invoked when clickedType: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
renderedPartially | Indicate the partially rendered Components in a case of a submit.Type: java.lang.String[] | String |
resource | Link 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.String | String |
target | Name of a frame where the resource retrieved via this hyperlink is to be displayed.Type: java.lang.String | String |
transition | Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.Type: booleanDefault: true | 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: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
Name | Description | Type |
---|---|---|
binding | The 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:
| String |
id | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.Type: java.lang.String | String |
rendered | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: booleanDefault: true | String |
value | The current value of this component.Type: java.lang.Object | 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.String | String |