| |||||||
| FRAMES NO FRAMES | |||||||
<%@ taglib prefix="ice" uri="http://www.icesoft.com/icefaces/component" %>
<anyxmlelement xmlns:ice="http://www.icesoft.com/icefaces/component" />
| Tag Library Information | |
| Display Name | None |
| Version | 0.01 |
| Short Name | ice |
| URI | http://www.icesoft.com/icefaces/component |
| Tag Summary | |
| panelSeries |
The panelSeries component provides a mechanism for dynamically generating a series of repeating child-components within a panel. This component renders its child components in an iterative fashion similar to way the dataTable component renders data rows. However, the panelSeries component is more flexibile in that it can render a series of arbitrarily complex child components. The dataset can be defined and used by implementing the value and var attributes respectively. |
| outputConnectionStatus |
The outputConnectionStatus component displays the information about the status of the network connection between the client browser and the server. The component displays one of 4 possible states, which are as follows.
1. Active: The connection is alive and there is a request pending. The outputConnectionStatus component provides an ideal mechanism to provide continuous real-time feedback to users of the status of their ICEfaces application. It is particularly important to inform users when the application is busy sending and receiving data in response to a user-initiated action to manage their expectations with respect to application readiness for additional user input. Generally, the outputConnectionStatus component should be located in a consistent location throughout an ICEfaces application. NOTE: A web-page may only contain a single outputConnectionStatus component. Using more than one outputConnectionStatus component on the same web page will result in erratic results. |
| outputProgress |
The outputProgress component can be used to report progress to users in cases where a long running server-side task is necessary. This component can be run in either of two modes; "determinate" and "indeterminate". Determinate mode should be used in cases where the number of steps or units of work in a long-running process are known. In determinate mode (default) the outputProgress component renders a progress bar that indicates the completion percentage for a task. Typically, the progress bar will gradually progress from 0 to 100 % complete in incremental steps determined by the application. Indeterminate mode should be used in cases when it is not possible to predicate how long a long-running process will take to complete, or how many steps or units of work are required to complete the task. In indeterminate mode the outputProgress component renders an animated icon or progress bar that indicates generally that activity is taking place. |
| inputFile |
The inputFile component renders an file input HTML element. Users specify a file to upload
either by entering the path to a file directly, or by clicking the Browse button
to open a file-system navigation dialog window. Clicking the Upload button uploads
the specified file to the server. |
| tree |
The tree component displays hierarchical data as a "tree" of branches and leaf nodes. Optionally, the tree may also display navigation controls for the dynamic expansion and collapse of branch nodes. The tree component can be used in cases where a hierarchical data structure must be viewed and navigated. It is typically used for menu-style applications, where the user selects a tree node and the application responds with an action related to the selected node. In implementing a tree tag, the application developer must provide and declare in the JSP a tree tag and a single treeNode tag as a child of the tree tag. The tree tag should declare the "value" attribute to be a value binding to a backing bean that will return an object that implements the javax.swing.tree.TreeModel interface. The TreeModel must contain a tree of DefaultMutableTreeNode instances. Each DefaultMutableTreeNode instance encapsultes an IceUserObject. The IceUserObject is the extension point for the application developer. If the IceUserObject does not provide sufficient state for representation of the tree's nodes, then the application developer should extend the IceUserObject and add state as required to their extension. When creating an IceUserObject, the DefaultMutableTreeNode wrapper must be provided to the constructor. Then the node's state can be set to the attributes on the IceUserObject including:
The "binding" attribute can be defined so that the application developer will have access to the Tree component in the application's backing bean. The "var" attribute can be declared on the tree tag such that the treeNode tag's children have access to the state of the TreeModel's node that it represents. See the documentation for the treeNode tag for a description of supported facets. |
| treeNode |
The treeNode tag provides the template that be applied in rendering each node in the backing data model. The treeNode tag supports two facets:
|
| menuBar |
The menuBar component provides a robust menu system that supports:
1. Nested child menuItem and menuItemSeparator components. Support for menuItemCheckbox and menuItemRadio
components are planned for a future release. See the menuItem component's description for more relevant information. |
| menuItem | MenuItem components are the menu items contained by a menuBar. The value attribute defines the label displayed for the menuItem. The icon attribute can be used to specify an image that displays on the left side of the menuItem. The action and actionListener attributes operate in the same way os the standard component attributes of the same name. The menuItem component is only used in the static approach to defining the heirarchy of menu items. |
| menuItems | This is the submenu component to use if you want to supply a (potentially) dynamic heirarchy of menuItems. |
| menuItemSeparator | |
| panelTab |
Renders an individual Panel Tab. Must be contained within a TabbedPane. |
| panelTabSet |
The panelTabSet is a container component which itself contains one or more panelTab
components, which are also container components. The panelTabSet component displays the "active"
panelTab, hiding the contents of the others. Users can select which panelTab to make visible by
clicking on the tab header of the panelTab that they want to display. Deafult styleClass value: icePanelTab
|
| tabChangeListener | No Description |
| selectInputDate |
The selectInputDate component renders a localized dateSelect. Users may select a date by clicking
on a date in the displayed month. The displayed month and year can be changed using arrow buttons.
Optionally, the selectInputDate component may be used in popup mode. In this mode an inputText
component is rendered that displays the selected date. Users may enter a date directly into the
inputText component, or optionally click a button beside the inputText component to display a popup
dateSelect view. Selecting a date in the dateSelect closes the popup dateSelect view and updates the
selected date. |
| dataPaginator |
The dataPaginator component is used in conjunction with a dataTable. The dataPaginator may be used
to render a set of page navigation facets and access attributes of the underlying DataModel specified
in the associated dataTable. Using the dataPaginator, a dataTable containing a large DataModel can
be viewed as multiple "pages" of table rows instead of as one large table. |
| commandSortHeader |
The commandSortHeader component is used in conjunction with a dataTable.
The commandSortHeader renders a clickable column header facet allowing the user to toggle
the sort order of data in the table, either ascending or descending based on the values in
the column. |
| panelBorder |
The panelBorder is a layout container component that arranges and resizes specified child
containers to fit in five regions: north, south, east, west, and center. These regions are
defined using facets. |
| panelStack |
The panelStack is a container component that itself contains multiple panel groups.
A single contained panel group is visible at one time, filling the area covered by
the panelStack component. The panel group specified in the selectPanel attribute will
be visible, with the others being hidden. |
| panelPopup |
The panelPopup is a container component that renders a window or panel that hovers on
top of a web page. The popupPanel contains 2 regions which are defined using facets.
The facet names are; header and body. |
| selectInputText |
The selectInputText component provides an inputText component enhanced with auto-complete functionality. As the user enters text into the component it provides a popup list of possible matching values that the user may select from. The component predicts a word or phrase that a user wants to type in without the user actually completely typing it in. The selectInputText component requires developers to implement the matching list search algorithm in their backing bean.
The selectInputText component can generate one of two types of lists: |
| commandButton |
Renders an HTML "input" element. Decode Behavior Obtain the Encode Behavior Render the clientId of the component as the value of the "name" attribute. Render the current value of the component as the value of the "value" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. Default style class: iceBtn |
| commandLink |
Render an HTML "a" anchor element that acts like a form submit button when clicked. General Behaviour Both the encode and decode behavior require the ability to get the id/name for a hidden field whose value is set by the JavaScript form submit. This name must be constructed as follows:
In the following text, this String is called hiddenFieldName. Decode Behavior Obtain the "clientId" property of the component. Obtain the
Encode Behavior Render "#" as the value of the "href" attribute. Render the current value of the component as the link text if it is specified. Render javascript that is functionally equivalent to the following as the value of the "onclick" attribute:
document.forms['CLIENT_ID'].submit()" where hiddenFieldName is as described above, CLIENT_ID is the clientId of the UICommand component, PARAM*_NAME and PARAM*_VALUE are the names and values, respectively, of any nested UIParameter children. The name and the value must be URLEncoded. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. Render any non-UIParameter children as normal inside of the "a" element. These will appear as the link text. Allow the form renderer to output a single "input" element (for the entire page, regardless of how many command link components are in the page) of "type" "hidden" whose "name" is the value of hiddenFieldName, and which must not have a "value" attribute. Multiple occurrences of command link components in the tree should not cause multiple hiddenFieldName hidden fields. Allow the form renderer to output an "input" element of "type" "hidden" for each of the nested UIParameter children, taking the name property (but not the value) from each one in turn. |
| dataTable |
Renders an HTML "table" element compliant with the HTML 401
specification. Please consult the javadoc for Rendering the header If the If any of the child Close out the "thead" element. Rendering the footer Follow the same process as for the header, except replace "header" with "footer", "th" with "td", "thead" with "tfoot", and "headerClass" with "footerClass". Do not render any "scope" attribute for the footer. Rendering the table body Render a "tbody" element. Keep track of the result of the
"rows" property on the When done rendering all the rows, set the "rowIndex" property of
the |
| form |
Renders an HTML "form" element. Decode Behavior Obtain the Encode Behavior The value of the "method" attribute must be "post". The value
of the "action" attribute must be the result of passing the view
identifier of the current view to the |
| inputText |
Renders an HTML "input" element of "type" "text". Obtain the Encode Behavior Render the clientId of the component as the value of the "name" attribute. Render the current value of the component as the value of the "value" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. |
| inputTextarea |
Renders an HTML "textarea" element. Decode Behavior See the encode description for the Input Text renderer. Encode Behavior Render the clientId as the value of the "name" attribute. Render the current value of the component inside the "textarea" element. |
| panelGrid |
Renders an HTML "table" element, conforming to the
rules in the HTML 401 specification. If the "styleClass"
attribute is specified, render its value as the value of the
"class" attribute. Render the pass-through attributes in the
table below. Render the "header" facet, if present, inside of
"thead", "tr", and "th" elements, nested in that order. If the
"headerClass" attribute is specified, render its value as the value
of the "class" attribute on the "th" element. Render "colgroup"
as the value of the "scope" attribute. Render the value of the
"columns" attribute as the value of the "colspan" attribute on the
"th" element. Render the "footer" facet if present, using similar
logic to the rendering of the "header", but replacing "thead" with
"tfoot", "th" with "td", and "headerClass" with "footerClass".
Render the children of the UIPanel component inside
of a "tbody" element. Render the children based on the value of
the "columns" attribute, creating a new row each time a "columns"
worth of children have been rendered. Each child is rendered
inside of a "td" element. If a child has "rendered==false" it is
not rendered, and the column counter must not be incremented.
|
| panelGroup |
The panelGroup component is intended for use in situations when only one UIComponent child can be nested, such as in the case of facets. The panelGroup component renders a "div" element around it's child components, outputting the value of the "style" attribute as the value of the "style" attribute, and the value of the "styleClass" attribute as the value of the "class" attribute. The panelGroup can also provide Drag & Drop functionality to it's child components. See the Drag & Drop documentation details. The panelGroup component can also be used to apply a single Effect (Fade, Show, etc.) to a set of child-components by adding the components to the panelGroup and specifying the effect on the panelGroup "effect" attribute. |
| selectBooleanCheckbox |
Renders an HTML "input" element of type "checkbox". Decode Behavior Obtain the Encode Behavior Render the clientId of the component as the value of the "name" attribute. If the current value of the component is "true", output the "checked" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. |
| selectManyCheckbox |
Render an HTML checkbox list. See the "Decode Behavior for UISelectMany Components" section. Encode Behavior Render a "table" element. If the "styleClass" is specified, render the
value of the "styleClass" attribute as the value of the "class" attribute
on the "table" element. If the "style", "border" attributes are specified,
pass them thru. If the "layout" attribute is specified, and its
value is "pageDirection", render the children elements vertically,
otherwise horizontally, in the table. If any of the children are
an instance of SelectItemGroup, render them as a nested table.
Each of the children are ultimately rendered as follows. Render
a "label" element. Inside of the "label", render an "input" element
of "type" "checkbox" for each child component. As an exception to
the general rules about how to handle the "id" attribute, render it
as an attribute on the outer "table" element, the value of which is the
|
| selectManyListbox |
Render an HTML option list. Decode Behavior This section documents the decode behavior for all renderers
that handle Decode Behavior for
Obtain the Decode Behavior for
Obtain the Encode Behavior Render an HTML "select" element. Render the clientId of
the component as the value of the "name" attribute. If the "styleClass"
attribute is specified, render its value as the value of the "class"
attribute on the "select" element. If the component is a
Rendering the "option" elements The only valid children of this component are
|
| selectManyMenu |
Render an HTML option list. See the "Decode Behavior for UISelectMany Components" section. Encode Behavior Render an HTML "select" element. Render the clientId of
the component as the value of the "name" attribute. If the "styleClass"
attribute is specified, render its value as the value of the "class"
attribute on the "select" element. If the component
to be rendered is a UISelectMany, render "true" as the value of
the "multiple" attribute. Render "1" as the value of the "size"
attribute. See the "Rendering the option
elements" specification for |
| selectOneListbox |
Render an HTML option list. See the "Decode Behavior for UISelectOne Components" section. Encode Behavior Render an HTML "select" element. Render the clientId of
the component as the value of the "name" attribute. If the "styleClass"
attribute is specified, render its value as the value of the "class"
attribute on the "select" element. If the component
to be rendered is a UISelectMany, render "true" as the value of
the "multiple" attribute. If the "size" attribute is specified,
render its value as the value of the "size" attribute. Otherwise
use the number of items as the value of the "size" attribute. See
the "Rendering the option
elements" specification for |
| selectOneMenu |
Render an HTML option list. See the "Decode Behavior for UISelectOne Components" section. Encode Behavior Render an HTML "select" element. Render the clientId of the
component as the value of the "name" attribute. If the
"styleClass" attribute is specified, render its value as the value
of the "class" attribute on the "select" element. If the component
to be rendered is a UISelectMany, render "true" as the value of
the "multiple" attribute. Use the number of items as the value of
the "size" attribute. See the "Rendering
the option elements" specification for
|
| selectOneRadio |
Render a set of html "input" elements of type "radio". See the "Decode Behavior for UISelectOne Components" section. Encode Behavior Render a "table" element. If the "styleClass" is specified, render the
value of the "styleClass" attribute as the value of the "class" attribute
on the "table" element. If the "style", "border" attributes are specified,
pass them thru. If the "layout" attribute is specified, and its
value is "pageDirection", render the children elements
vertically, otherwise horizontally, in the table. If any of the
children are an instance of SelectItemGroup, render them as a
nested table. Render a "label" element. Each of the children are
ultimately rendered as an "input" element of "type" "radio". As an
exception to the general rules about how to handle the "id" attribute,
render it as an attribute on the outer "table" element, the value of which
is the |
| column |
Renders a UIComponent that represents a single column of data within a parent |
| graphicImage |
Renders an HTML "img" element. Render the clientId
as the value of the "id" attribute. Render the value of the
component as the value of the "src" attribute, after passing it
to the getResourceUR() method of the ViewHandler
for this application, and passing the result
through the encodeResourceURL() method of the
ExternalContext. If present, render the value of the
alt attribute as the value of the "alt" attribute. If the
"styleClass" attribute is specified, render its value as the value
of the "class" attribute.
|
| inputHidden |
Renders an HTML "input" element of type "hidden". Decode Behavior See the decode description for the Input Text renderer. Encode Behavior Render the clientId of the component as the value of the "name" attribute. Render the current value of the component as the value of the "value" attribute. |
| inputSecret |
Renders an HTML "input" element of "type" "password". Decode Behavior See the decode description for the Input Text renderer. Encode Behavior Render the clientId of the component as the value of the "name" attribute. Render the current value of the component as the value of the "value" attribute, if and only if the "redisplay" component attribute is the string "true". If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. |
| message |
Render a single message for a specific component. Set-up for Rendering Obtain the "summary" and "detail" properties from
Rendering For the message renderer, we only render
one row, for the first message. For the messages renderer, we
render as many rows as we have messages. If either of the "style"
or "styleClass" attributes has a non-null value (as determined
above), render a "span" element, outputting the value of the
"style" attribute as the the value of the "style" attribute, and
outputting the value of the "styleClass" attribute as the value of
the "class" attribute on the "span" element. If the
|
| messages |
The same as for the Message renderer, but output all the
messages. If the value of the "layout" attribute is "table",
render nested "table", "tr", and "td" elements, in that order,
otherwise, don't render the table. The component is a
|
| outputFormat |
Render parameterized text. Obtain the |
| outputLabel | Renders an HTML "label" element. Render the current value of the component as label text if it is specified. If a "for" attribute is specified, find the component specified by the value of the "for" attribute, and render its client id as the value of the "for" attribute. If "styleClass" attribute is specified, render its value as the value of the "class" attribute. |
| outputLink |
Render an HTML "a" anchor element. The value of the
component is rendered as the value of the "href" attribute. Any
child UIParameter components are appended to the String to be
output as the value of the "href" attribute as query parameters
before rendering. The entire "href" string must be passed through
a call to the encodeResourceURL() method of the
ExternalContext. The name of the UIParameter goes on
the left hand side, and the value of the UIParameter on the right
hand side. The name and the value must be URLEncoded. Each
UIParameter instance is separated by an ampersand, as dictated in
the URL spec. If the "styleClass" attribute is specified, render
its value as the value of the "class" attribute.
|
| outputText | If the "styleClass" or "style" attributes are present, render a "span" element. If the "styleClass" attribute is present, render its value as the value of the "class" attribute. If the "style" attribute is present, pass it thru. If the "escape" attribute is not present, or it is present and its value is "true" all angle brackets should be converted to the ampersand xx semicolon syntax when rendering the value of the "value" attribute as the value of the component. If the "escape" attribute is present and is "false" the value of the component should be rendered as text without escaping. |
| outputDeclaration | The outputDeclaration component causes a DOCTYPE declaration to be placed at the beginning of the output document. <ice:outputDeclaration doctypeRoot="HTML" doctypePublic="-//W3C//DTD HTML 4.01 Transitional//EN" doctypeSystem="http://www.w3.org/TR/html4/loose.dtd" />will insert the following at the beginning of the document <!DOCCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd" > |
| |||||||
| FRAMES NO FRAMES | |||||||