Tobago
Documentation
Parent Project
Project Documentation
Foundation

Tag reference sheet

Tag library reference for the following tag libraries:

Tobago Components

Tobago Framework Component Tag Library - (C) Copyright 2005-2008 The Apache Software Foundation

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
  • cell Renders a panel-like layout element with the ability to span over more than one layout cell
  • 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
  • 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 TODO description of page tagUIComponentClass: org
  • 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
  • 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
  • treeListbox **** Preliminary
  • 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
  • message **** @deprecated
  • treeOld **** @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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
height

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

The height for this component. 		String
width

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

The width for this component. 		String

<tc:button>

Renders a button element.

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

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. String
defaultCommand If true the command is excuted as default -- for example if the user presses the enter key inside a related input field. String
disabled Flag indicating that this element is disabled. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
image Url to an image to display. 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. String
inline Flag indicating this component should rendered as an inline element. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
link Link to an arbitrary URL String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onclick Script to be invoked when clicked String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
renderedPartially Indicate the partially rendered Components in a case of a submit. String
tabIndex null String
target Name of a frame where the resource retrieved via this hyperlink is to be displayed. String
tip Text value to display as tooltip. String
transition Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior. String
accessKey

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

Deprecated! Has not longer any function. 		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'. 		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. 		String
width

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

The width for this component. 		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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
value The current value of this component. String

<tc:cell>

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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
scrollbars possible values are:
  • 'false' : no scrollbars should be rendered
  • 'true' : scrollbars should always be rendered
  • 'auto' : scrollbars should be rendered when needed
 String
spanX Count of layout columns to span over. String
spanY Count of layout rows to span over. 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. String
binding The value binding expression linking this component to a property in a backing bean. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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[] . String
tip Text value to display as tooltip. String
width The layout token for this column. Allowd layout tokens ('*', '<x>*', '<x>px' or '<x>%'). Where '*' is equvalent to '1*'. 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. String
event null String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. 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. String
disabled Flag indicating that this element is disabled. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. 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. String
link Link to an arbitrary URL String
onclick Script to be invoked when clicked String
renderedPartially Indicate the partially rendered Components in a case of a submit. String
transition Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior. String
value The current value of this component. String

<tc:converter>

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

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

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. 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
focus Flag indicating this component should recieve the focus. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onchange Clientside script function to add to this component's onchange handler. String
readonly Flag indicating that this component will prohibit changes by the user. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message String
tabIndex null String
tip Text value to display as tooltip. 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 message String
value The current value of this component. 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. 		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'. 		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. String
tabIndex null 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
onchange Clientside script function to add to this component's onchange handler. String
readonly Flag indicating that this component will prohibit changes by the user. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message String
tabIndex null String
tip Text value to display as tooltip. 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 message String
value Value binding expression pointing to a org.apache.commons.fileupload.FileItem property to store the uploaded file. 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. 		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'. 		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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. 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. String
border Border size of this component. String
cellspacing Spacing between component and layout cell's String
columns LayoutConstraints for column layout. Semicolon separated list of layout tokens ('*', '<x>*', '<x>px' or '<x>%'). Where '*' is equvalent to '1*'. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
margin Margin between container component and layouted children. String
marginBottom Bottom margin between container component and layouted children. String
marginLeft Left margin between container component and layouted children. String
marginRight Right margin between container component and layouted children. String
marginTop Top margin between container component and layouted children. String
rows LayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px', '<x>%' or 'fixed'). 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. 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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. 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. String

<tc:image>

Renders a Image.

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

RendererType: Image

Can contain: JSP

Attributes

Name Description Type
alt Alternate textual description of the image rendered by this component. String
binding The value binding expression linking this component to a property in a backing bean. String
border Border size of this component. String
height The height for this component. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
tip Text value to display as tooltip. String
value* Absolute url to an image or image name to lookup in tobago resource path String
width The width for this component. 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. 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
focus Flag indicating this component should recieve the focus. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onchange Clientside script function to add to this component's onchange handler. String
password Flag indicating whether or not this component should be rendered as password field , so you will not see the typed charakters. String
readonly Flag indicating that this component will prohibit changes by the user. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message 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 null String
tip Text value to display as tooltip. 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 message String
value The current value of this component. 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. 		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'. 		String
width

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

The width for this component. 		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. String
for Id of the component, this is related to. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
tip Text value to display as tooltip. String
value Text value to display as label. Overwritten by 'labelWithAccessKey' String
accessKey

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

Deprecated! Has not longer any function. 		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'. 		String
width

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

The width for this component. 		String

<tc:link>

Renders a link element.

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

RendererType: Link

Supported facets:

confirmation Contains a UIOutput instance with the confirmation message.

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. String
disabled Flag indicating that this element is disabled. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
image Url to an image to display. 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. String
inline Flag indicating this component should rendered as an inline element. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
link Link to an arbitrary URL String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onclick Script to be invoked when clicked String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
renderedPartially Indicate the partially rendered Components in a case of a submit. String
tabIndex null String
target Name of a frame where the resource retrieved via this hyperlink is to be displayed. String
tip Text value to display as tooltip. String
transition Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior. String
accessKey

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

Deprecated! Has not longer any function. 		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'. 		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. 		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. String
disabled Flag indicating that this element is disabled. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
image Url to an image to display. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
accessKey

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

Deprecated! Has not longer any function. 		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'. 		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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
width

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

The width for this component. 		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. String
disabled Flag indicating that this element is disabled. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. 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. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
link Link to an arbitrary URL String
onclick Script to be invoked when clicked String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
renderedPartially Indicate the partially rendered Components in a case of a submit. String
transition Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior. String
value The current value of this component. String
accessKey

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

Deprecated! Has not longer any function. 		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'. 		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. 		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. String
disabled Flag indicating that this element is disabled. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
image Url to an image to display. 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. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
link Link to an arbitrary URL String
onclick Script to be invoked when clicked String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
renderedPartially Indicate the partially rendered Components in a case of a submit. String
target Name of a frame where the resource retrieved via this hyperlink is to be displayed. String
transition Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior. String
accessKey

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

Deprecated! Has not longer any function. 		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'. 		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. 		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. String
disabled Flag indicating that this element is disabled. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. 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. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
link Link to an arbitrary URL String
onclick Script to be invoked when clicked String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
renderedPartially Indicate the partially rendered Components in a case of a submit. String
transition Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior. String
value The current value of this component. 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. 		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. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
for Id of the component, this is related to. String
globalOnly Flag indicating that only messages that are not associated to any particular UIComponent should be displayed. That are messages without clientId. The default is "false". String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
maxNumber Sets the maximum number of messages to show. The default is 2147483647 (more or less unlimited). 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. The default is "fatal". String
minSeverity Sets the mininum severity to be shown. E. g. "warn" shows only "warn", "error" and "fatal". The default is "info". String
orderBy Sets the order of the messages. The 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. String
showDetail Flag indicating whether the detail should be included The default is "false". String
showSummary Flag indicating whether the summary should be included The default is "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. String
src URI to object source String

<tc:out>

Renders a text

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

RendererType: Out

Can contain: JSP

Attributes

Name Description Type
binding The value binding expression linking this component to a property in a backing bean. 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. String
escape Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
markup Indicate markup of this component. Possible values are 'none', 'strong' and 'deleted' String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
tip Text value to display as tooltip. String
value The current value of this component. String

<tc:page>

TODO description of page tag

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

RendererType: Page

Supported facets:

action Contains an instance of UICommand (tc:command) for an auto-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. String
binding The value binding expression linking this component to a property in a backing bean. String
doctype Possible values for doctype are: strictHTML 4.01 Strict DTD looseHTML 4.01 Transitional DTD framesetHTML 4.01 Frameset DTD All other values are ignored and no DOCTYPE is set. The default value is 'loose'. 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. String
height null String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
state ValueBindingExpression pointing to a object to save the component's state. String
width null 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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
height

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

The height for this component. 		String
width

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

The width for this component. 		String

<tc:popup>

Renders a popup panel.

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

RendererType: Popup

Can contain: JSP

Attributes

Name Description Type
height The height for this component. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
left null String
modal null String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
top null String
width The width for this component. String

<tc:popupReference>

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

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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
tip Text value to display as tooltip. String
value The current value of this component. 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. String
frequency Time in milliseconds after which the parent component is automaticaly reloaded. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. 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. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
update Is update required. 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. String
file null String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
onexit null String
onload null String
onsubmit null String
onunload null String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
script null 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. 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
focus Flag indicating this component should recieve the focus. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onchange Clientside script function to add to this component's onchange handler. String
readonly Flag indicating that this component will prohibit changes by the user. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message String
tabIndex null String
tip Text value to display as tooltip. 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 message String
value The current value of this component. 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. 		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'. 		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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
itemDescription Flag indicating whether the option created by this component is disabled. String
itemDisabled Flag indicating whether the option created by this component is disabled. String
itemImage Image to be displayed to the user for this option. String
itemLabel Label to be displayed to the user for this option. String
itemValue Value to be returned to the server if this option is selected by the user. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
value Value binding expression pointing at a SelectItem instance containing the information for this option. 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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
value Value binding expression pointing at a List or array of SelectItem instances containing the information for this option. 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. 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
focus Flag indicating this component should recieve the focus. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onchange Clientside script function to add to this component's onchange handler. String
readonly Flag indicating that this component will prohibit changes by the user. String
renderRange Range of items to render. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message String
tabIndex null 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 message String
value The current value of this component. 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. 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
focus Flag indicating this component should recieve the focus. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onchange Clientside script function to add to this component's onchange handler. String
readonly Flag indicating that this component will prohibit changes by the user. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message String
tabIndex null String
tip Text value to display as tooltip. 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 message String
value The current value of this component. 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. 		String
height

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

The height for this component. 		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'. 		String

<tc:selectOneChoice>

Render a single selection dropdown list.

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

RendererType: SelectOneChoice

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. 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
focus Flag indicating this component should recieve the focus. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onchange Clientside script function to add to this component's onchange handler. String
readonly Flag indicating that this component will prohibit changes by the user. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message String
tabIndex null String
tip Text value to display as tooltip. 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 message String
value The current value of this component. 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. 		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'. 		String

<tc:selectOneListbox>

Render a single selection option listbox.

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

RendererType: SelectOneListbox

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. 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
focus Flag indicating this component should recieve the focus. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onchange Clientside script function to add to this component's onchange handler. String
readonly Flag indicating that this component will prohibit changes by the user. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message String
tabIndex null String
tip Text value to display as tooltip. 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 message String
value The current value of this component. 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. 		String
height

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

The height for this component. 		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'. 		String

<tc:selectOneRadio>

Render a set of radiobuttons.

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

RendererType: SelectOneRadio

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. 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. String
converterMessage An expression that specifies the converter message String
disabled Flag indicating that this element is disabled. String
focus Flag indicating this component should recieve the focus. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
inline Flag indicating this component should rendered as an inline element. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
onchange Clientside script function to add to this component's onchange handler. String
readonly Flag indicating that this component will prohibit changes by the user. String
renderRange Range of items to render. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
requiredMessage An expression that specifies the required message String
tabIndex null 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 message String
value The current value of this component. 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. String
for* Id of the component, this is related to. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
renderRange* Range of items to render. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. 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. String
columns LayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%'). String
directLinkCount The count of rendered direct paging links in the sheet's footer. The default is 9. String
first Zero-relative row number of the first row to be displayed. 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,
                this is the default.
      'true'  : space for scroolbar is reserved.
      'false' : no space is reserved.
String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
rows The number of rows to display, starting with the one identified by the "pageingStart/first" property. String
selectable Flag indicating whether or not the sheet should be selectable Valid values are none , single , and multi . The default is 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 . The default is none . String
showHeader Flag indicating the header should be rendered. 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 . The default is 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 . The default is 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. 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. 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. 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. 		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. 		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. String
file Name of the stylesheet file to add to page. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
style stylesheet to add to page. 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. String
disabled Flag indicating that this element is disabled. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. String
label Text value to display as label. If text contains an underscore the next character is used as accesskey. String
markup Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
tip Text value to display as tooltip. String
accessKey

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

Deprecated! Has not longer any function. 		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'. 		String

<tc:tabChangeListener>

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

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. String
id The component identifier for this component. This value must be unique within the closest parent component that is a naming container. 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. String
rendered Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. String
renderedIndex null String
selectedIndex ValueBindingExpression pointing to a Integer to save the component's selected Tab. String
switchType Flag indicating how tab switching should be d