tc


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

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

No Description

Tag Library Information
Display NameNone
Version1.2
Short Nametc
URIhttp://myfaces.apache.org/tobago/component
 

Tag Summary
attributeAdd an attribute on the UIComponent associated with the closest parent UIComponent custom action.
boxRenders a panel with border and title.

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

RendererType: Box

Supported facets:

toolBar
Contains an instance of UIToolBar
layout
Contains an instance of AbstractUILayoutBase
buttonRenders a button element.

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

RendererType: Button

Supported facets:

confirmation
Contains a UIOutput instance with the confirmation message.
popup
Contains a UIPopup instance.
calendarRenders a calendar.

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

RendererType: Calendar

cell

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

The Cell is deprecated since Tobago 1.5.0

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

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

RendererType: Cell

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

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

RendererType:

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

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

RendererType: TreeNode

columnSelectorRenders a column with checkboxes to mark selected rows.

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

RendererType: ColumnSelector

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

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

RendererType: Column

Supported facets:

dropDownMenu
Contains a UIMenu instance to render a drop down menu.
commandUse this tag only as a facet for click, change in selectOneRadio, selectBooleanCheckbox, selectManyCheckbox and selectOneChoice

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

RendererType: Command

converterRegister an Converter instance on the UIComponent associated with the closest parent UIComponent.
dataAttribute

**** Preliminary. Maybe subject to changed in a future version ****

Add an data attribute on the UIComponent associated with the closest parent UIComponent custom action. Data attributes will be passed through the renderers into the DOM of the user agent and can be used by scripts.
datePicker

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

Since 2.0.0. It's no longer needed, because this is resolved by JavaScript now. Set backward compatibility mode via classic-date-time-picker.

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

dateRenders a date input field.

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

RendererType: Date

Supported facets:

change
This facet can contain a UICommand that is invoked in a case of a change event from the component
fileRenders a file input field. You need to define an org.apache.myfaces.tobago.webapp.TobagoMultipartFormdataFilter in your web.xml or add the tobago-fileupload.jar to your project. The tobago-fileupload.jar contains a FacesContextFactory that wraps the multipart-formdata request inside the facesContext.

For content constraints please use tc:validateFileItem.

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

RendererType: File

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

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

RendererType: FlowLayout

form

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

RendererType: Form

gridLayoutConstraintAdd GridLayoutConstraints to the parent UIComponent.
gridLayoutRenders a GridLayout.
 columns/rows ::= LAYOUT
 LAYOUT       ::= TOKEN [";" TOKEN]+
 TOKEN        ::= AUTO | PIXEL | PROPORTIONAL
 AUTO         ::= "auto" | "fixed"
 PIXEL        ::= NUMBER "px"
 PROPORTIONAL ::= [NUMBER] "*"
 

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

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

RendererType: GridLayout

hiddenRenders a hidden input element.

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

RendererType: Hidden

imageRenders an image.

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

RendererType: Image

inRenders a text input field.

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

RendererType: In

Supported facets:

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

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

RendererType: Label

linkRenders a link element.

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

RendererType: Link

Supported facets:

confirmation
Contains a UIOutput instance with the confirmation message.
popup
Contains a UIPopup instance.
loadBundleLoad a resource bundle localized for the locale of the current view from the tobago resource path, and expose it (as a Map) in the session attributes (session scope is needed to support ajax requests).

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

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

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

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

RendererType: Mediator

menuBarRenders 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

menuCommandRenders a menu item. (This tag was renamed from tc:menuItem since Tobago 1.5.0)

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

RendererType: MenuCommand

menuSeparatorRenders a separator inside of a menu.

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

RendererType: MenuSeparator

menuContainer component to hold submenus and items.

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

RendererType: Menu

messagesRenders error/validation messages.

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

RendererType: Messages

objectShow external content inside of an application. This will typically renders an iframe tag.

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

RendererType: Object

outRenders a text

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

RendererType: Out

pageRenders a page element.

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

RendererType: Page

Supported facets:

action
Contains an instance of UICommand (tc:command) for an auto-action
resize
Contains an instance of UICommand which will be executed when thesize of the user agent was changed. Typically a
menuBar
Menubar
layout
Contains an instance of AbstractUILayoutBase
panelIntended 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 UIReload
layout
Contains an instance of AbstractUILayoutBase
popupReferenceRegister an PopupActionListener instance on the UIComponent associated with the closest parent UIComponent.
popupRenders a popup panel. The popup gets a grid layout manager with columns="auto" and rows="auto" as definition. So a popup should contain only one layout component. The default layout manager can be overwritten with the layout facet.

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

RendererType: Popup

Supported facets:

layout
Contains an instance of AbstractUILayoutBase
progressRenders a progress bar.

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
reloadUpdate the parent component

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

RendererType:

resetInputActionListenerA ResetInputActionListener is a declarative way to allow an action source to reset all EditableValueHolder of a page or in a sub-form or part of the component tree.
scriptThis tag adds script files to include into the rendered page.

Deprecated (because of CSP): This tag adds client side script to the rendered page.

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

RendererType: Script

selectBooleanCheckboxRenders a checkbox.

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

RendererType: SelectBooleanCheckbox

Supported facets:

click
This facet can contain a UICommand that is invoked in case of a click event from the component
change
This facet can contain a UICommand that is invoked in case of a change event from the component
selectItemAdd a child UISelectItem component to the UIComponent associated with the closed parent UIComponent custom action.

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

RendererType:

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

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

RendererType:

selectManyCheckboxRender a group of checkboxes.

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

RendererType: SelectManyCheckbox

selectManyListboxRender a multi selection option listbox.

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

RendererType: SelectManyListbox

selectManyShuttle

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

RendererType: SelectManyShuttle

selectOneChoiceRender 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 component
change
This facet can contain a UICommand that is invoked in case of a change event from the component
selectOneListboxRender 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 component
change
This facet can contain a UICommand that is invoked in case of a change event from the component
selectOneRadioRender a set of radio buttons.

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 component
change
This facet can contain a UICommand that is invoked in case of a change event from the component
selectReferenceRenders a set of option related to and same type as the for component.

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

RendererType: SelectReference

separatorRenders a separator.

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

RendererType: Separator

Supported facets:

label
This facet contains a UILabel
sheetLayoutCreates a SheetLayout, which is a internal layout manager of a sheet.

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

RendererType: SheetLayout

sheetRender a sheet element.

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

RendererType: Sheet

Supported facets:

reload
Contains an instance of UIReload
styleAdd a style tag with the given file name.

Remark: Inline styles are deprecated because of CSP.

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

RendererType: Style

suggestRenders a list of suggested texts for a given input field. Basic features:
  • provide a list directly while rendering (not AJAX needed) [todo]
  • update by typing (AJAX)
  • minimum number of typed characters (to avoid useless requests)
  • update delay (useful for optimization)
  • filter on client side (useful for optimization) [todo]

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

RendererType: Suggest

tabChangeListenerRegister an TabChangedListener instance on the UIComponent associated with the closest parent UIComponent custom action.
tabGroupLayoutCreates a TabGroupLayout, which is a internal layout manager of a tabGroup.

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

RendererType: TabGroupLayout

tabGroupRenders a tab group which contains tab panels.

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

RendererType: TabGroup

tabRenders a tab within a tab group.

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

RendererType: Tab

Supported facets:

toolBar
Contains an instance of UIToolBar
textareaRenders a multi line text input control.

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

RendererType: Textarea

timeRenders a time input field.

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

RendererType: Time

toolBarCommandRenders a command button within a toolbar.

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

RendererType: Button

Supported facets:

confirmation
Contains a UIOutput instance with the confirmation message.
popup
Contains a UIPopup instance.
dropDownMenu
Contains a UIMenu instance to render a drop down menu.
toolBarCheckRenders a selectable command button within a toolbar.

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

RendererType: MenuCommand

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

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

RendererType: MenuCommand

toolBarSeparatorRenders a separator inside of a tool bar.

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

RendererType: MenuSeparator

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 drop down menu to a button add a facet 'dropDownMenu' 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="dropDownMenu">
          <tc:menu>
            <tc:menuCommand onclick="alert('test 1')" label="Alert 1"/>
            <tc:menuCommand onclick="alert('test 2')" label="Alert 2"/>
            <tc:menuCommand onclick="alert('test 3')" label="Alert 3"/>
          </tc:menu>
        </f:facet>
      </tc:button>
      

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

RendererType: ToolBar

treeCommandRenders a command inside of a tree.

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

RendererType: TreeCommand

Supported facets:

confirmation
Contains a UIOutput instance with the confirmation message.
popup
Contains a UIPopup instance.
treeData

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

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

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

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

RendererType: TreeData

treeIconRenders an image beside a tree node.

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

RendererType: TreeIcon

treeIndentRenders an indent beside a tree node.

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

RendererType: TreeIndent

treeLabelRenders a label inside of a tree.

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

RendererType: TreeLabel

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

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

RendererType: TreeListbox

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

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

RendererType: TreeMenu

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

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

RendererType: TreeNode

treeSelectMakes a tree node selectable.

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

RendererType: TreeSelect

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

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

RendererType: Tree

validateFileItemRegister an FileItemValidator instance on the UIComponent associated with the closest parent UIComponent custom action.
validateSubmittedValueLengthRegister an SubmittedValueLengthValidator instance on the UIComponent associated with the closest parent UIComponent custom action. The standard LengthValidator validate the length on the converted value.toString() not on the submitted value. Sometime you need to check the length of the submitted value.
wizardRenders a flexible wizard.

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

RendererType: Wizard

 

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


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.