uitags
This is version 0.6.12 .
-
all Placed within other tags in the library, the presence
of this tag is a shortcut to including all children of the enclosing
tag .
-
attribute A tag that allows JSP developers to add an additional HTML
attribute for the enclosing JSP tag (must be a tag that has a
corresponding HTML tag) .
-
category Renders the select box containing category options .
-
disable Specifies the widget that gets disabled when the observed
widgets hold their trigger values .
-
enable Specifies the widget that gets enabled when the observed
widgets hold their trigger values .
-
except Child of the 'all' tag, this tag allows for selective
exclusion of certain tags .
-
fastTick Renders a convenience JavaScript button which ticks or
unticks a group of checkboxes .
-
formGuide The outer-most tag in the form guide facility, wrapping
<observe>, <enable>, and <disable> tags .
-
info Renders a convenience JavaScript button which displays
an information panel when clicked .
-
infoToggle Renders a convenience JavaScript button which hides/shows
info buttons .
-
observe Specifies the widget that triggers the enabling/disabling
of other widgets when it holds a certain value .
-
observeForNull Specifies the widget that triggers the enabling/disabling
of other widgets when it does not hold any value (i .
-
off Specifies toggle button appearance when the toggle is off .
-
on Specifies toggle button appearance when the toggle is on .
-
optionTransfer
The outer-most tag in the option transfer facility, other related tags
are nested within it .
-
quickSearch Renders a checkbox to indicate whether a search session is a
quick one .
-
remind A session expiry reminder that will display itself
at a pre-set time .
-
return Renders a button to move options in the target select box
back to the source select box .
-
returnAll Renders a button to move all options in the target select box
back to the source select box .
-
searchRequest Renders a link that brings up a search window when clicked .
-
searchResult Renders a radio button/checkbox to allow user select/deselect
search result(s) .
-
select Renders a button to conveniently select a group of options
in the target select box .
-
shift Renders a button to shift (upwards or downwards) a group of
options in the target select box .
-
shiftDistance Renders a text box for specifying the distance by which
selected options are to be shifted .
-
sort Renders a button to sort options in the target select box .
-
source Renders the select box containing options to be transferred to
the target select box .
-
target Renders the select box holding transferred options (those that
will be sent to the server when the form is submitted) .
-
timer A hidden session timer as well as container for reminders .
-
timerStop Prints JavaScript code that stops the timer in main window
(opener window) .
-
transfer Renders a button to move selected options from source to
target select box .
-
transferAll Renders a button to move all options from source to
target select box .
Required attributes are marked with a * .
attribute
A tag that allows JSP developers to add an additional HTML
attribute for the enclosing JSP tag (must be a tag that has a
corresponding HTML tag).
At the moment, only optionTransfer child tags and fastTick tag support
this functionality.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| *name | Name of the tag attribute. | String |
| *value | Value of the tag attribute. | String |
formGuide
The outer-most tag in the form guide facility, wrapping
<observe>, <enable>, and <disable> tags.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| *form | Name of the form containing the widgets specified by
<observe>, <enable>, and <disable>. | String |
observe
Specifies the widget that triggers the enabling/disabling
of other widgets when it holds a certain value. This tag may be
specified more than once within a <formGuide>, in which case
no widgets get disabled unless all observed widgets hold their trigger
values.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| *forValue | Widget value that triggers the enabling/disabling of other
widgets. | String |
| *widget | Name of the widget to observe. | String |
observeForNull
Specifies the widget that triggers the enabling/disabling
of other widgets when it does not hold any value (i.e. not selected
or not checked).
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| *widget | Name of the widget to observe. | String |
enable
Specifies the widget that gets enabled when the observed
widgets hold their trigger values.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| *widget | Name of the widget to enable. | String |
disable
Specifies the widget that gets disabled when the observed
widgets hold their trigger values.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| *widget | Name of the widget to disable. | String |
timer
A hidden session timer as well as container for reminders.
Must contain at least one child <remind> tag.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| *renewUrl | URL of the page for renewing sessions. | String |
| *seconds | The number of seconds before user's session
expires. | int |
remind
A session expiry reminder that will display itself
at a pre-set time. This tag is child of <timer>.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| message | Reminder message. | String |
| showLink | Whether uitags should display a link to the
session renewal page to accompany the reminder. | boolean |
| *when | Number of seconds prior to session expiry, which is
the time when this reminder is to be triggered. Must be a negative
integer. | int |
timerStop
Prints JavaScript code that stops the timer in main window
(opener window).
Can contain: empty
Attributes
| This tag has no attributes. |
searchRequest
Renders a link that brings up a search window when clicked.
Behind the scenes the tag also generates hidden fields to make
communication with the search window possible.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of the 'Search' and 'Quick Search'
links (<a> elements), and a <span> which wraps around
these anchor elements. | String |
| clearLabel | The wording of the generated 'Clear' link. | String |
| *form | Name of the HTML form which contains the select box that
"requests" the search. See the 'select' attribute. | String |
| qsearchLabel | The wording of the generated 'Quick Search' link. | String |
| searchLabel | The wording of the generated 'Search' link. | String |
| *select | Name of the select box that "requests" the search
(that is, the box that gets populated with search results). | String |
| template | File path to an external custom template. | String |
| *url | URL of the search page: the page where user enters
the search pattern. | String |
quickSearch
Renders a checkbox to indicate whether a search session is a
quick one. More importantly, it renders hidden elements that are
essential for communication with the requesting select box. This tag
must have a <searchResult> as its child tag.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of the checkbox and
the <span> element which wraps around the checkbox's label
string. | String |
| label | Label for the checkbox. | String |
| onFail | Error message to display if the requestor is a
single-sized select box, yet there are more than one search result
that have to go into the select box. | String |
| template | File path to an external custom template. | String |
searchResult
Renders a radio button/checkbox to allow user select/deselect
search result(s). A radio button is rendered if the requestor is a
single-sized select box; otherwise a checkbox is. This tag should be
placed inside a loop that iterates over the search results. The loop
itself must be enclosed by <quickSearch>. This tag has 2 attribute
sets which are mutually exclusive: var + scope (optional) + valueProp +
labelProp vs. value + label.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of the radio button/checkbox. | String |
| label | Directly sets the label of the search result. | String |
| labelProp | Property of the search result bean that holds the 'label'
to be displayed to the user. | String |
| scope | The scope in which the bean specified by the 'var'
attribute resides. | String |
| value | Directly ets the value of the search result. | String |
| valueProp | Property of the search result bean that holds the 'value'
(aka the ID value). | String |
| var | Name of the scoped attribute that holds the search
results. The tag expects the attribute to be a bean or a map;
it accesses information through reflection. | String |
optionTransfer
The outer-most tag in the option transfer facility, other related tags
are nested within it. This tag provides option transfer core
functionalities.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | 'class' attribute of the HTML table that manages the
default layout. This attribute must not be specified when the value
of the 'overrideLayout' attribute is 'true'. | String |
| overrideLayout | Specifies whether to override the default layout provided
by the taglib. If value is 'true', the HTML layout specified in the
tag body will be used. Otherwise, each component inside the tag will
be placed according to the default layout. Never use a runtime or
EL expression for this attribute. | boolean |
category
Renders the select box containing category options.
This tag must also be specified when <all> is used,
as it implicitly renders a category select box. This tag
is optional. To specify the select box's options, use one of these
mutually exclusive attribute sets: fromSource vs. items vs.
var + scope (optional). Regardless of the attribute set used,
if the options are of type java.util.Map, the map's keys
are taken as the select box's option values, and the map's values as
the select box's option labels. Otherwise, the options must be
a java.util.Collection of Java beans. In this case, the 'valueProp'
and 'labelProp' attributes must be used to specify the bean properties
that return value and label respectively.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of the select box. | String |
| fromSource | If this attribute is present, uitags iterates
through <source>'s options
and performs introspection on each option to get its category bean.
This attribute specifies the Java bean property to be used during
introspection. | String |
| items | This select box's options. Must evaluate to a java.util.Map
or a java.util.Collection of Java beans. | Object |
| labelProp | Name of the Java bean property that returns the label
of each select option. | String |
| scope | The scope in which the object specified by the 'var' attribute
resides. | String |
| template | File path to an external custom template. | String |
| valueProp | Name of the Java bean property that returns the value
of each select option. | String |
| var | Name of the scoped attribute that holds this select box's
options. Must point to a java.util.Map or a java.util.Collection of
Java beans. | String |
source
Renders the select box containing options to be transferred to
the target select box. This tag is required.
To specify the select box's options, use one of these
mutually exclusive attribute sets: fromSource vs. items vs.
var + scope (optional). Regardless of the attribute set used,
if the options are of type java.util.Map, the map's keys
are taken as the select box's option values, and the map's values as
the select box's option labels. Otherwise, the options must be
a java.util.Collection of Java beans. In this case, the 'valueProp'
and 'labelProp' attributes must be used to specify the bean properties
that return value and label respectively.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| categoryIdProp | Name of the Java bean property that returns each item's
category ID. This must be specified if both <category>'s
'fromSource' and <source>'s 'fromCategory' aren't
specified. | String |
| class | HTML 'class' attribute of the select box. | String |
| fromCategory | If this attribute is present, uitags iterates
through <category>'s options
and performs introspection on each option to get its items.
This attribute specifies the Java bean property to be used during
introspection. | String |
| items | This select box's options. Must evaluate to a java.util.Map
or a java.util.Collection of Java beans. | Object |
| labelProp | Name of the Java bean property that returns the label
of each select option. | String |
| scope | The scope in which the object specified by the 'var' attribute
resides. | String |
| template | File path to an external custom template. | String |
| valueProp | Name of the Java bean property that returns the value
of each select option. | String |
| var | Name of the scoped attribute that holds this select box's
options. Must point to a java.util.Map or a java.util.Collection of
Java beans. | String |
target
Renders the select box holding transferred options (those that
will be sent to the server when the form is submitted). This tag is
required. This tag has 2 attribute sets which are mutually exclusive:
var + scope (optional) vs. items. You may use either set to prepopulate
the select box.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of the select box. | String |
| items | This select box's options. Must evaluate to a java.util.Map
or a java.util.Collection of Java beans. Items with values that match
the values in source are automatically linked, thus the items can be
returned to the source box. The labels of these items are ignored, so
the label of the corresponding source items will be used instead.
On the other hand, items that do not correspond to any of the items
in the source cannot be returned back to the source. | Object |
| labelProp | Name of the Java bean property that returns the label
of each select option. | String |
| *name | HTML 'name' attribute of the select box. | String |
| scope | The scope in which the object specified by the 'var' attribute
resides. | String |
| template | File path to an external custom template. | String |
| valueProp | Name of the Java bean property that returns the value
of each select option. | String |
| var | Name of the scoped attribute that holds this select box's
options. Must point to a java.util.Map or a java.util.Collection of
Java beans. | String |
transfer
Renders a button to move selected options from source to
target select box. The attributes 'value' and 'image'
are mutually exclusive.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
transferAll
Renders a button to move all options from source to
target select box. The attributes 'value' and 'image'
are mutually exclusive.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
return
Renders a button to move options in the target select box
back to the source select box. The attributes 'value' and 'image'
are mutually exclusive.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
returnAll
Renders a button to move all options in the target select box
back to the source select box. The attributes 'value' and 'image'
are mutually exclusive.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
sort
Renders a button to sort options in the target select box.
The attributes 'value' and 'image' are mutually exclusive.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| *type | Valid values are 'asc' for ascending sort and
'desc' for descending sort. Never use a runtime or
EL expression for this attribute. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
select
Renders a button to conveniently select a group of options
in the target select box. The attributes 'value' and 'image' are
mutually exclusive.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| *type | Valid values are 'all'
and 'invert'. The 'all' button selects all options. The 'invert'
button inverts current selection. Never use a runtime or
EL expression for this attribute. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
shiftDistance
Renders a text box for specifying the distance by which
selected options are to be shifted.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this text box. | String |
| template | File path to an external custom template. | String |
| value | Default distance value. | String |
shift
Renders a button to shift (upwards or downwards) a group of
options in the target select box.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| *type | Valid values are 'up', 'down', 'first', and 'last'.
'up' and 'down' shift options by a distance specified by
<shiftDistance>; 'first' and 'last' shift options to the top
and bottom of the list respectively. Never use a runtime or
EL expression for this attribute. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
all
Placed within other tags in the library, the presence
of this tag is a shortcut to including all children of the enclosing
tag.
Can contain: JSP
Attributes
| This tag has no attributes. |
except
Child of the 'all' tag, this tag allows for selective
exclusion of certain tags.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| *tag | Name of the tag to be excluded. | String |
fastTick
Renders a convenience JavaScript button which ticks or
unticks a group of checkboxes. The attributes 'value' and 'image'
are mutually exclusive.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| *for | Name of the checkboxes to tick/untick. All these
checkboxes must have the same name. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| *type | Type of convenience button to render. Valid values
are 'all', 'invert', and 'range'. The 'all' button alternately
ticks and unticks all checkboxes. The 'invert' button
ticks unticked and unticks ticked checkboxes. The 'range' button
ticks checkboxes that are between pairs of ticked ones. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
info
Renders a convenience JavaScript button which displays
an information panel when clicked.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| alwaysVisible | Specifies whether the button is always displayed or
can be hidden using toggle button. | boolean |
| class | HTML 'class' attribute of this info button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| panelClass | HTML 'class' attribute of the info panel. | String |
| template | File path to an external custom template. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
infoToggle
Renders a convenience JavaScript button which hides/shows
info buttons. This tag can only appear at most once in a page.
Can contain: JSP
Attributes
| Name | Description | Type |
|---|
| initialMode | Determines whether all info buttons should initially be
displayed. All info buttons that do not have their 'alwaysVisible'
attribute set to 'true' will be affected by this option. | String |
| initialModeScope | The scope in which the value specified by the
'initialMode' attribute resides. | String |
| initialModeVar | Name of the scoped attribute that holds the 'initialMode'
value. | String |
on
Specifies toggle button appearance when the toggle is on.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
off
Specifies toggle button appearance when the toggle is off.
Can contain: empty
Attributes
| Name | Description | Type |
|---|
| class | HTML 'class' attribute of this button. | String |
| image | Sets the button's label. If this attribute is specified,
an <input type="image"> is renderred instead of
<input type="button">. The value supplied must be the URL of
an image. | String |
| tooltip | Sets the button's tooltip text. | String |
| value | Sets the button's label. If this attribute is specified,
an <input type="button"> is renderred instead of
<input type="image">. | String |
