Tobago

Documentation

Parent Project

Apache Tobago

Project Documentation

Foundation

Tag reference sheet

Tag library reference for the following tag libraries:

Tobago Components (tobago.tld) - uri: http://myfaces.apache.org/tobago/component

Tobago Components

This is version 1.0.

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 UIData component
columnEvent UIComponentClass: org
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
form UIComponentClass: org
gridLayout Renders a GridLayout
gridLayoutConstraint Register an PopupActionListener instance on the UIComponent associated with the closest parent UIComponent
hidden Renders a 'hidden' input element
image Renders a 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 request attributes of the current request
menu Container component to hold submenus and items
menuBar Renders a menu bar
menuCheckbox Renders a checkable menuitem
menuItem Renders a menu item
menuRadio Renders a submenu with select one items (like a radio button)
menuSeparator Renders a separator
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 progressbar
reload Update the parent componentUIComponentClass: org
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
selectOneChoice Render a single selection dropdown list
selectOneListbox Render a single selection option listbox
selectOneRadio Render a set of radiobuttons
selectReference Renders a set of option related to and same type as the for component
separator Renders a separator
sheet Render a sheet element
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 tabpanel
tabGroupLayout Creates a TabGroupLayout, which is a internal layout manager of a tabGroup
textarea Renders a multiline 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
tree Renders a tree view
treeData Describes a subtree of nodes
treeNode Creates a tree node
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
cell **** @deprecated
message **** @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
name*	null	String
value*	null	String

<tc:box>

Renders a panel with border and title.

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

RendererType: Box

Supported facets:

toolBar Contains an instance of UIToolBarlayout Contains an instance of UILayout

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `true`	String

<tc:button>

Renders a button element.

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

RendererType: Button

Supported facets:

confirmation Contains a UIOutput instance with the confirmation message.popup Contains 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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
defaultCommand	If true the command is excuted as default -- for example if the user presses the enter key inside a related input field.Type: `java.lang.Boolean` Default: `false`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `false`	String
inline	Flag indicating this component should rendered as an inline element.Type: `java.lang.Boolean`	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: `java.lang.Boolean` Default: `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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean` Default: `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: `java.lang.Boolean` Default: `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
type	** @deprecated. Will be removed in a future version ** Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.Type: `java.lang.String` Default: `submit`	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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `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 UIData component.

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

RendererType:

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.Type: `javax.faces.component.UIComponent`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `java.lang.Boolean` Default: `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>

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.Type: `javax.faces.component.UIComponent`	String
event	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: `boolean` Default: `true`	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `true`	String

<tc:command>

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

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

RendererType: Command

Can contain: JSP

Attributes

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 Navigationhandler.	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: `boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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
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: `java.lang.Boolean` Default: `true`	String
value	The current value of this component.Type: `java.lang.Object`	String

<tc:converter>

Can contain: empty

Attributes

Name	Description	Type
binding	The value binding expression to a converter.	String
converterId	The converterId of a registered converter.	String

<tc:date>

Renders a date input field.

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

RendererType: Date

Supported facets:

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

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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: `java.lang.Boolean`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `boolean`	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: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
for	Id of the component, this is related to.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

<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.

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

RendererType: File

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	String
converterMessage	An expression that specifies the converter messageType: `java.lang.String`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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
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: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `boolean`	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: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.Type: `javax.faces.component.UIComponent`	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        ::= FIXED | PIXEL | PROPORTIONAL
 FIXED        ::= "fixed"
 PIXEL        ::= NUMBER "px"
 PROPORTIONAL ::= [NUMBER] "*"

Parent	Child	Okay?	Remarks
FIXED	any combination of FIXED or PIXEL but no PROPORTIONAL	okay	-
FIXED	any combination with at least one PROPORTIONAL	wrong	LayoutManager cannot compute the fixed value.
PIXEL	any combination of FIXED 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 FIXED or PIXEL but no PROPORTIONAL	potentially wrong	No automatical matching: too little space: scrollbar too much space: elements will be spreaded.
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.Type: `javax.faces.component.UIComponent`	String
border	Border size of this component.Type: `java.lang.String`	String
columnSpacing	Spacing between the columns in the actual layout.Type: `org.apache.myfaces.tobago.layout.Measure`	String
columns	LayoutConstraints for column layout. Semicolon separated list of layout tokens ('', '<x>', '<x>px' or '<x>%'). Where '' is equvalent to '1'.Type: `java.lang.String` Default: `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 layouted children.Type: `java.lang.String`	String
marginBottom	Bottom margin between container component and layouted children.Type: `java.lang.String`	String
marginLeft	Left margin between container component and layouted children.Type: `java.lang.String`	String
marginRight	Right margin between container component and layouted children.Type: `java.lang.String`	String
marginTop	Top margin between container component and layouted children.Type: `java.lang.String`	String
rowSpacing	Spacing between the rows in the actual layout.Type: `org.apache.myfaces.tobago.layout.Measure`	String
rows	LayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>', '<x>px', '<x>%' or 'fixed').Type: `java.lang.String` Default: `1`	String
cellspacing	** @deprecated. Will be removed in a future version ** Spacing between component and layout cell's. Can be overwritten by columnSpacing and rowSpacing.Type: `org.apache.myfaces.tobago.layout.Measure`	String

<tc:gridLayoutConstraint>

Can contain: empty

Attributes

Name	Description	Type
columnSpan	null	String
height	Type: `org.apache.myfaces.tobago.layout.Measure`	String
maximumHeight	Type: `org.apache.myfaces.tobago.layout.Measure`	String
maximumWidth	Type: `org.apache.myfaces.tobago.layout.Measure`	String
minimumHeight	Type: `org.apache.myfaces.tobago.layout.Measure`	String
minimumWidth	Type: `org.apache.myfaces.tobago.layout.Measure`	String
preferredHeight	Type: `org.apache.myfaces.tobago.layout.Measure`	String
preferredWidth	Type: `org.apache.myfaces.tobago.layout.Measure`	String
rowSpan	null	String
width	Type: `org.apache.myfaces.tobago.layout.Measure`	String

<tc:hidden>

Renders a 'hidden' input element.

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

RendererType: Hidden

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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
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
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 a 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.Type: `javax.faces.component.UIComponent`	String
border	Border size of this component.Type: `java.lang.String`	String
height	This value will usually be set by the layout manager.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
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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	This value will usually be set by the layout manager.Type: `org.apache.myfaces.tobago.layout.Measure`	String

<tc:in>

Renders a text input field.

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

RendererType: In

Supported facets:

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

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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: `java.lang.Boolean`	String
markup	Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `java.lang.Boolean` Default: `false`	String
readonly	Flag indicating that this component will prohibit changes by the user.Type: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `boolean`	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 a passed prefix -- the currently entered text. The expression has to evaluate to a public method which has a String parameter and a List<String> as return type.	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: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.Type: `javax.faces.component.UIComponent`	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
inline	Flag indicating this component should rendered as an inline element.Type: `java.lang.Boolean`	String
markup	Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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
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:

confirmation Contains a UIOutput instance with the confirmation message.popup Contains 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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `false`	String
inline	Flag indicating this component should rendered as an inline element.Type: `java.lang.Boolean`	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: `java.lang.Boolean` Default: `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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean` Default: `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: `java.lang.Boolean` Default: `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
type	** @deprecated. Will be removed in a future version ** Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.Type: `java.lang.String` Default: `submit`	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 request attributes of the current request.

Can contain: empty

Attributes

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

<tc:menu>

Container component to hold submenus and items.

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

RendererType:

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `true`	String

<tc:menuCheckbox>

Renders a checkable menuitem.

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

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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `true`	String
value	The current value of this component.Type: `java.lang.Boolean`	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
type	** @deprecated. Will be removed in a future version ** Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.Type: `java.lang.String` Default: `submit`	String

<tc:menuItem>

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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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
type	** @deprecated. Will be removed in a future version ** Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.Type: `java.lang.String` Default: `submit`	String

<tc:menuRadio>

Renders a submenu with select one items (like a radio button).

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

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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `true`	String
value	The current value of this component.Type: `java.lang.Object`	String
type	** @deprecated. Will be removed in a future version ** Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.Type: `java.lang.String` Default: `submit`	String

<tc:menuSeparator>

Renders a separator.

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

RendererType:

Can contain: empty

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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.Type: `javax.faces.component.UIComponent`	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: `java.lang.Boolean` Default: `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.String` Default: `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
maxNumber	Sets the maximum number of messages to show.Type: `java.lang.Integer` Default: `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$Severity` Default: `fatal`	String
minSeverity	Sets the mininum severity to be shown. E. g. "warn" shows only "warn", "error" and "fatal".Type: `javax.faces.application.FacesMessage$Severity` Default: `info`	String
orderBy	Sets the order of the messages.Type: `org.apache.myfaces.tobago.component.UIMessages$OrderBy` Default: `occurence`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `true`	String
showDetail	Flag indicating whether the detail should be includedType: `java.lang.Boolean` Default: `false`	String
showSummary	Flag indicating whether the summary should be includedType: `java.lang.Boolean` Default: `true`	String

<tc:object>

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

RendererType: Object

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
src	URI to object sourceType: `java.lang.String`	String

<tc:out>

Renders a text

UIComponentClass: 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.Type: `javax.faces.component.UIComponent`	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: `java.lang.Boolean` Default: `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
inline	Flag indicating this component should rendered as an inline element.Type: `java.lang.Boolean`	String
markup	Indicate markup of this component. Possible values are 'none', 'strong' and 'deleted'Type: `java.lang.String[]` Default: `none`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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

<tc:page>

Renders a page element.

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

RendererType: Page

Supported facets:

action Contains an instance of UICommand (tc:command) for an auto-actionresizeAction Contains an instance of UICommand (tc:command) or a UIForm (tc:form) with a UICommand for a resize-actionmenuBar Menubarlayout Contains an instance of UILayout

Can 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.Type: `javax.faces.component.UIComponent`	String
focusId	Contains the id of the component wich should have the focus after loading the page. Set to emtpy string for disabling setting of focus. Default (null) enables the "auto focus" feature.Type: `java.lang.String`	String
height	This value will usually be set by the layout manager.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
state	ValueBindingExpression pointing to a object to save the component's state.Type: `java.lang.Object`	String
width	This value will usually be set by the layout manager.Type: `org.apache.myfaces.tobago.layout.Measure`	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:

reload Contains an instance of UIReloadlayout Contains an instance of UILayout

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `true`	String

<tc:popup>

Renders a popup panel.

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

RendererType: Popup

Can contain: JSP

Attributes

Name	Description	Type
height	This value will usually be set by the layout manager.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
modal	Type: `java.lang.Boolean` Default: `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: `boolean` Default: `true`	String
width	This value will usually be set by the layout manager.Type: `org.apache.myfaces.tobago.layout.Measure`	String

<tc:popupReference>

Can contain: empty

Attributes

Name	Description	Type
for*	The id of a Popup.	String

<tc:progress>

Renders a progressbar.

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

RendererType: Progress

Supported facets:

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

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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 component

UIComponentClass: 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.Type: `javax.faces.component.UIComponent`	String
frequency	Time in milliseconds after which the parent component is automaticaly reloaded.Type: `java.lang.Integer` Default: `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: `java.lang.Boolean` Default: `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: `boolean` Default: `true`	String
update	Is update required.Type: `java.lang.Boolean` Default: `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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `true`	String
script	Type: `java.lang.String`	String

<tc:selectBooleanCheckbox>

Renders a checkbox.

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

RendererType: SelectBooleanCheckbox

Supported facets:

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

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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: `java.lang.Boolean`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `boolean`	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.Boolean`	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: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.Type: `javax.faces.component.UIComponent`	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	Flag indicating whether the option created by this component is disabled.Type: `java.lang.Boolean` Default: `false`	String
itemDisabled	Flag indicating whether the option created by this component is disabled.Type: `java.lang.Boolean` Default: `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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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.Type: `javax.faces.component.UIComponent`	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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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: `java.lang.Boolean`	String
markup	Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	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: `boolean` Default: `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: `boolean`	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
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: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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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: `java.lang.Boolean`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `boolean`	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:selectOneChoice>

Render a single selection dropdown list.

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

RendererType: SelectOneChoice

Supported facets:

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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: `java.lang.Boolean`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `true`	String
required	Flag indicating that selecting an Item representing a value is required. If an SelectItem was choosen which underling value is an empty string an ValidationError occurs and a Error Message is rendered.Type: `java.lang.Boolean`	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:selectOneListbox>

Render a single selection option listbox.

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

RendererType: SelectOneListbox

Supported facets:

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `true`	String
required	Flag indicating that selecting an Item representing a Value is Required. If an SelectItem was choosen which underling value is an empty string an ValidationError occurs and a Error Message is rendered.Type: `java.lang.Boolean`	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 radiobuttons.

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

RendererType: SelectOneRadio

Supported facets:

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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: `java.lang.Boolean`	String
markup	Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	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: `boolean` Default: `true`	String
required	Flag indicating that selecting an Item representing a Value is Required. If an SelectItem was choosen which underling value is an empty string an ValidationError occurs and a Error Message is rendered.Type: `java.lang.Boolean`	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
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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `true`	String

<tc:separator>

Renders a separator.

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

RendererType: Separator

Supported facets:

label This facet contains a UILabel

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `true`	String

<tc:sheet>

Render a sheet element.

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

RendererType: Sheet

Supported facets:

reload Contains an instance of UIReload

Can contain: JSP

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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.Integer` Default: `9`	String
first	Zero-relative row number of the first row to be displayed.Type: `java.lang.Integer` Default: `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. Type: `java.lang.String` Default: `auto`	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: `boolean` Default: `true`	String
rows	The number of rows to display, starting with the one identified by the "pageingStart/first" property.Type: `java.lang.Integer` Default: `100`	String
selectable	Flag indicating whether or not the sheet should be selectable Valid values are none , single , and multi .Type: `java.lang.String` Default: `multi`	String
showDirectLinks	Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer. Valid values are left , center , right and none .Type: `java.lang.String` Default: `none`	String
showHeader	Flag indicating the header should be rendered.Type: `java.lang.Boolean` Default: `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. Valid values are left , center , right and none .Type: `java.lang.String` Default: `none`	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. Valid values are left , center , right and none .Type: `java.lang.String` Default: `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
pagingLength	** @deprecated. Will be removed in a future version ** Please use "rows" instead. The number of rows to display, starting with the one identified by the "pageingStart" property.Type: `java.lang.Integer` Default: `100`	String
pagingStart	** @deprecated. Will be removed in a future version ** Please use "first" instead. Zero-relative row number of the first row to be displayed.Type: `java.lang.Integer` Default: `0`	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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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>

Can contain: empty

Attributes

Name	Description	Type
binding	The value binding expression to a TabChangeListener.	String
type*	Fully qualified Java class name of a TabChangeListener to be created and registered.	String

<tc:tabGroup>

Renders a tabpanel.

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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `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: `boolean` Default: `true`	String
renderedIndex	Type: `java.lang.Integer` Default: `0`	String
selectedIndex	ValueBindingExpression pointing to a Integer to save the component's selected Tab.Type: `java.lang.Integer` Default: `0`	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.String` Default: `client`	String
tabChangeListener	null	String
serverside	** @deprecated. Will be removed in a future version ** Deprecated! Use 'switchType' instead. Flag indicating that tab switching is done by server request.Type: `java.lang.Boolean` Default: `false`	String
state	** @deprecated. Will be removed in a future version ValueBindingExpression** pointing to a Integer to save the component's selected Tab.Type: `java.lang.Integer`	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

<tc:textarea>

Renders a multiline 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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `boolean`	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.Type: `javax.faces.component.UIComponent`	String
converterMessage	An expression that specifies the converter messageType: `java.lang.String`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `false`	String
focus	Flag indicating this component should recieve the focus.Type: `java.lang.Boolean`	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: `java.lang.Boolean`	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. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `boolean`	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: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:menuItem onclick="alert('test 1')" label="Alert 1"/>
            <tc:menuItem onclick="alert('test 2')" label="Alert 2"/>
            <tc:menuItem 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.Type: `javax.faces.component.UIComponent`	String
iconSize	Size of button images, possible values are: small, big, off.Type: `java.lang.String` Default: `small`	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.String` Default: `bottom`	String
markup	Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	String
orientation	Orientation of toolbarType: `java.lang.String` Default: `left`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `true`	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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `true`	String
value	The current value of this component.Type: `java.lang.Boolean`	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
type	** @deprecated. Will be removed in a future version ** Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.Type: `java.lang.String` Default: `submit`	String

<tc:toolBarCommand>

Renders a command button within a toolbar.

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

RendererType: Button

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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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
type	** @deprecated. Will be removed in a future version ** Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.Type: `java.lang.String` Default: `submit`	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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `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: `boolean` Default: `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: `java.lang.Boolean` Default: `true`	String
value	The current value of this component.Type: `java.lang.Object`	String
type	** @deprecated. Will be removed in a future version ** Type of command component to create. Valid values are 'navigate', 'reset', 'script' or 'submit'. If not specified, or not a valid value, the default value is 'submit' is used.Type: `java.lang.String` Default: `submit`	String

<tc:tree>

Renders a tree view.

Date: 11.02.2006 13:28:14

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.Type: `javax.faces.component.UIComponent`	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
mode	Display option: Normal tree or menu.Type: `java.lang.String` Default: `tree`	String
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `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: `boolean`	String
selectable	Flag indicating whether or not this component should be render selectable items. Possible values are: multi : a multisection tree is rendered single : a singlesection tree is rendered multiLeafOnly : a multisection tree is rendered, only Leaf's are selectable singleLeafOnly : a singlesection tree is rendered, only Leaf's are selectable For any other value or if this attribute is omited the items are not selectable.Type: `java.lang.String` Default: `off`	String
showIcons	Type: `boolean` Default: `false`	String
showJunctions	Type: `boolean` Default: `false`	String
showRoot	Type: `boolean` Default: `false`	String
showRootJunction	Type: `boolean` Default: `false`	String
state	ValueBindingExpression pointing to a object to save the component's state.Type: `java.lang.Object`	String
value	A javax.swing.tree.TreeNode object to use as rootNode in the tree.Type: `javax.swing.tree.TreeNode`	String

<tc:treeData>

Describes a subtree of nodes.

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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `true`	String
value	A javax.swing.tree.TreeNode object to use as rootNode in the tree.Type: `javax.swing.tree.TreeNode`	String
var*	Name of a request-scope attribute under which the model data for for each subobject is accessible.Type: `java.lang.String`	String

<tc:treeNode>

Creates a tree node.

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

RendererType: TreeNode

Supported facets:

addendum Displays an additional component to a node.

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 Navigationhandler.	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.Type: `javax.faces.component.UIComponent`	String
disabled	Flag indicating that this element is disabled.Type: `boolean` Default: `false`	String
expanded	Flag indicating if the subnodes are to be displayed.Type: `java.lang.Boolean`	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: `boolean` Default: `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: `java.lang.Boolean` Default: `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
marked	Flag indicating if the node is marked, and should be displayed in a special way.Type: `java.lang.Boolean` Default: `Boolean.FALSE`	String
markup	Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.Type: `java.lang.String[]` Default: `none`	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: `boolean` Default: `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: `java.lang.Boolean` Default: `true`	String
treeExpansionListener	Method binding representing a expansionListener method that ....	String
value	The current value of this component.Type: `java.lang.Object`	String

<tc:validateFileItem>

Can contain: JSP

Attributes

Name	Description	Type
contentType	null	String
maxSize	null	String

<tc:validateSubmittedValueLength>

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

Can contain: JSP

Attributes

Name	Description	Type
maximum	null	String
minimum	null	String

<tc:cell>

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

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.Type: `javax.faces.component.UIComponent`	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: `boolean` Default: `true`	String
scrollbars	possible values are: 'false' : no scrollbars should be rendered 'true' : scrollbars should always be rendered 'auto' : scrollbars should be rendered when needed Type: `java.lang.String` Default: `false`	String
spanX	Count of layout columns to span over.Type: `java.lang.Integer` Default: `1`	String
spanY	Count of layout rows to span over.Type: `java.lang.Integer` Default: `1`	String

<tc:message>

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

Renders error/validation message.

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

RendererType: Message

Can contain: empty

Attributes

Name	Description	Type
binding	The value binding expression linking this component to a property in a backing bean.Type: `javax.faces.component.UIComponent`	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
rendered	Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.Type: `boolean` Default: `true`	String
showDetail	Flag indicating whether the detail should be included.Type: `java.lang.Boolean` Default: `false`	String
showSummary	Flag indicating whether the summary should be included.Type: `java.lang.Boolean` Default: `true`	String