o


Standard Syntax:
     <%@ taglib prefix="o" uri="http://openfaces.org/" %>

XML Syntax:
     <anyxmlelement xmlns:o="http://openfaces.org/" />

Tags for the OpenFaces library

Tag Library Information
Display NameNone
Version3.0
Short Nameo
URIhttp://openfaces.org/
 

Tag Summary
ajaxNo Description
ajaxSettingsThe AjaxSettings component is used for handling session expiration, customizing the progress message and defining Ajax related events. The defaultProgressMessage, defaultSessionExpiration and silentSessionExpiration components can be specified in the corresponding facets of the AjaxSettings component.
barChartViewThe BarChartView component is used to create and customize a bar chart. Can be specified only as a child tag of the chart component. Child tags: chartAxis, numberAxis, dateAxis, categoryAxis, chartAxisTicks, chartLabels, chartNoDataMessage, chartGridLines.
borderLayoutPanelThe BorderLayoutPanel component is a container that is composed of several SidePanels and a central "content" area. A content area takes all of free space that remains after all SidePanels were placed.
calendarThe Calendar component enables the user to select a date from a one-month calendar and navigate between months and years. Child tags: dateRanges, simpleDateRange.
captionAreaThis component can be placed inside of components with caption such as Window, Confirmation and FoldingPanel to customize the default set and appearance of component's caption buttons.
captionButtonThis component can be placed inside of the CaptionArea component to add a custom caption button.
categoryAxisThe CategoryAxis tag is used to customize an axis for a chart with discrete data. This tag should be defined as a child tag for the chart-type components (barChartView and lineChartView).
cellThe Cell component is used to specify content, style or client-side events for specific cells selectively. This component is also used for merging cells. If the column attribute is not specified, the cells are applied in the order they are declared starting from the first column. If there are cells with column attributre specified and without the column attribute, cells without column attribute are applied first. Child tags of the Cell component are used to render content of the appropriate cells. This tag can be specified only as a child tag of the row component.
chartThe Chart component is used to present data in a graphical form enabling the user to see trends, comparisons, or percentage of the whole. The component constitutes the entire chart area, including the chart itself and all its elements (title, legend, background). The component is based on the JFreeChart engine and exposes a friendly API with JSF-specific features and enhancements. Child tags: pieChartView, lineChartView, barChartView, chartTitle, chartLegend.
chartAxisThe ChartAxis tag is used to customize a chart axis of any type. This tag should be defined as a child tag for the chart-type components (barChartView and lineChartView).
chartAxisTicksThe ChartAxisTicks tag is used to apply a style for the chart axis ticks. This tag should be defined as a child tag for the chart-type components (barChartView and lineChartView).
chartGridLinesThe ChartGridLines tag is used to customize gridlines for pie and line charts. This tag should be defined as a child tag for the barChartView and lineChartView components.
chartLabelsThe ChartLabels tag is used to apply style for data labels This tag should be defined as a child tag for the chart-type components (pieChartView, barChartView, lineChartView).
chartLegendThe ChartLegend tag is used to customize a chart legend. This tag should be defined as a child tag for the chart-type components (pieChartView, barChartView, lineChartView).
chartMenuChartMenu is a component that provides support for context popup menu in charts.
chartNoDataMessageThe tag is used to specify the text that is shown if there is no data to display in the chart. This tag should be defined as a child of the tag.
chartPopupChartPopup is a component that provides support for custom item popups in charts.
chartSelectionNo Description
chartTitleThe ChartTitle tag is used to customize the chart title. This tag should be defined as a child tag for the chart component.
checkboxColumnThe CheckboxColumn component is used to specify a checkbox column, which is a special visual component that is rendered as a column of check boxes and whose values are not stored in the row's data object. You can use it as an alternative of or in addition to multiple selection or to implement complex selection models. Can be specified only as a child tag for the dataTable or treeTable component. In one of the facets can be specified selectAllCheckbox tag.
clientValidationSupportThe ClientValidationSupport tag provides configuration of client-side validation for the enclosing form.
closeWindowButtonThis component can be placed inside of the CaptionArea component to specify the caption button that allows closing the window.
columnThe Column component is used to specify a separate column. Child components of the tag are used to render each cell of the current row. Can be specified only as a child tag for the dataTable, treeTable or dropDownField components. Please note that the if you use the Column component in the dropDownField, you cannot use attributes related to filtering, sorting, selection.
columnGroupThe ColumnGroup component can be used to combine several columns into a group. The columns inside that are combined into a group can have an additional header and/or footer that spans across all of these columns. It is also possible to specify style and events for column groups. The set of attributes of tag is similar to that of tag. In order to create a group of columns, it is just needed to enclose the appropriate tags into a tag.
columnMenuA popup menu that can be placed into the "columnMenu" facet of or components to provide standard column operations.
columnReorderingTurns on drag&drop column reordering feature for a DataTable or TreeTable where this tag is inserted.
columnResizingAdding this tag as a child tag for the dataTable or treeTable component turns on the column resizing feature for the appropriate DataTable or TreeTable.
columnsThe Columns component is used to specify dynamic number of columns in the dataTable or treeTable components. Child components of the tag are used to render each cell. All of the attributes of tag are analogous to their counterparts in the tag but they have one valuable difference - an ability for the attributes to be specified as value binding expressions that allow specifying column attributes on a per-column basis. When specify child components of the tag, the "var" request-scope variables from the and tags can be used (apart form "value" and "var" attributes). Component can be specified only as a child tag for the dataTable or treeTable.
columnVisibilityMenuA popup menu that can be placed inside of the menu specified with DataTable's "columnMenu" facet to allow user customize column visibility. This menu displays the list of all columns in the table with the check-box against each one.
comboBoxFilterNo Description
commandButtonThis is an analog of the standard component extended with Ajax features making it possible to use Ajax request instead of form submission to execute an action and reload components. By default it behaves as its standard analog though Ajax functionality will be turned on if you specify its "render" attribute, which is similar to that of component and specifies the list of components that should be reloaded when the button is clicked. An additional optional attribute is "execute", which just like in the component allows specifying a list of components whose data should be submitted to the server for processing during the Ajax request.
commandLinkThis is an analog of the standard component extended with Ajax features making it possible to use Ajax request instead of form submission to execute an action and reload components. By default it behaves as its standard analog though Ajax functionality will be turned on if you specify its "render" attribute, which is similar to that of component and specifies the list of components that should be reloaded when the link is clicked. An additional optional attribute is "execute", which just like in the component allows specifying a list of components whose data should be submitted to the server for processing during the Ajax request.
compositeFilterNo Description
confirmationThe Confirmation component is a DHTML modal window containing a main instruction and two buttons using which the user can confirm or reject execution of some operation.
customEventEditorNo Description
dataTableThe DataTable component is used to display data in a tabular format and effectively manipulate it. It supports all the features of the standard JSF HtmlDataTable component and, in addition, provides a number of features of its own. Child tags: column, selectionColumn, checkboxColumn, singleRowSelection, multipleRowSelection, dataTablePaginator, cell, row, columnResizing.
dataTablePaginatorThe dataTablePaginator component allows the user to see the current page of the table records and jump from it to any other. The component displays the total number of pages, the number of the current page, a text field to type in the number of the page to go to, and a set of the Previous, Next, First and Last images to navigate between the pages. It should be placed within the dataTable component, inside any of its facets.
dateAxisThe DateAxis tag is used to customize an axis with date values or keys. This tag should be defined as a child tag for the chart-type components (barChartView and lineChartView).
dateChooserThe DateChooser component allows the user to enter a date either by typing it in the text field or selecting it from the calendar that appears when clicking a button next to text field. The selected date is displayed in the text field in the specified format.
dateRangesThe DateRanges tag is used to specify date ranges in the Calendar. Can be specified only as a child tag for the calendar component. Child tag: simpleDateRange
daySwitcherDisplays a time-table for one day. A time-table consists of a set of events with different time spans arranged within a day.
dayTableDisplays a time-table for one day. A time-table consists of a set of events with different time spans arranged within a day.
debugThis component is under construction.
defaultProgressMessageThe DefaultProgressMessage component is used for customizing the progress message that appears when an Ajax request is in progress. Should be specified in the "progressMessage" facet of the AjaxSettings component.
defaultSessionExpirationIf the DefaultSessionExpiration component is used, the confirmation that asks the user to reload the page appears when the current session is expired. This tag should be specified in the "sessionExpiration" facet of the AjaxSettings component. You can customize the session expiration confirmation by placing the tag into the "confirmation" facet of the tag and configuring its attributes appropriately.
deleteEventActionNo Description
domainMarkersDomainMarkers is a container component that provides a support for grouping the chart markers displayed on chart's key axis.
dropDownFieldRenders the DropDownField component that represents a text field with a set of predefined values in the drop-down list.
There are two ways to specify items in the drop-down list: These two approaches can be combined in any order.
dropDownFieldFilterNo Description
dropDownItemA child tag of the dropDownField or suggestionField tags that is used to specify a separate list item. It is also possible to add child components to the o:dropDownItem tag.
dropDownItemsA child tag of the dropDownField or suggestionField tags that is used to specify a list of items.
dynamicImageThe DynamicImage is a component that, unlike the standard JSF HtmlGraphicImage component which displays an image already stored as an application file, provides the ability to display an image which is dynamically generated at run time, or which is not available as an application file but, for example, is retrieved from a database.
dynamicTreeStructureThis tag is used to specify a dynamic tree structure. The hierarchy in the dynamic tree structure is defined by specifying the expression for retrieving child nodes of a given node. You should place the staticTreeStructure tag into the treeTable tag.
eventActionNo Description
eventActionBarNo Description
eventAreaNo Description
eventDescriptionA description part of event content
eventEditorDialogNo Description
eventEditorPageNo Description
eventLineFeedA line feed part of event content
eventNameA name part of event content
eventPreviewTurns on and allows customizing the box that is displayed when the mouse hovers over the event to show event contents that might not fully fit in the normal event display.
eventResourceA resource part of event content
eventTimeA time part of event content
expansionToggleButtonThis component can be placed inside of the CaptionArea component (which is in turn located in FoldingPanel component) to customize the appearance of FoldingPanel's expansion toggle caption button.
filterPropertiesNo Description
filterPropertyNo Description
floatingIconMessageThe FloatingIconMessage component allows you to display a validation error of a validated component by changing its appearance and adding a floating icon over the component.
focusFocus is a non-visual component that controls the focus on the page. You can specify the component in focus when the page is loaded and also save the focus between page submissions. Note that there can be only one Focus component on the page.
foldingPanelThe FoldingPanel component is a container for other components that can be collapsed or expanded by the user. It consists of a bar displaying the caption, an expandable/collapsible container, and a toggle button to switch between the two states.
forEachAn iterator component that renders the specified set of components multiple times based on its parameters
gradientLineAreaFillGradientLineAreaFill is a component that provides a functionality for filling the area in Line charts with a gradient.
graphicTextGraphicText is a component that displays styled rotated text. It has API similar to the standard component, though unlike the component, the GraphicText component displays a text with an image generated on the server. This component can be useful for displaying vertical headers in a table having a lot of thin columns, vertical TabSet components, etc.
hideColumnMenuItemA menu item that can be inserted into the column menu of DataTable/TreeTable components to provide column hiding capability.
hintLabelThe HintLabel component displays single-line text which, if it doesn't fit in the allotted space, is displayed fully in a tooltip.
inputTextThe InputText component is an input component that give feature display prompt text, if value of component is not set.
inputTextareaThe InputTextarea component is an input component that give feature display prompt text, if value of component is not set.
inputTextFilterNo Description
layeredPaneThe LayeredPane component is a container which allows switching between different sets of displayed components. Each set of components, called a page, is declared within the LayeredPane component and it's possible to use both server-side and client-side API for selecting the currently displayed page. LayeredPane provides different page loading modes to allow quick client-side switching or Ajax-based page switching.
levelIndicatorLevelIndicator is a chart-like component that displays a meter with three customizable colors.
lineChartViewThe LineChartView component is used to create and customize a line chart. Can be specified only as a child tag of the chart component. Child tags: chartAxis, numberAxis, dateAxis, categoryAxis, chartAxisTicks, chartLabels, chartNoDataMessage, chartGridLines, lineProperties.
linePropertiesThe LineProperties tag is used to customize lines in the line chart. This tag should be defined as a child tag for the lineChartView component.
loadBundleThe LoadBundle component is used for loading a resource bundle localized for the Locale of the current view, and expose it (as a Map) in the request attributes of the current request. The o:loadBundle component is similar to the f:loadBundle from the RI or MyFaces JSF implementation but can be used in the components with Ajax enabled.
markerMarker component that provides a support to mark specific value or values on chart.
maximizeWindowButtonThis component can be placed inside of the CaptionArea component to specify the caption button that allows maximizing the window.
menuItemNo Description
menuSeparatorNo Description
messageParamThe MessageParam component allows you to specify parameters for validation messages within any OpenFaces validator.
minimizeWindowButtonThis component can be placed inside of the CaptionArea component to specify the caption button that allows minimizing the window.
monthTableDisplays a time-table for one month. This component is under construction.
multipleNodeSelectionThe component is used for multiple node selection. Can be specified only as a child tag for the treeTable component.
multipleRowSelectionThe MultipleRowSelection component is used for multiple row selection. Can be specified only as a child tag for the dataTable component.
numberAxisThe NumberAxis tag is used to customize an axis with numeric values or keys. This tag should be defined as a child tag for the chart-type components (barChartView and lineChartView).
pieChartViewThe PieChartView component is used to create and customize a pie chart. It can be specified only as a child tag of the chart component. Child tags: pieSectorProperties, chartLabels, chartNoDataMessage.
pieSectorPropertiesThe PieSectorProperties tag is used to apply a style to the pie sectors and specify whether or not a pie sector is pulled out upon mouse click. This tag should be defined as a child tag for the pieChartView component.
popupLayerThe PopupLayer component is used as a container for other components that is displayed over the page content as specified by its coordinates.
popupMenuNo Description
printChartMenuItemPrintChartMenuItem is a component that represents the action menu item for the chart's context popup menu and provides a functionality for displaying print dialog for the chart.
rangeMarkersRangeMarkers is a container component that provides a support for grouping the chart markers displayed on chart's value axis.
rowThe Row component is used to specify content, style or client-side events for specific rows selectively. The attributes and contents specified in this tag are applied to all rows that meet the criterion specified in the "condition" attribute. This tag can be specified only as a child tag of the dataTable or treeTable components. You can only specify the cell components as child tags for the Row component.
saveChartMenuItemSaveChartMenuItem is a component that represents the action menu item for the chart's context popup menu and provides a functionality for saving the chart image to the client.
scrollingAdding this tag as a child tag for the dataTable or treeTable component turns on the scrolling feature for the appropriate DataTable or TreeTable.
scrollPositionScrollPosition is a non-visual component that controls the scroll position of the page. You can specify the scroll position when the page is loaded and also save the scroll position between page submissions. Note that there can be only one ScrollPosition component on the page.
selectAllCheckboxThe selectAllCheckbox component adds a check box to the column header or footer. When the user selects this check box, all the check boxes within the column get selected. And if the user clears this check box, all the check boxes in the column are cleared too. It should be defined as a child tag for the column's (checkboxColumn, selectionColumn) "header" or "footer" facets, or both.
selectBooleanCheckboxThe SelectBooleanCheckbox component is an extended version of the standard component that adds such possibilities as tri-state support, customizing checkbox images and state-dependent styles.
selectionChangeListenerThe SelectionChangeListener is used to enable you to handle tab selection change on the server side. This tag can be specified only in the tabSet or tabbedPane components.
selectionColumnThe SelectionColumn component is used to specify a selection column that displays check boxes for multiple-row selection or radio buttons for single-row selection. The "selection column" is an alternative way for the user to change selection and see which row(s) is selected. Can be specified only as a child tag for the dataTable component. In one of the facets can be specified selectAllCheckbox tag.
selectManyCheckboxNo Description
selectOneMenuAn extended version of the standard <selectOneMenu> component. This component is under construction.
selectOneRadioNo Description
sidePanelThe sidePanel component is one side resizable container.
silentSessionExpirationIf the SilentSessionExpiration component is used, the page is reloaded when the current session is expired. Should be specified in the "sessionExpiration" facet of the AjaxSettings component.
simpleDateRangeThe DateRanges tag is used to specify one date range. Can be defined only as a child tag for the calendar component.
singleNodeSelectionThis component is used for single node selection. Can be specified only as a child tag for the treeTable component.
singleRowSelectionThe SingleRowSelection component is used for single row selection. Can be specified only as a child tag for the dataTable component.
solidLineAreaFillSolidLineAreaFill is a component that provides a functionality for filling the area in Line charts with a solid color
sortAscendingMenuItemA menu item that can be inserted into the column menu for DataTable/TreeTable components to provide colum sorting capability.
sortDescendingMenuItemA menu item that can be inserted into the column menu for DataTable/TreeTable components to provide colum sorting capability.
spinnerNo Description
stateChangeListenerThe StateChangeListener is used to enable you to handle state change of the FoldingPanel component on the server side. This tag can be specified only in the foldingPanel component.
staticTreeStructureThis tag is used to specify the static structure. You should place the staticTreeStructure tag into the treeTable tag. This tag should contain a hierarchy of the treeNode tags for each node.
subPanelThe SubPanel tag is used to specify a page in multi-page components such as TabbedPane. You can specify the content to be displayed in the panel's caption (e.g. the appropriate tab in TabbedPane) using the "caption" facet. The components that define the page content should be added as children of the SubPanel tag.
subPanelsThe SubPanels tag is used to retrieve dynamically changing data from a backing bean. This tag should be specified only in the tabbedPane tag.
suggestionFieldRenders the SuggestionField component that represents a text field with a set of predefined values in the drop-down list.
There are two ways to specify items in the drop-down list: These two approaches can be combined in any order.
tabbedPaneThe TabbedPane component allows you to present related information on separate pages and can be viewed by users by clicking a corresponding tab. Each page of the TabbedPane component can contain a number of other JSF components. Child tags: subPanel, subPanels.
tabSetThe TabSet component provides a set of tabs enabling the user to switch between different components, one at a time. Child tags: tabSetItem, tabSetItems.
tabSetItemThis tag is used to define a fixed set of tabs. Child components of the tabSetItem tag are rendered as the tab contents. This tag should be specified only in the tabSet tag.
tabSetItemsThis tag is used to dynamically change the set of tabs. It should be specified only inside the tabSet tag.
timetableEditingOptionsAllows customizing various aspects of timetable editing behavior.
timetableEventNo Description
treeColumnThis is a hierarchy-aware column that shows hierarchy position of the node by identing it and provides controls for expanding/collapsing the child nodes. Can be specified only as a child tag for the treeTable component.
treeNodeThis tag is used to specify every node in a static tree structure. Can be specified only in the staticTreeStructure tag.
treeTableThe TreeTable component displays hierarchical data in a tabular format. One of the component's columns displays a tree structure in which each row representing a node can be expanded to reveal lower-level rows of data. In general, the TreeTable provides most of the functionality of the OpenFaces DataTable component. Child tags: treeColumn, staticTreeStructure, dynamicTreeStructure, column, selectionColumn, checkboxColumn, singleNodeSelection, multipleNodeSelection, cell, row, columnResizing.
twoListSelectionThe TwoListSelection component serves the same purpose as the standard HtmlSelectManyListbox in JSF, but has a different appearance and provides a number of extra features. It consists of two list boxes separated by a set of buttons that let the user move selected items from one list to the other and reorder the selected items. The list on the left contains available items which the user can add to (or from) the list on the right in order to make a selection.
validateAllNo Description
validateCustomThe CustomValidator component allows you to write custom code to validate a value. The code is written in JavaScript on the client side and in Java on the server side.
validateEmailThe EmailValidator ensures that the component has a well-formed e-mail address as the value.
validateEqualThe EqualValidator checks that the values of two input components are the same.
validateRegexThe RegexValidator ensures that the value being validated matches the pattern described as a regular expression in the "pattern" attribute.
validateUrlThe URLValidator ensures that the component has a valid URL.
weekTableDisplays a time-table for one week. This component is under construction.
windowThe Window component is a window-styled container for other JSF components that is displayed over the page content. The Window component has a caption and a content area, it can be dragged around on the page, and resized. Besides, it has the usual maximize/restore, minimize and close buttons in the caption.
 


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.