tc (Tobago Core VDL Documentation)

XML Declaration Syntax:

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

Description:

No Description

Tag Library Information
Info	Value
ID (tag prefix)	`tc`
URI	`http://myfaces.apache.org/tobago/component`

Tag Description

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

bar

Defines a container for navigation elements, branding, ...

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

RendererType: Bar

Supported facets:

brand: Contains an element which will get a 'navbar-brand' style, e.g. use

box

Renders a panel with border and title.

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

RendererType: Box

Supported facets:

bar: Contains some code to be placed in the header at the bar position.
label: Contains some code to be placed in the header at the label position.
layout: Deprecated! Contains an layout manager. The layout manager tag should surround the content instead.

button

Renders a button element.

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

RendererType: Button

Supported facets:

confirmation: Contains a UIOutput instance with the confirmation message.

buttons

Renders a group of buttons.

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

RendererType: Buttons

calendar

Renders a calendar.

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

RendererType: Calendar

columnNode

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

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

RendererType: TreeNode

columnSelector

Renders a column with checkboxes to mark selected rows.

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

RendererType: ColumnSelector

column

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

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

RendererType: Column

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

date

Renders a date input field.

For a time input field set you'll need to set the <f:convertDateTime type="time"> inside the <tc:date>.

If there is no converter given, a default instance of {@link javax.faces.convert.DateTimeConverter} will be used.

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

RendererType: Date

event

Add an event behavior to the component.

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

RendererType: Event

figure

Use figure to show e. g. images or videos inside.

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

RendererType: Figure

Supported facets:

label: Contains some code to be placed in the header at the label position.

file

Renders a file input field.

For content constraints please use tc:validateFileItem.

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

RendererType: File

flexLayout

Renders a flex layout (CSS3 feature).

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

RendererType: FlexLayout

flowLayout

Renders a FlowLayout that positions the content components in there natural order.

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

RendererType: FlowLayout

footer

Defines a footer of its parent (like page, box, ...)

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

RendererType: Footer

form

If an action is preformed, everything within the next parent form belongs to the submit-area. An action could be a button which is pressed. tc:page is a form. Everything in the submit-area is written into the model, even other forms.

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

RendererType: Form

gridLayout

WARNING: This component is preliminary and may be changed without a major release.

Renders a GridLayout.

 columns/rows ::= LAYOUT
 LAYOUT       ::= TOKEN [";" TOKEN]+
 TOKEN        ::= AUTO | PIXEL | PROPORTIONAL
 AUTO         ::= "auto" | "fixed"
 PIXEL        ::= NUMBER "px"
 PROPORTIONAL ::= [NUMBER] "*"

GridLayout
Parent	Child	Okay?	Remarks
AUTO	any combination of AUTO or PIXEL but no PROPORTIONAL	okay	-
AUTO	any combination with at least one PROPORTIONAL	wrong	Layout manager 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

header

Defines a header of its parent (like page, box, ...)

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

RendererType: Header

hidden

Renders a hidden input element.

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

RendererType: Hidden

image

Renders an image.

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

RendererType: Image

Renders a text input field.

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

RendererType: In

Supported facets:

before: This facet can contain a part for input groups.
after: This facet can contain a part for input groups.

label

Renders a label component.

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

RendererType: Label

link

Renders a link element.

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

RendererType: Link

Supported facets:

confirmation: Contains a UIOutput instance with the confirmation message.

links

Defines a navigation element, which contains a menu-like structure

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

RendererType: Links

messages

Renders error/validation messages.

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

RendererType: Messages

object

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

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

RendererType: Object

operation

An operation describes an Tobago command, which will usually executed on client side. ********************* WARNING ********************* This feature is preliminary and may be subject of change in later versions!

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

RendererType: Operation

out

Renders a text

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

RendererType: Out

page

Renders a page element.

The markup {@link org.apache.myfaces.tobago.context.Markup#SPREAD} means the page should spread over the hole available area. So the content will use the full height of the browser window. Warning: This feature is preliminary and may change, if necessary, in minor releases!

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

RendererType: Page

Supported facets:

layout: Deprecated! Contains an layout manager. The layout manager tag should surround the content instead.

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 UIReload
layout: Deprecated. Contains an layout manager. The layout manager tag should surround the content instead.

popup

Renders a popup panel.

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

RendererType: Popup

progress

Renders a progress bar.

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

RendererType: Progress

reload

Update the parent component ********************* WARNING ********************* This feature is preliminary and may be subject of change in later versions!

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

RendererType:

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

row

This component creates a representative in a UISheet for each row. The tag must be a subtag of <tc:sheet>

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

RendererType: Row

script

This tag adds script files to include into the rendered page.
Some features are deprecated (because of CSP): This tag adds client side script to the rendered page.

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

RendererType: Script

section

Renders a section or subsection.

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

RendererType: Section

Supported facets:

label: This facet contains a UILabel

segmentLayout

Renders a layout using a 12 columns grid. Find more information on how the grid works in the Twitter Bootstrap documentation. If no attribute is defined, extraSmall="12" will be used as default.

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

RendererType: SegmentLayout

selectBooleanCheckbox

Renders a checkbox.

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

RendererType: SelectBooleanCheckbox

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:

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:

selectManyCheckbox

Render a group of checkboxes.

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

RendererType: SelectManyCheckbox

selectManyListbox

Render a multi selection option listbox.

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

RendererType: SelectManyListbox

selectManyShuttle

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

RendererType: SelectManyShuttle

selectOneChoice

Render a single selection dropdown list.

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

RendererType: SelectOneChoice

selectOneListbox

Render a single selection option listbox.

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

RendererType: SelectOneListbox

selectOneRadio

Render a set of radio buttons.

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

RendererType: SelectOneRadio

selectReference

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

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

RendererType: SelectReference

separator

Renders a separator.

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

RendererType: Separator

Supported facets:

label: This facet contains a UILabel

sheet

Render a sheet element.

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

RendererType: Sheet

Supported facets:

reload: Contains an instance of UIReload

span Add a column span or row span to the parent UIComponent, useful for a grid layout.

style

Add a style tag with the given file name to the header (using file attribute) or add some CSS styles to the parent component.

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

RendererType: Style

suggest

Renders 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

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

tabGroup

Renders a tab group which contains tab panels.

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

RendererType: TabGroup

tab

Renders a tab within a tab group.

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

RendererType: Tab

Supported facets:

bar: Contains some code to be placed in the header at the bar position.

textarea

Renders a multi line text input control.

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

RendererType: Textarea

treeCommand

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

treeIcon

Renders an image beside a tree node.

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

RendererType: TreeIcon

treeIndent

Renders an indent beside a tree node.

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

RendererType: TreeIndent

treeLabel

Renders a label inside of a tree.

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

RendererType: TreeLabel

treeListbox

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

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

RendererType: TreeListbox

treeMenu

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

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

RendererType: TreeMenu

treeNode

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

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

RendererType: TreeNode

treeSelect

Makes a tree node selectable.

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

RendererType: TreeSelect

tree

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

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

RendererType: Tree

validateFileItem Register an {@link FileItemValidator} instance on the UIComponent associated with the closest parent UIComponent custom action.

validateSubmittedValueLength Register an {@link 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.

Function Summary
Type	Function	Description
`org.apache.myfaces.tobago.layout.ColumnPartition`	`columnPartition(java.lang.String)`	No Description
`java.lang.String`	`format1(java.lang.String, java.lang.Object)`	No Description
`java.lang.String`	`format2(java.lang.String, java.lang.Object, java.lang.Object)`	No Description
`java.lang.String`	`format3(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object)`	No Description
`java.lang.String`	`format4(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)`	No Description
`java.lang.String`	`format5(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)`	No Description
`java.lang.String`	`format6(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)`	No Description
`java.lang.String`	`format7(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)`	No Description
`java.lang.String`	`format8(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)`	No Description
`java.lang.String`	`format9(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)`	No Description