Tobago Components


Standard Syntax:
     <%@ taglib prefix="tc" uri="http://myfaces.apache.org/tobago/component" %>

XML Syntax:
     <anyxmlelement xmlns:tc="http://myfaces.apache.org/tobago/component" />

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

Tag Library Information
Display NameTobago Components
Version1.0
Short Nametc
URIhttp://myfaces.apache.org/tobago/component
 

Tag Summary
attribute

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

validateFileItem

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

include

**** Deprecated. Will be removed in a future version ****

converter

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

style

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

validateSubmittedValueLength

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

script

This tag add client side script to the rendered page.

forEach

**** Deprecated. Will be removed in a future version ****

Replacement for the JSTL tag.
This tags iterates over the body content without setting up an exported scope variable, but replaces all occurrence's of var in TobagoTag's ValueBinding attributes.
All non TobagoTags are treated as they are, no replacement is done, and so no ability to use the var in el.

tabChangeListener

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

popupReference

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

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.

menuBar

UIComponentClass: javax.faces.component.UIPanel

RendererType: MenuBar

button

Renders a button element.

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

RendererType: Button

menu

Container component to hold submenus and items.

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

RendererType:

menuCheckbox

Renders a checkable menuitem.

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

RendererType: MenuCommand

selectOneListbox

Render a single selection option listbox.

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

RendererType: SelectOneListbox

Supports following facets:

Name: click Description: This facet can contain a UICommandthat is invoked in a case of a click event from the component

Name: change Description: This facet can contain a UICommand that is invoked in a case of a chang events from the component

selectOneChoice

Render a single selection dropdown list.

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

RendererType: SelectOneChoice

Supports following facets:

Name: click Description: This facet can contain a UICommandthat is invoked in a case of a click event from the component

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

object

UIComponentClass: javax.faces.component.UIOutput

RendererType: Object

columnSelector

Renders a column with checkboxes to mark selected row's.

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

RendererType: ColumnSelector

progress

Renders a progressbar.

UIComponentClass: javax.faces.component.UIOutput

RendererType: Progress

Supports following facets:

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

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

Supports following facets:

Name: reload Description: Contains an instance of UIReload

Name: layout Description: Contains an instance of UILayout

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:

selectReference

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

UIComponentClass: javax.faces.component.UIOutput

RendererType: SelectReference

menuradio

**** Deprecated. Will be removed in a future version ****

Renders a submenu with select one items.

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

RendererType: MenuCommand

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

form

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

RendererType: Form

image

Renders a Image.

UIComponentClass: javax.faces.component.UIGraphic

RendererType: Image

column

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

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

RendererType:

tab

Renders a tab within a tabgroup.

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

RendererType: Tab

selectBooleanCheckbox

Renders a checkbox.

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

RendererType: SelectBooleanCheckbox

page

TODO description of page tag

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

RendererType: Page

Supports following facets:

Name: action Description: Contains an instance of UICommand (tc:command) for an auto-action

Name: menuBar Description: Menubar

Name: layout Description: Contains an instance of UILayout

messages

Renders error/validation messages.

UIComponentClass: javax.faces.component.UIMessages

RendererType: Messages

in

Renders a text input field.

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

RendererType: In

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

menuSeparator

Renders a separator.

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

RendererType:

toolBarCheck

Renders a selectable command button within a toolbar.

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

RendererType: MenuCommand

out

Renders a text

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

RendererType: Out

cell

Renders a layout cell. A panel with ability to span over more than one layout cells.

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

RendererType: Panel

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

tabGroup

Renders a tabpanel.

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

RendererType: TabGroup

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

selectManyCheckbox

Render a group of checkboxes.

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

RendererType: SelectManyCheckbox

reload

Update the parent component

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

RendererType:

tree

**** Deprecated. Will be removed in a future version ****

Renders a tree view.

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

RendererType: TreeOld

selectManyListbox

Render a multi selection option listbox.

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

RendererType: SelectManyListbox

menuItem

Renders a menu item.

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

RendererType: MenuCommand

time

Renders a time input field.

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

RendererType: Time

textarea

Renders a multiline text input control.

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

RendererType: TextArea

selectItems

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

UIComponentClass: javax.faces.component.UISelectItems

RendererType:

hidden

Renders a 'hidden' input element.

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

RendererType: Hidden

date

Renders a date input field.

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

RendererType: Date

menuRadio

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

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

RendererType: MenuCommand

sheet

Render a sheet element.

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

RendererType: Sheet

Supports following facets:

Name: reload Description: Contains an instance of UIReload

selectOneRadio

Render a set of radiobuttons.

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

RendererType: SelectOneRadio

Supports following facets:

Name: click Description: This facet can contain a UICommandthat is invoked in a case of a click event from the component

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

popup

Renders a popup panel.

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

RendererType: Popup

calendar

Renders a calendar.

UIComponentClass: javax.faces.component.UIOutput

RendererType: Calendar

menucheck

**** Deprecated. Will be removed in a future version ****

Renders a checkable menuitem.

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

RendererType: MenuCommand

message

Renders error/validation message.

UIComponentClass: javax.faces.component.UIMessage

RendererType: Message

gridLayout

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

RendererType: GridLayout

toolBarSelectOne

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

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

RendererType: MenuCommand

treeListbox

**** Preliminary. Maybe subject to changed in a future version: Implement a var attribute for the tree like in the sheet (http://issues.apache.org/jira/browse/TOBAGO-18) ****

Renders a listbox view of a tree.

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

RendererType: TreeListbox

label

Renders a label component.

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

RendererType: Label

toolBarCommand

Renders a command button within a toolbar.

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

RendererType: Button

link

Renders a link element.

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

RendererType: Link

box

Renders a panel with border and title.

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

RendererType: Box

Supports following facets:

Name: toolBar Description: Contains an instance of UIToolBar

Name: layout Description: Contains an instance of UILayout

 

Listeners
org.apache.myfaces.tobago.webapp.TobagoServletContextListener
 


Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-3 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.