ICEfaces-EE ACE Components (ICEfaces-EE ACE Components 3.3.0.GA

Overview

Library

Tag

Help

FRAMES NO FRAMES

ICEfaces-EE ACE Components

Standard Syntax:


                    
                
                    <%@ taglib prefix="ace" uri="http://www.icefaces.org/icefaces/components" %>

XML Syntax:


                    
                
                    <anyxmlelement xmlns:ace="http://www.icefaces.org/icefaces/components" />

No Description

Tag Library Information
Display Name	ICEfaces-EE ACE Components
Version	3.3.0
Short Name	ace
URI	http://www.icefaces.org/icefaces/components

Tag Summary

accordionPane

The AccordionPane is a component used by accordion as a container to display contents.

For more information, see the AccordionPane Wiki Documentation.

accordion

The Accordion is a container component that displays contents in a stacked format.

For more information, see the Accordion Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
panechange	Fired when the active accordion pane is changed (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

listExporter

Utility to export data from an ace:list component as an Excel, PDF, XML or CSV document. This component renders an HTML button. More components and HTML elements can be nested inside this tag to give a different look to the button.

For more information, see the ListExporter Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
action	Triggers when the button is clicked or pressed by any other means. By default, both this ace:listExporter component and the target ace:list component are executed in this ajax request.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

notificationPanel

The Notification Panel is a component that displays a multipurpose fixed positioned panel for notification. Any group of JSF content can be placed inside notification panel. If position of panel is out of place, try putting it as last child of body.

For more information, see the NotificationPanel Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
close	Fired when the panel is closed (default event).	javax.faces.event.AjaxBehaviorEvent
display	Fired when the panel is displayed.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

panelStack panelStack manages child contentPanes, controlling which child is visible.

menu

Menu is a navigation component with various customized modes like multi tiers, overlay and nested menus.

For more information, see the Menu Wiki Documentation.

progressBar

The Progress Bar is a process status indicator that can either work purely on client side or interact with server side using ajax.

For more information, see the ProgressBar Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
complete	Fired when the value of the progressbar reaches the maximum value (default event).	javax.faces.event.AjaxBehaviorEvent
cancel	Fired when the progress process is cancelled by calling cancel().	javax.faces.event.AjaxBehaviorEvent
change	Fired when the value of the progressbar changes.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

menuButton

MenuButton displays different commands in a popup menu.

For more information, see the MenuButton Wiki Documentation.

printer

Printer allows sending a specific JSF component to the printer, not the whole page. It needs to be nested inside an h:commandButton or h:outputLink component.

For more information, see the Printer Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
activate	Fired when the parent component is clicked or activated via the keyboard (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

multiColumnSubmenu

MultiColumnSubmenu is nested in a menu component and represents a navigation group with one or more MenuColumn's.It supports the 'header' and 'footer' facets to include arbitrary components at the top and bottom of the submenu.

For more information, see the MultiColumnSubmenu Wiki Documentation.

menuItem

MenuItem is used by various menu components

For more information, see the MenuItem Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
activate	Triggers when the menu item is clicked or selected by any other means.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

tableConfigPanel

Renders a hidden panel with controls to configure column features. The table whose columns are to be configured is targeted with the 'for' attribute. The location of the button to reveal this panel is configured via the 'type' attribute.

The table config panel renders three buttons, a checkmark which submits changes, a crossout that closes without submitting changes, and a trashcan, that closes and resets the column properties configurable via the table config panel to an unconfigured state.

For more information, see the TableConfigPanel Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
open	Fired when the TableConfigPanel is shown.	javax.faces.event.AjaxBehaviorEvent
submit	Fired when the TableConfigPanel submits its changes and closes.	javax.faces.event.AjaxBehaviorEvent
cancel	Fired when the TableConfigPanel cancel its changes and closes.	javax.faces.event.AjaxBehaviorEvent
trash	Fired when the TableConfigPanel clears out it's changes and closes.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

buttonGroup No Description

excludeFromExport

Embedding this component inside any component causes the data exporter to avoid including the values of such component in the exported file. It has no other effects.

For more information, see the ExcludeFromExport Wiki Documentation.

contextMenu

ContextMenu provides a popup menu that is displayed on mouse right-click event.

For more information, see the ContextMenu Wiki Documentation.

gMapAutocomplete An Icesoft implementation of Google's Places autocomplete tool. The ace:gMapAutocomplete component will create a text box which will provide locations that match the currently typed string, then return information about the selected location such as the types Google has assigned to it, or the url to Google's information page on it. For more information, see the gMap Wiki Documentation.

gMapEvent The ace:gMapEvent component allows the other Google maps subcomponents to integrate with the google event handling API and execute user defined code. For more information, see the gMap Wiki Documentation.

gMapMarker The ace:gMapMarker component places one of Google's markers upon the given latitude/longitude coordinates of the parent ace:gMap. For more information, see the gMap Wiki Documentation.

gMapLayer The ace:gMapLayer component creates one of a variety of layers on top of the parent ace:gMap, to enhance or display new information. Google provides Bicycling, Traffic and Transit layers, which display bike paths, traffic flow and public transportations routes respectively. Alternatively, a user defined kml file can also be used. For more information, see the gMap Wiki Documentation.

gMapServices The ace:gMapServices tag allows access to the various 'services' that Google provides through its maps API. Elevation gives the height of any point above or below sea level. Max zoom gives the highest level of satellite zoom available. Distance gives the distance between two points along a set mode of transit and directions show the way between given locations. For more information, see the gMap Wiki Documentation.

gMap The base component for the ACE gMap (Google Maps API) set of components. This component is how to define and control the map proper, as well as serving as a parent for the other gMap subcomponents. Important note: To function properly, you must define the property 'org.icefaces.ace.gmapKey' in your web.xml. You can get an API key at http://code.google.com/apis/maps/signup.html. For more information, see the gMap Wiki Documentation.

gMapInfoWindow The ace:gMapInfoWindow component creates a pop-up window within the parent ace:gMap, which can be used to display either text via the 'content' attribute or nested html or jsf tags. If placed within an ace:gMapMarker, the window will 'bind' to the marker, and move along with it. For more information, see the gMap Wiki Documentation.

gMapOverlay The ace:gMapOverlay component allows for the creation of user defined shapes on the parent ace:gMap. Google provides rectangles and circles for ease of use, but polygon and polyline can be used for greater control. Colours and borders can be set through options. For more information, see the gMap Wiki Documentation.

gMapControl The ace:gMapControl component serves as an easy interface to modify the position, style and rendered state of the controls that appear on the ace:gMap that this tag is nested within. For more information, see the gMap Wiki Documentation.

autoCompleteEntry

AutoCompleteEntry is a text input component that presents possible valid options as the user types. The options can be a list of SelectItem's specified in a child tag. It is also possible to specify a list of arbitrary data objects (i.e. POJOs) through the listValue attribute. In this case, a facet named "row" should be nested inside this component. This allows for more flexible rendering of each row, making it possible to render other components or HTML for each row and to display different properties of the data object.

For more information, see the AutoCompleteEntry Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
submit	Fired any time the value of the text input field is submitted to the server, either by typing a character, clicking on an option from the list, selecting an option with the keyboard, or pressing enter on the text field. If there are also textChange and/or valueChange events registered for this component, this event will not fire in those cases, since the other events are more specific and have precedence.	javax.faces.event.AjaxBehaviorEvent
blur	Fired any time the text input field loses focus.	javax.faces.event.AjaxBehaviorEvent
textChange	Fired any time the user adds or removes characters from the text field by typing or by pasting text.	javax.faces.event.AjaxBehaviorEvent
valueChange	Fired when the user gives a more definite input for this component either by clicking on an option from the list, or selecting an option with the keyboard, or pressing enter on the text field.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

rowExpansion

Renders a set of rows located underneath the row where ace:expansionToggler was activated. These subrows are defined by a tree relationship modeled in the List bound to the 'value' attribute of the parent DataTable. The List must be of the type List> where the entries are mappings from row data objects to lists of sub-entries.

For more information, see the Row Expander Wiki Documentation.

list

Renders an Array or List of objects as a styled HTML UL element. Supports dual & multilist configurations, reordering, item drag/drop, selection & block style layout. The component strives to be exceptionally easy to style and adjust layout.The ace:list value attributemay take a List of SelectItem objects to use their String label representations as list item contents, can take SelectItems as a model via f:selectItem(s) children, or value defines a List of arbitrary objects to be represented by iterative renderings of our child components.The components are associated with the iterative object via bindings of the 'var' property.

For more information, see the List Wiki Documentation.

Facets
filter	An optional facet that is rendered in place of the built-in filtering inputs to provide more flexibility when filtering values. This facet is rendered as a simple popup dialog. When using this facet, the 'filterValue' property has to be set as well (or 'filterValueMin' and 'filterValueMax' if working with ranges).
header
footer

Client Events
Name	Description	Supported classes for argument
select	Fired when an item is clicked & selected in the List.	javax.faces.event.AjaxBehaviorEvent
deselect	Fired when an item is clicked & deselected in the List.	javax.faces.event.AjaxBehaviorEvent
move	Fired when an item is moved within the List.	javax.faces.event.AjaxBehaviorEvent
migrate	Fired when an item is migrated to this List.	javax.faces.event.AjaxBehaviorEvent
sort	Fired when a change to the current sort occurs on the list.	javax.faces.event.AjaxBehaviorEvent
filter	Fired when a change to the current filters occurs on the list.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

textEntry

TextEntry is a text input component that can display some placeholder text inside the input field when the component doesn't have a value and is not focussed. It also has custom styling for invalid state and required status.

For more information, see the TextEntry Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
charCount	Fired when the number of characters entered in the component changes, either by the user typing a new character, deleting one or more characters, or cutting/pasting characters into the component.	javax.faces.event.AjaxBehaviorEvent
blur	Fired when the text input field loses focus (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

rowEditor

Renders a set of controls that reveal, submit and hide the hidden input facet of a ace:cellEditor.

For more information, see the Row Editor Wiki Documentation.

cellEditor

Renders a hidden input and visible display facet to be toggled between and submitted via the ace:rowEditor.

For more information, see the CellEditor Wiki Documentation.

listControl

Renders a set of controls for moving items among ace:list components. Requires a selector that defines the set of ace:list components to move items between. Defaults to all lists. Optionally if this component has two nested ace:list children, they will be rendered within a styled container, and connected via this control without configuration.

For more information, see the List Control Wiki Documentation.

ajax

Applied on components that support client behaviors similar to the standard f:ajax behavior.

For more information, see the Ajax Wiki Documentation.

fileEntry

The FileEntry component allows for uploading files to the server within a form submit POST. The actual POST is non-AJAX, but leverages ICEfaces to return incremental page updates. The upload occurs within as single JSF lifecycle, along with the form's other component processing, allowing applications to handle input field validation together with file content validation, for model coherency. As well, server push is not necessary for receiving the rendered view from the lifecycle in which the files were uploaded. The progress indicator is built-in, and will default to indeterminate mode. If server push is enabled, then the component will automatically push progress information to the indicator, and once that has been received, the indicator will automatically switch to display the incrementalprogress bar. The progress pushes are rate limited to be no more frequent than once every 2 seconds, and are only sent at 1% progress increments.

For more information, see the FileEntry Wiki Documentation.

comboBox

A component that merges a select and an input field.

For more information, see the ComboBox Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
valueChange	Fired whenever the value of the component changes.	javax.faces.event.AjaxBehaviorEvent
blur	Fired any time the component loses focus.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

tooltip

The Tooltip is a component that displays a tooltip with various events, effects and customization options.

For more information, see the Tooltip Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
display	Fired before the tooltip is shown (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

drawerPanel

The DrawerPanel is a container component that can overlay other elements on the page, appearing from an edge of the page. The DrawerPanel has several customization options such as modal, width, position.

For more information, see the DrawerPanel Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
open	Fired when the drawer panel is opened (default event).	org.icefaces.ace.event.OpenEvent
close	Fired when the drawer panel is closed.	org.icefaces.ace.event.CloseEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

textAreaEntry

TextAreaEntry is a text area input component that can display some placeholder text inside the text area when the component doesn't have a value and is not focussed. It also has custom styling for invalid state and required status.

For more information, see the TextAreaEntry Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
charCount	Fired when the number of characters entered in the component changes, either by the user typing a new character, deleting one or more characters, or cutting/pasting characters into the component.	javax.faces.event.AjaxBehaviorEvent
blur	Fired when the text input field loses focus (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

confirmationDialog

The Confirmation Dialog is a component that displays a dialog that asks users to confirm or cancel their actions. If position of dialog is out of place, try putting it as last child of body.

For more information, see the ConfirmationDialog Wiki Documentation.

richTextEntry

RichTextEntry uses the CKEditor API to provide JSF based rich text editor component.

For more information, see the RichTextEntry Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
save	Fired when the 'Save' button is clicked and the contents of the editor are saved.	javax.faces.event.AjaxBehaviorEvent
blur	Fired any time the editor loses focus.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

resizable

The Resizable is a component that makes another component resizable.

For more information, see the Resizable Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
resize	Fired at the end of a resize operation (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

panel

Panel is a generic grouping component that also supports toggling, closing and options menu. Both Close and Toggle events can be listened on server side with ajax listeners.

For more information, see the Panel Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
toggle	Fired when the toggle button is activated to expand or collapse the panel (default event).	org.icefaces.ace.event.ToggleEvent
close	Fired when the close button is activated to remove the panel from view.	org.icefaces.ace.event.CloseEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

submitMonitor

Monitors submits to the server, and indicates the status of the submits, server and network connection, and session validity. Examples of supported submit methods are: components doing full form submits, singleSubmit(s) such as via icecore:singleSubmit, partialSubmit(s) by ice: components, f:ajax submits by h: components, ace:ajax submits by ace: components, and direct use of ICEfaces javascript submit APIs. Supports configurable text labels and image state indicators, or facets for a fully configurable UI. Optionally uses an overlay for UI blocking during submits. Can be set to monitor a portion of the page, in tandem with other submitMonitors each monitoring their own distinct portions.

For more information, see the SubmitMonitor Wiki Documentation.

Facets
idle	Allows rendering of nested components as label for idle state.
active	Allows rendering of nested components as label for active state.
serverError	Allows rendering of nested components as label for serverError state.
networkError	Allows rendering of nested components as label for networkError state.
sessionExpired	Allows rendering of nested components as label for sessionExpired state.

columnGroup

A grouping of column and row components to furnish table segments specified by the 'type' attribute.

For more information, see the ColumnGroup Wiki Documentation.

panelExpansion

Renders a table-width panel filled with its child components, located underneath the row where ace:expansionToggler was activated.

For more information, see the PanelExpansion Wiki Documentation.

menuBar

Menubar is a horizontal navigation component.

For more information, see the MenuBar Wiki Documentation.

message

The message tag renders the first Faces message (if redisplay is true) or the first undisplayed Faces message (if redisplay is false) for a specific component. Styling is done by predefined jQuery classes in theme stylesheets:

Info: ui-icon-info w/ ui-state-highlight css
Warn: ui-icon-notice w/ ui-state-highlight css
Error: ui-icon-alert w/ ui-state-error css
Fatal: ui-icon-alert w/ ui-state-error css

delegate

The Delegate is a container component that will receive the tooltip functionality on behalf of some other inner component. This is useful in cases where such inner component is prone to be completely replaced from the DOM during dynmic updates, where it could lose the tooltip functionality. This component doesn't have any visual impact on the page; it simply renders span elements to apply listeners to.

For more information, see the Delegate Wiki Documentation.

droppable

Allows a specified component to act as an area where Draggable items can be moved onto and register the event.

For more information, see the Droppable Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
drop	Fired when a draggable component is dropped on this droppable component (default event). By default, both the draggable and the droppable components are executed in this ajax request.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

draggable

Enables an Id-specified component to be moved via dragging. Draggable component can cause events on droppable ones.

For more information, see the Draggable Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
start	Fired when the target component starts to be dragged (default event). By default, no components are rendered in this ajax request, because rendering this draggable component itself or the target component could cause a dynamic update that replaces the original nodes being dragged on the page, which could interrupt the dragging action for the user.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

sliderEntry

The Slider Entry is a component that enables the user to adjust values in a finite range along a horizontal or vertical axis via dragging the slider control along the slider bar, or pressing the arrow-keys. It can be used as a visual replacement for an input box that takes a number as input.

For more information, see the SliderEntry Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
slideStart	Fired when a drag operation on the slider control is initiated.	javax.faces.event.AjaxBehaviorEvent
slide	Fired each time the the slider control is moved during a drag operation.	javax.faces.event.AjaxBehaviorEvent
slideEnd	Fired when a drag operation is completed by releasing the slider control (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

menuSeparator

MenuSeparator is nested in a menu component and is used to separate unrelated submenus and menu items.

For more information, see the MenuSeparator Wiki Documentation.

column

Component that represents a column in an ace:dataTable.

For more information, see the Column Wiki Documentation.

Facets
filter	An optional facet that is rendered in place of the built-in filtering inputs to provide more flexibility when filtering values. This facet is rendered as a simple popup dialog. When using this facet, the 'filterValue' property has to be set as well.

pushButton

The Push Button is a component that allows entry of a complete form or just itself. It has the same functionality of a regular jsf command button but without having to add extra attributes.

For more information, see the PushButton Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
activate	Fired when the button is clicked or pressed by any other means (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

stackPane This component is a child of panelStack.The facelet attribute determines whether the children of this component are constructed in the server side component tree. A special tag handler is utilised to assist with this task. The desired outcome of this feature is to allow developers to maintain as small a server-side component tree as possible for purposes of increased scalability, without having to worry about the combinatory use of ui include and c forEach tags used with components.The facelet attribute defaults to false meaning that this panel is constructed and present in server side component tree. If facelet is true (can only be so if client is false), then the stackPane is only constructed if it is the selected panel in the panelStack.If the client attribute is true, this means children of this component are not only constructed but area also always rendered on the client --best for static data.

radioButton

The Radio Button is a component that allows entry of a button which supports browsers that see radio as true or false, yes or no, on or off. Once a radio button is selected, it can only be deselected by selecting a different radio button within the same button group. The Themeroller check icon will be displayed by default when the radio is checked. Override the .ui-icon-check class to display a different image.

For more information, see the RadioButton Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
activate	Fired when the button is clicked or pressed by any other means and changes to selected state (default event).	javax.faces.event.AjaxBehaviorEvent
deactivate	Fired when the button is clicked or pressed by any other means and changes to not selected state.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

dataTable

Renders an HTML table element. This table and its associated components offers support for features like: scrolling, sorting, filtering, row selection, row editing, lazy loading and expandable subrows and subpanels.

For more information, see the DataTable Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
page	Fired when the page is changed on the DataTable.	javax.faces.event.AjaxBehaviorEvent
rowsPerPage	Fired when the rows per page is changed on the DataTable via the paginator control.	javax.faces.event.AjaxBehaviorEvent
cellClick	Fired when a cell is clicked on the DataTable.	javax.faces.event.AjaxBehaviorEvent
cellDblClick	Fired when a cell is double clicked on the DataTable.	javax.faces.event.AjaxBehaviorEvent
select	Fired when a row or cell is selected on the DataTable.	javax.faces.event.AjaxBehaviorEvent
deselect	Fired when a row or cell is deselected on the DataTable.	javax.faces.event.AjaxBehaviorEvent
sort	Fired when a change to the current sort occurs on the DataTable.	javax.faces.event.AjaxBehaviorEvent
filter	Fired when a change to the current filters occurs on the DataTable.	javax.faces.event.AjaxBehaviorEvent
reorder	Fired when a column is dragged and dropped into a new ordering.	javax.faces.event.AjaxBehaviorEvent
editStart	Fired when a row is enabled for editing.	javax.faces.event.AjaxBehaviorEvent
editSubmit	Fired when a row is submits its edits.	javax.faces.event.AjaxBehaviorEvent
editCancel	Fired when a row cancels an in-progress edit.	javax.faces.event.AjaxBehaviorEvent
expand	Fired when a child ExpansionToggler component is clicked to expand (Note: for nested tables, the execute value should be @form or @all for the expansion to work).	javax.faces.event.AjaxBehaviorEvent
contract	Fired when a child ExpansionToggler component is clicked to contract (Note: for nested tables, the execute value should be @form or @all for the contraction to work).	javax.faces.event.AjaxBehaviorEvent
pin	Fired when a column is added to the pinning region of the table.	javax.faces.event.AjaxBehaviorEvent
unpin	Fired when a column is removed to the pinning region of the table.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

dateTimeEntry

The DateTime Entry is a component that allows the user to configure and input a date and/or time in various ways.

For more information, see the DateTimeEntry Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
dateSelect	Fired when a date is selected from the calendar (default event).	org.icefaces.ace.event.DateSelectEvent
dateTextChange	Fired when date text is changed and input field loses focus.	org.icefaces.ace.event.DateTextChangeEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

submenu

Submenu is nested in a menu component and represents a navigation group.

For more information, see the Submenu Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
activate	Triggers when the submenu is clicked or selected by any other means.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

row

Renders a set of ace:column components as one row of the header or footer segment of an ace:dataTable via an ace:columnGroup.

For more information, see the Row Wiki Documentation.

chart

Render a HTML <canvas&rt; data visualization using a Java interface to the jqPlot charting API. A List of ChartSeries subclasses define the data and its representation in the visualization.

For more information, see the Chart Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
click	Fired when data point is clicked plot.	javax.faces.event.AjaxBehaviorEvent
dragStart	Fired when a drag has begun on a particular drag-enabled plot data point.	javax.faces.event.AjaxBehaviorEvent
dragStop	Fired when a drag has ceased on a particular drag-enabled plot data point.	javax.faces.event.AjaxBehaviorEvent
mouseInData	Fired when the mouse is inside a filled plot region.	javax.faces.event.AjaxBehaviorEvent
mouseOutData	Fired when the mouse is outside a filled plot region.	javax.faces.event.AjaxBehaviorEvent
showHighlighter	Fired when the highlighter is being displayed by the mouse being near an enabled data point.	javax.faces.event.AjaxBehaviorEvent
hideHighlighter	Fired when the highlighter is being hidden by the mouse moving away from an enabled data point.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

selectMenu

For more information, see the SelectMenu Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
valueChange	Fired whenever the value of the component changes.	javax.faces.event.AjaxBehaviorEvent
blur	Fired any time the component loses focus.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

messages

The messages tag renders all Faces messages, all Faces messages for a specific component, or all Faces messages not associated with any component. If redisplay is true, a message is always rendered; if redisplay is false, a message is rendered only if it was undisplayed before. Styling is done by predefined jQuery classes in theme stylesheets:

Info: ui-icon-info w/ ui-state-highlight css
Warn: ui-icon-notice w/ ui-state-highlight css
Error: ui-icon-alert w/ ui-state-error css
Fatal: ui-icon-alert w/ ui-state-error css

simpleSelectOneMenu

A simple selection component that uses the browser's native "select" element and integrates with the ACE environment, supporting Themeroller, ARIA, label positioning, and ace:ajax.

For more information, see the SimpleSelectOneMenu Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
valueChange	Fired whenever the value of the component changes.	javax.faces.event.AjaxBehaviorEvent
blur	Fired any time the component loses focus.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

expansionToggler

Renders a control to toggle the expanded state of this row. If this table only contains either PanelExpansion or RowExpansion, that type of expansion will occur. If both are children of the table, the 'expansion type' for each row is configurable via the RowState.

For more information, see the Expansion Toggler Wiki Documentation.

tabPane

The TabPane component belongs inside of a TabSet component, and encapsulates both the clickable label, and the content pane that is shown when the TabPane is selected. The clickable label part may be specified by the label property, or by the label facet, allowing for any components to comprise the label.

For more information, see the TabPane Wiki Documentation.

Facets
label	Allows rendering of nested components as tab label.

tabSetProxy

The TabSetProxy component is used in conjunction with a server-side TabSet component that is not inside of a form. The TabSetProxy will then instead be placed inside of a form, to handle the server communication on behalf of the TabSet.

For more information, see the TabSetProxy Wiki Documentation.

tabSet

The TabSet component is a container for its TabPane children, each of which may contain any arbitrary components. Only one TabPane component is currently active, and its contents shown, at any given time. The TabSet may operate in a server-side mode, where only the current TabPane's contents exist in the browser; or in client-side mode, where every TabPane's contents exist in the browser, and no server round-trip is necessary to change TabPanes. The entire TabSet may exist within a single parent form, so that validation will apply to all of its contents, and so that validation may enforce remaining on the current TabPane if the user attempts to change the selected TabPane while other input components are in an invalid state. Also, a TabSet may exist outside of any form, perhaps with each TabPane containing their own child form, so that validation may be more limited in scope. In this case, a TabSetProxy may be used, in conjunction with the TabSet, so that the TabSetProxy may be placed in a form, for communicating with the server, removing the need for the TabSet itself to be in a form. When changing the selected TabPane, the TabSet may use application configurable animations to accentuate the transition from the previously selected TabPane to the newly selected TabPane. The label portion of the TabPanes may be shown on the bottom, top, left, or right of the TabSet. To support the capability of dynamically adding and removing TabPane(s) without updating the entire TabSet, there is a side-effect where any iframe(s) within them can get loaded twice in rapid succession, when first shown or subsequently updated. To eliminate the redundant load by deferring the loading until the TabSet is ready, do not use a src attribute on the iframe(s), but rather set the org.icefaces.ace.component.tabset.deferred_src attribute to what src would have been.

For more information, see the TabSet Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
clientSideTabChange	Fired when the tabSet has clientSide=true, and a tab change occurs. Use onstart="return false;" to limit javascript execution.	javax.faces.event.AjaxBehaviorEvent
serverSideTabChange	Fired when the tabSet has clientSide=false, and a tab change occurs (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

breadcrumbMenu BreadcrumbMenu is a horizontal bar of breadcrumb menu items. The crumbs are encoded by child menuItem tags. The menu items can be encoded inline or dynamically using a menu model (org.icefaces.ace.model.MenuModel). The icon attribute is not used. The icon will be forced to a home page icon for the first item and a right arrow icon for the rest. The last (or only) item will also be forced to be disabled.

maskedEntry

MaskedEntry is an input component that forces text input to be entered according to a specified format.

For more information, see the MaskedEntry Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
valueChange	Fired every time the value of the text input changes (default event). When pressing the ENTER key on the text field, this event will be fired as well, even if the value didn't actually change.	javax.faces.event.AjaxBehaviorEvent
keypress	Fired on a keypress event. Use only to read input char. Don't re-render or do JS-like event handling. Otherwise could cause focus and DOM update problems, losing both focus and value.	org.icefaces.ace.event.KeyPressEvent
blur	Fired any time the text input field loses focus.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

animation

The ace:animation tag provides a way to animate standard JSF components. Animations are based on the jQuery effects utilities.

For more information, see the Animation Wiki Documentation.

linkButton

The Link Button is a component that functions like an HTML link.

For more information, see the LinkButton Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
activate	Fired when the button is clicked or pressed by any other means (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

listExporterValue

Embedding instances of this component inside ace:list causes ace:listExporter to export the values specified by these instances as separate columns for the same item, instead of rendering other nested markup.

For more information, see the ListExporterValue Wiki Documentation.

checkboxButton

The Checkbox Button is a component that allows entry of a button which supports browsers that see checkbox as true or false, yes or no, on or off. The Themeroller check icon will be displayed by default when the checkbox is checked. Override the .ui-icon-check class to display a different image.

For more information, see the CheckboxButton Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
activate	Fired when the button is clicked or pressed by any other means (default event).	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

node

Defines the contents of a node of the parent tree. Multiple nodes of different types can be rendered by the same tree by matching the ace:tree 'type' property.

For more information, see the Node Wiki Documentation.

dataExporter

Utility to export data from a datatable as an Excel, PDF, XML or CSV document. This component renders an HTML button. More components and HTML elements can be nested inside this tag to give a different look to the button.

For more information, see the DataExporter Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
activate	Triggers when the button is clicked or pressed by any other means. By default, both this data exporter component and the target table are executed in this ajax request.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

menuColumn

MenuColumn is nested in a MultiColumnMenu component and represents a column of submenus and menu items.

For more information, see the MenuColumn Wiki Documentation.

tree

Renders a hierarchical structure of ace:node contents. Supports client-side and server-side node selection and expansion. Other features available include: user reordering of nodes, multiple selection and lazy node state initialization.

For more information, see the Tree Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
expand	Fired when a node switch is clicked to show children a node.	javax.faces.event.AjaxBehaviorEvent
contract	Fired when a node switch is clicked to hide children a node.	javax.faces.event.AjaxBehaviorEvent
select	Fired when a node is clicked to select it.	javax.faces.event.AjaxBehaviorEvent
deselect	Fired when a selected node is clicked to deselect it.	javax.faces.event.AjaxBehaviorEvent
reorder	Fired when a node is dragged into a new position.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

themeSelect

The themeSelect component can be used to dynamically change the current ACE ThemeRoller theme in the application.

For more information, see the ThemeSelect Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
valueChange	Fired when theme changes (default event). Theme change done on client side. Event used just for syncing with server side.	javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

dialog

The Dialog is a container component that can overlay other elements on page. Dialog has several customization options such as modal, resize, width, height, position. If position of dialog is out of place, try putting it as last child of body.

For more information, see the Dialog Wiki Documentation.

Client Events
Name	Description	Supported classes for argument
close	Fired when the panel is closed (default event).	org.icefaces.ace.event.CloseEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

dynamicResource

Overview

Library

Tag

Help

FRAMES NO FRAMES

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.