tc

Tag Library Information 
InfoValue
ID (tag prefix)tc
URIhttp://myfaces.apache.org/tobago/component
Tag Summary 
TagDescription
attribute Add an attribute on the UIComponent associated with the closest parent UIComponent custom action.
badge Renders a badge element.

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

RendererType:

  • Badge (default)
  • BadgeInsideButtons

Supported markups:

pill
Make badges more rounded.
primary
Set badge color to primary color of the theme.
secondary
Set badge color to secondary color of the theme.
danger
Set badge color to danger color of the theme.
warning
Set badge color to warning color of the theme.
success
Set badge color to success color of the theme.
info
Set badge color to info color of the theme.
light
Set badge color to light color of the theme.
dark
Set badge color to dark color of the theme.
none
Colorless badge.
bar Defines a container for navigation elements, branding, ...

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

RendererType:

  • Bar (default)

Supported facets:

brand
Contains an element which will get a 'navbar-brand' style, e.g. use
after
Content will be rendered usually at the right end of the bar.

Supported markups:

dark
Theming for dark backgrounds
light
Theming for light backgrounds
small
Bar collapse at a small size.
medium
Bar collapse at a medium size.
large
Bar collapse at a large size.
extraLarge
Bar collapse at a extra large size.
box Renders a panel with border and title.

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

RendererType:

  • Box (default)

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.

Supported markups:

spread
Use the full height for the HTML content.
button Renders a button element.

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

RendererType:

  • Button (default)
  • ButtonInsideButtons
  • ButtonInsideIn
  • ButtonInsideInAfter

Supported facets:

confirmation
Contains a UIOutput instance with the confirmation message.

Supported markups:

primary
Set button color to primary color of the theme.
secondary
Set button color to secondary color of the theme.
success
Set button color to success color of the theme.
danger
Set button color to danger color of the theme.
warning
Set button color to warning color of the theme.
info
Set button color to info color of the theme.
light
Set button color to light color of the theme.
dark
Set button color to dark color of the theme.
none
Colorless button.
badge
Display the button as a badge.
pill
Make badges more rounded if button is displayed as a badge.
buttons Renders a group of buttons.

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

RendererType:

  • Buttons (default)
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 (default)
columnSelector Renders a column with checkboxes to mark selected rows.

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

RendererType:

  • ColumnSelector (default)
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 (default)
convertDateTime Register a DateTimeConverter instance on the UIComponent associated with the closest parent UIComponent custom action.
converter Register an Converter instance on the UIComponent associated with the closest parent UIComponent.
dataAttribute 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 (default)
event Add an event behavior to the component. It can contain f:ajax and tc:operation tags.

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

RendererType:

  • Event (default)
figure Use figure to show e. g. images or videos inside.

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

RendererType:

  • Figure (default)

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 (default)
flexLayout Renders a Flexible Box Layout.

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

RendererType:

  • FlexLayout (default)

Supported markups:

spread
Use the full height for the HTML content.
flowLayout Renders a FlowLayout that positions the content components in there natural order.

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

RendererType:

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

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

RendererType:

  • Footer (default)
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 (default)
gridLayoutConstraint Set grid layout specific contraints to the parent component.
gridLayout

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

Renders a grid-layout. The grid is defined by the columns and rows attributes. You can adjust the widths of the columns and rows by value of the tokens. The number of tokens describe the number of columns and rows. 
 columns/rows ::= LAYOUT
 LAYOUT       ::= TOKEN [" " TOKEN]+
 TOKEN        ::= "auto" | MEASURE | FRACTION
 MEASURE      ::= [NUMBER] ("px" | "em" | "ex" | "rem" | ...)
 FRACTION     ::= [POSITIVE_INTEGER] "fr"

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

RendererType:

  • GridLayout (default)

Supported markups:

spread
Use the full height for the HTML content.
header Defines a header of its parent (like page, box, ...)

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

RendererType:

  • Header (default)
hidden Renders a hidden input element.

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

RendererType:

  • Hidden (default)
image Renders an image.

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

RendererType:

  • Image (default)
in Renders a text input field.

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

RendererType:

  • In (default)

Supported facets:

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

Supported markups:

localMenu
If a suggest menu is available, it will be rendered on the component, not in the '.tobago-page-menuStore'.
label Renders a label component.

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

RendererType:

  • Label (default)
link Renders a link element, i. e. an anchor <a> tag. For a <link> tag, please use <tc:metaLink> tag.

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

RendererType:

  • Link (default)
  • LinkInsideCommand
  • LinkInsideLinks

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 (default)
  • LinksInsideBar
messages Renders error/validation messages.

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

RendererType:

  • Messages (default)
metaLink This tag renders a link tag in the header of the HTML output.

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

RendererType:

  • MetaLink (default)
meta This tag a meta tag in the header of the HTML output. It's not possible to add more than one tag with the same
  • name + lang combination
  • httpEquiv
  • charset
The last inserted wins. So, you may override the default Tobago meta tag in this way.

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

RendererType:

  • Meta (default)
object Show external content inside of an application. This will typically renders an iframe tag.

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

RendererType:

  • Object (default)

Supported markups:

spread
Use the full height for the HTML content.
operation

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

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

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

RendererType:

  • Operation (default)
out Renders a text

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

RendererType:

  • Out (default)
  • OutInsideBoxLabel
  • OutInsideIn
  • OutInsideSectionLabel
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 (default)

Supported facets:

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

Supported markups:

spread
Use the full browser height for the HTML content.
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 (default)

Supported facets:

reload
Contains an instance of UIReload
layout
Deprecated. Contains an layout manager. The layout manager tag should surround the content instead.

Supported markups:

spread
Use the full height for the HTML content.
popup Renders a popup panel.

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

RendererType:

  • Popup (default)

Supported markups:

large
Large popup
small
Small popup
progress Renders a progress bar.

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

RendererType:

  • Progress (default)
reload

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

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

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 (default)
    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 (default)
    section Renders a section or subsection.

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

    RendererType:

    • Section (default)

    Supported facets:

    label
    Contains some code to be placed in the header at the label position.
    bar
    Contains some code to be placed in the header at the bar position.
    segmentLayoutConstraint Set a offset for the parent UIComponent withing a segment layout.
    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="12seg" will be used as default.

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

    RendererType:

    • SegmentLayout (default)

    Supported markups:

    spread
    Use the full height for the HTML content.
    selectBooleanCheckbox Renders a checkbox.

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

    RendererType:

    • SelectBooleanCheckbox (default)
    • SelectBooleanCheckboxInsideCommand
    selectBooleanToggle Renders a checkbox as toggle.

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

    RendererType:

    • SelectBooleanToggle (default)
    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 (default)
        • SelectManyCheckboxInsideCommand
        selectManyListbox Render a multi selection option listbox.

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

        RendererType:

        • SelectManyListbox (default)

        Supported markups:

        spread
        Use the full height for the HTML content.
        selectManyShuttle

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

        RendererType:

        • SelectManyShuttle (default)

        Supported markups:

        spread
        Use the full height for the HTML content.
        selectOneChoice Render a single selection dropdown list.

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

        RendererType:

        • SelectOneChoice (default)
        • SelectOneChoiceInsideIn
        selectOneListbox Render a single selection option listbox.

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

        RendererType:

        • SelectOneListbox (default)

        Supported markups:

        spread
        Use the full height for the HTML content.
        selectOneRadio Render a set of radio buttons.

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

        RendererType:

        • SelectOneRadio (default)
        • SelectOneRadioInsideCommand
        selectReference Renders a set of option related to and same type as the for component.

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

        RendererType:

        • SelectReference (default)
        separator Renders a separator.

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

        RendererType:

        • Separator (default)
        • SeparatorInsideCommand

        Supported facets:

        label
        This facet contains a UILabel
        sheet Render a sheet element.

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

        RendererType:

        • Sheet (default)

        Supported facets:

        reload
        Contains an instance of UIReload

        Supported markups:

        bordered
        Add borders to the table cells.
        dark
        Set dark background.
        hover
        Background of row changed on hovering.
        small
        Small margins for table cells.
        striped
        Zebra-striping for table rows.
        spread
        Use the full height for the HTML content.
        span

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

        Since Tobago 4.0.0. Please use <tc:gridLayoutConstraint> from {

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

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

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

        Renders a SplitLayout. A area with two child components rendered horizontally or vertically and allows to change the layout relation of this two components on the client.

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

        RendererType:

        • SplitLayout (default)

        Supported markups:

        spread
        Use the full height for the HTML content.
        stars Renders a star rating component.

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

        RendererType:

        • Stars (default)
        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 (default)
        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 (default)
        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 (default)

        Supported markups:

        spread
        Use the full height for the HTML content.
        tab Renders a tab within a tab group.

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

        RendererType:

        • Tab (default)

        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.
        textarea Renders a multi line text input control.

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

        RendererType:

        • Textarea (default)

        Supported markups:

        spread
        Use the full height for the HTML content.
        treeCommand

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

        since 4.0.0, please use tc:link

        Renders a command inside of a tree.

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

        RendererType:

        • TreeCommand (default)

        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 (default)
        treeIndent Renders an indent beside a tree node.

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

        RendererType:

        • TreeIndent (default)
        treeLabel Renders a label inside of a tree.

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

        RendererType:

        • TreeLabel (default)
        treeListbox A tree data structure displayed as a set of list boxes.

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

        RendererType:

        • TreeListbox (default)
        treeMenu

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

        since 4.2.1. Please use {

        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 (default)
        treeNode Creates a tree node. This component represents a single node inside a tree structure.

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

        RendererType:

        • TreeNode (default)
        treeSelect Makes a tree node selectable.

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

        RendererType:

        • TreeSelect (default)
        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 (default)
        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 
        TypeFunctionDescription
        java.lang.Stringformat1(java.lang.String, java.lang.Object)No Description
        java.lang.Stringformat2(java.lang.String, java.lang.Object, java.lang.Object)No Description
        java.lang.Stringformat3(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object)No Description
        java.lang.Stringformat4(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)No Description
        java.lang.Stringformat5(java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object, java.lang.Object)No Description
        java.lang.Stringformat6(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.Stringformat7(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.Stringformat8(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.Stringformat9(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

        Output generated by Vdldoc View Declaration Language Documentation Generator.