tc

Tag Library Information 
InfoValue
ID (tag prefix)tc
URIhttp://myfaces.apache.org/tobago/component
Tag Summary 
TagDescription
attributeAdd an attribute on the UIComponent associated with the closest parent UIComponent custom action.
barDefines 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.
boxRenders 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.
buttonRenders 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.
buttonsRenders a group of buttons.

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

RendererType:

  • Buttons (default)

calendarRenders a calendar.

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

RendererType:

  • Calendar (default)

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

columnSelectorRenders a column with checkboxes to mark selected rows.

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

RendererType:

  • ColumnSelector (default)

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

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

RendererType:

  • Column (default)

converterRegister an Converter instance on the UIComponent associated with the closest parent UIComponent.
dataAttributeAdd 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.
dateRenders 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)

eventAdd an event behavior to the component.

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

RendererType:

  • Event (default)

figureUse 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)

flexLayoutRenders a flex layout (CSS3 feature).

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

RendererType:

  • FlexLayout (default)

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

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

RendererType:

  • FlowLayout (default)

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

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

RendererType:

  • Footer (default)

formIf 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)

gridLayout

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

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

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

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

RendererType:

  • Header (default)

hiddenRenders a hidden input element.

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

RendererType:

  • Hidden (default)

imageRenders an image.

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

RendererType:

  • Image (default)

inRenders 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.
labelRenders a label component.

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

RendererType:

  • Label (default)

linkRenders a link element.

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

RendererType:

  • Link (default)
  • LinkInsideCommand
  • LinkInsideLinks

Supported facets:

confirmation
Contains a UIOutput instance with the confirmation message.
linksDefines a navigation element, which contains a menu-like structure

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

RendererType:

  • Links (default)
  • LinksInsideBar

messagesRenders error/validation messages.

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

RendererType:

  • Messages (default)

metaThis 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)

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

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

RendererType:

  • Object (default)

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)

outRenders a text

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

RendererType:

  • Out (default)

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.
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 (default)

Supported facets:

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

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

RendererType:

  • Popup (default)

progressRenders 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:

    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.
    rowThis 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)

    scriptThis 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)

    sectionRenders a section or subsection.

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

    RendererType:

    • Section (default)

    Supported facets:

    label
    This facet contains a UILabel
    segmentLayoutConstraintSet a offset for the parent UIComponent withing a segment layout.
    segmentLayoutRenders 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 (default)

    selectBooleanCheckboxRenders a checkbox.

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

    RendererType:

    • SelectBooleanCheckbox (default)
    • SelectBooleanCheckboxInsideCommand

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

        selectManyListboxRender a multi selection option listbox.

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

        RendererType:

        • SelectManyListbox (default)

        selectManyShuttle

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

        RendererType:

        • SelectManyShuttle (default)

        selectOneChoiceRender a single selection dropdown list.

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

        RendererType:

        • SelectOneChoice (default)
        • SelectOneChoiceInsideIn

        selectOneListboxRender a single selection option listbox.

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

        RendererType:

        • SelectOneListbox (default)

        selectOneRadioRender a set of radio buttons.

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

        RendererType:

        • SelectOneRadio (default)
        • SelectOneRadioInsideCommand

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

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

        RendererType:

        • SelectReference (default)

        separatorRenders a separator.

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

        RendererType:

        • Separator (default)
        • SeparatorInsideCommand

        Supported facets:

        label
        This facet contains a UILabel
        sheetRender a sheet element.

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

        RendererType:

        • Sheet (default)

        Supported facets:

        reload
        Contains an instance of UIReload
        spanAdd 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 (default)

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

        tabChangeListenerRegister an TabChangedListener instance on the UIComponent associated with the closest parent UIComponent custom action.
        tabGroupRenders a tab group which contains tab panels.

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

        RendererType:

        • TabGroup (default)

        tabRenders 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.
        textareaRenders a multi line text input control.

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

        RendererType:

        • Textarea (default)

        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.
        treeIconRenders an image beside a tree node.

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

        RendererType:

        • TreeIcon (default)

        treeIndentRenders an indent beside a tree node.

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

        RendererType:

        • TreeIndent (default)

        treeLabelRenders a label inside of a tree.

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

        RendererType:

        • TreeLabel (default)

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

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

        RendererType:

        • TreeListbox (default)

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

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

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

        RendererType:

        • TreeNode (default)

        treeSelectMakes a tree node selectable.

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

        RendererType:

        • TreeSelect (default)

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

        validateFileItemRegister an {@link FileItemValidator} instance on the UIComponent associated with the closest parent UIComponent custom action.
        validateSubmittedValueLengthRegister 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
        org.apache.myfaces.tobago.layout.ColumnPartitioncolumnPartition(java.lang.String)No Description
        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.