1.0
1.2
a
Alfresco Common JSF Components
Tag library consisting of Alfresco common JSF components i.e. those that
can be used in non-Alfresco projects
inputDatePicker
org.alfresco.web.ui.common.tag.InputDatePickerTag
JSP
Date Picker
Provides a custom renderer to display an input component with year, month, day drop-downs
id
false
true
The component identifier for this component
value
false
true
The current value of this component
binding
false
true
The value binding expression linking this component to a property in a backing bean
rendered
false
true
styleClass
false
true
style
false
true
startYear
false
true
The year to appear first in the list
yearCount
false
true
The number of years to display in the list
showTime
false
true
Determines whether to show the time
initialiseIfNull
false
true
Whether to initialise the control showing today's date if the
underlying value in the model is null. This will also hide the
None button thus disallowing the user to set the date back to null.
noneLabel
false
true
Label to use when there is no date currently set
richList
org.alfresco.web.ui.common.tag.data.RichListTag
JSP
The RichList component is capable of rendering a list of java bean objects in multiple rendering
modes. A List of objects is bound to the component through the value attribute and components
within the list can bind to specific fields (columns) through getter methods for each bean object
within the list. The component provides mechanism to page and sort data through additional
components
id
false
true
value
false
true
binding
false
true
rendered
false
true
styleClass
false
true
style
false
true
headerStyleClass
false
true
rowStyleClass
false
true
altRowStyleClass
false
true
width
false
true
var
false
true
initialSortColumn
false
true
initialSortDescending
false
true
listConfig
false
true
viewMode
false
true
pageSize
false
true
refreshOnBind
false
true
column
org.alfresco.web.ui.common.tag.data.ColumnTag
JSP
The column component is a child of a data container component such as the RichList. It should
always be contained within such a component. A column is simply a container for other components
which are themselves bound to values from the current row supplied when the parent data container
iterates over its content. The column has several well known facet components which can be used to
specify child components used for specific purposes during the list rendering process.
id
false
true
binding
false
true
rendered
false
true
styleClass
false
true
style
false
true
primary
false
true
actions
false
true
width
false
true
sortLink
org.alfresco.web.ui.common.tag.data.SortLinkTag
JSP
The sortLink component enables the user to sort a dataset by clicking an HTML link. The component
must be a child of a data component. It is generally contained inside a header facet component
within a column component. It automatically handles sorting of the appropriate data type for the
column bean getter method it is bound too. The control displays a small clickable icon to indicate
sorting direction and the direction of sorting can be toggled by clicking the icon. The component
does not require any developer intervention and therefore does not provide action command listeners.
id
false
true
value
true
true
binding
false
true
rendered
false
true
tooltip
false
true
styleClass
false
true
style
false
true
tooltip
false
true
mode
false
true
label
true
true
dataPager
org.alfresco.web.ui.common.tag.data.DataPagerTag
JSP
The dataPager component enables a user to page through a large dataset. The component must be a
child of a data component. It is generally contained within the footer area of a richList component
or similar. The component keeps track of the current page and displays it to the user. The
component does not require any developer intervention and therefore does not provide action
command listeners.
id
false
true
binding
false
true
rendered
false
true
styleClass
false
true
style
false
true
dataPagerType
false
true
displayInput
false
true
panel
org.alfresco.web.ui.common.tag.PanelTag
JSP
The progressive panel component enables the user to hide/show areas of the UI to progressive
display more complex areas of the UI as required. It also allows the developer to surround an
area of the UI with an attractive graphical border and title label. The component tags can
contain any combination of HTML or child JSF components. IMPORTANT NOTE: Currently there is an
issue in the SunRI and MyFaces impl of JSF whereby all child components of the panel must have an
id attribute specified if a progressive style panel is used - else an exception will occur when the
panel visibility is toggled by the user!
id
true
true
value
false
true
binding
false
true
rendered
false
true
styleClass
false
true
style
false
true
border
false
true
bgcolor
false
true
progressive
false
true
label
false
true
titleBorder
false
true
expandedTitleBorder
false
true
titleBgcolor
false
true
expanded
false
true
expandedActionListener
false
true
facetsId
false
true
breadcrumb
org.alfresco.web.ui.common.tag.BreadcrumbTag
JSP
The breadcrumb component enables the manipulation and display of a separated path string. It
displays HTML links to enable the user to immediately select any part of the breadcrumb path.
The breadcrumb provides standard action and actionListener command properties for developers to
handle user interaction with the component.
id
false
true
value
true
true
binding
false
true
rendered
false
true
tooltip
false
true
action
false
true
actionListener
false
true
style
false
true
styleClass
false
true
separator
false
true
showRoot
false
true
actionLink
org.alfresco.web.ui.common.tag.ActionLinkTag
JSP
The actionLink component provides the user with a clickable link, image or both to represent an
action in the UI. The component provides standard action and actionListener command properties
for developers to handle user interaction.
id
false
true
value
true
true
binding
false
true
rendered
false
true
action
false
true
actionListener
false
true
href
false
true
target
false
true
style
false
true
styleClass
false
true
tooltip
false
true
image
false
true
verticalAlign
false
true
showLink
false
true
padding
false
true
onclick
false
true
immediate
false
true
booleanEvaluator
org.alfresco.web.ui.common.tag.evaluator.BooleanEvaluatorTag
JSP
id
false
true
value
true
true
binding
false
true
valueSetEvaluator
org.alfresco.web.ui.common.tag.evaluator.ValueSetEvaluatorTag
JSP
id
false
true
value
true
true
binding
false
true
stringEqualsEvaluator
org.alfresco.web.ui.common.tag.evaluator.StringEqualsEvaluatorTag
JSP
id
false
true
value
true
true
binding
false
true
condition
true
true
menu
org.alfresco.web.ui.common.tag.MenuTag
JSP
The menu component displays a pop-up DHTML menu containing multiple ActionLink components.
A simple link and/or image is displayed to the user, which when clicked will pop-up a menu of
items. Each item is an ActionLink component with the image part rendered as the icon for the menu
item. Evaluators can be used to wrap ActionLink components or simply use the rendered attribute
directly to hide/show items as needed.
id
false
true
binding
false
true
rendered
false
true
tooltip
false
true
style
false
true
styleClass
false
true
menuStyle
false
true
menuStyleClass
false
true
itemSpacing
false
true
label
false
true
image
false
true
modeList
org.alfresco.web.ui.common.tag.ModeListTag
JSP
The ModeList component displays a graphical list of items, each with a label and optional icon
image. Only one of the items can be selected at any time. The currently selected item is shown in
a different style. When the selection is changed by the user, the component updates and fires a
standard actionListener event. Each item in the ModeList is represented by a ModeListItem
component. This component supplies the label, optional icon and also a value which is set as the
current value of the ModeList component when it becomes the selected item. The value can be
retrieved from the component during the actionListener event handler.
This component can be optionally rendered horizontally to display a toolbar like UI element. It
also features a large number of configurable CSS style elements to make it highly flexible in
rendering style.
id
false
true
binding
false
true
rendered
false
true
style
false
true
styleClass
false
true
labelStyle
false
true
labelStyleClass
false
true
itemStyle
false
true
itemStyleClass
false
true
disabledStyle
false
true
disabledStyleClass
false
true
itemLinkStyle
false
true
itemLinkStyleClass
false
true
selectedStyle
false
true
selectedStyleClass
false
true
selectedLinkStyle
false
true
selectedLinkStyleClass
false
true
selectedImage
false
true
itemSpacing
false
true
horizontal
false
true
iconColumnWidth
true
true
width
false
true
label
false
true
action
false
true
actionListener
false
true
value
false
true
disabled
false
true
menu
false
true
menuImage
false
true
listItem
org.alfresco.web.ui.common.tag.ListItemTag
JSP
Represents a single item within the ModeList component.
id
false
true
binding
false
true
rendered
false
true
tooltip
false
true
label
false
true
description
false
true
image
false
true
value
true
true
disabled
false
true
listItems
org.alfresco.web.ui.common.tag.ListItemsTag
JSP
Represents listItem components held in a Map or List object
id
false
true
rendered
false
true
value
true
true
cacheValue
false
true
imagePickerRadio
org.alfresco.web.ui.common.tag.ImagePickerRadioTag
JSP
The image picker component displays a list of images, of which one can be selected via radio
buttons. The list can be configured to display the images in any number of columns. Each item
in the list is represented by the modeListItem tag defined by the ModeList component.
A spacing (between the elements in the list) can be configured as well as the inline style or
CSS class for the list
id
false
true
value
false
true
binding
false
true
rendered
false
true
spacing
false
true
columns
false
true
style
false
true
styleClass
false
true
onclick
false
true
configSection
false
true
imagePickerRadioPanel
org.alfresco.web.ui.common.tag.ImagePickerRadioPanelTag
JSP
This component simply renders the image picker component inside a rounded
corner panel.
panelBorder
true
true
panelBgcolor
true
true
id
false
true
value
false
true
binding
false
true
rendered
false
true
spacing
false
true
columns
false
true
style
false
true
styleClass
false
true
onclick
false
true
configSection
false
true
convertXMLDate
org.alfresco.web.ui.common.tag.XMLDateConverterTag
JSP
Allows the XMLDateConverter to be used on a page
dateStyle
false
true
locale
false
true
pattern
false
true
timeStyle
false
true
timeZone
false
true
type
false
true
convertSize
org.alfresco.web.ui.common.tag.ByteSizeConverterTag
JSP
Allows the ByteSizeConverter to be used on a page
convertBoolean
org.alfresco.web.ui.common.tag.BooleanLabelConverterTag
JSP
Allows the BooleanLabelConverter to be used on a page
convertMultiValue
org.alfresco.web.ui.common.tag.MultiValueConverterTag
JSP
Allows the MulitValueConverter to be used on a page
dynamicDescription
org.alfresco.web.ui.common.tag.description.DynamicDescriptionTag
JSP
Displays a description that dynamically changes when another input
control on the page changes state
id
false
true
rendered
false
true
selected
false
true
functionName
false
true
description
org.alfresco.web.ui.common.tag.description.DescriptionTag
JSP
Represents a description option
id
false
true
rendered
false
true
controlValue
true
true
text
true
true
descriptions
org.alfresco.web.ui.common.tag.description.DescriptionsTag
JSP
Represents description options held in a Map object
id
false
true
rendered
false
true
value
true
true
errors
org.alfresco.web.ui.common.tag.ErrorsTag
JSP
Displays global errors within a gradient panel
id
false
true
message
false
true
rendered
false
true
styleClass
false
true
infoClass
false
true
errorClass
false
true
style
false
true
tooltip
false
true
httpSessionState
org.alfresco.web.ui.common.tag.debug.HttpSessionStateTag
JSP
Displays the current HTTP Session state in a table
id
false
true
rendered
false
true
title
false
true
httpRequestState
org.alfresco.web.ui.common.tag.debug.HttpRequestStateTag
JSP
Displays the current HTTP request state in a table
id
false
true
rendered
false
true
title
false
true
httpRequestParams
org.alfresco.web.ui.common.tag.debug.HttpRequestParamsTag
JSP
Displays the current HTTP request parameters in a table
id
false
true
rendered
false
true
title
false
true
httpRequestHeaders
org.alfresco.web.ui.common.tag.debug.HttpRequestHeadersTag
JSP
Displays the current HTTP request headers in a table
id
false
true
rendered
false
true
title
false
true
httpApplicationState
org.alfresco.web.ui.common.tag.debug.HttpApplicationStateTag
JSP
Displays the current HTTP Application state in a table
id
false
true
rendered
false
true
title
false
true
systemProperties
org.alfresco.web.ui.common.tag.debug.SystemPropertiesTag
JSP
Displays the system properties of the VM in a table
id
false
true
rendered
false
true
title
false
true
repositoryProperties
org.alfresco.web.ui.common.tag.debug.RepositoryPropertiesTag
JSP
Displays the Alfresco Repository properties in a table
id
false
true
rendered
false
true
title
false
true
genericPicker
org.alfresco.web.ui.common.tag.GenericPickerTag
JSP
id
false
true
binding
false
true
rendered
false
true
showFilter
false
true
showContains
false
true
showAddButton
false
true
filterRefresh
false
true
multiSelect
false
true
addButtonLabel
false
true
searchButtonLabel
false
true
action
false
true
actionListener
false
true
width
false
true
height
false
true
filters
false
true
queryCallback
true
true
outputText
org.alfresco.web.ui.common.tag.OutputTextTag
JSP
id
false
true
value
true
true
styleClass
false
true
style
false
true
encodeForJavaScript
false
true
statusMessage
org.alfresco.web.ui.common.tag.StatusMessageTag
JSP
The Status Message component collects and displays the last N JSF messages with a well
known message Id of "status". The last message collected is display, the messages can be
paged through by the user. The last N messages are stored in a stack for display.
id
false
true
value
false
true
binding
false
true
rendered
false
true
styleClass
false
true
style
false
true
border
false
true
bgcolor
false
true
label
false
true
selectList
org.alfresco.web.ui.common.tag.SelectListTag
JSP
The SelectList component displays a graphical list of items, each with a label and icon image.
The list has three selection modes; single select (radio), multi-select (checkbox) and active
selection mode (child action components).
The value for the component is collection of UIListItem objects or a UIListItems instance.
For passive single and multi-select modes, the selected value(s) can be retrieved from the component.
For active selection mode, appropriate child components such as Command buttons or Action Links
will be rendered for each item in the list, data-binding to the specified 'var' variable should be
used to bind required params. It is then up to the developer to retrieve the selected item param
from the actionListener of the appropriate child component.
id
false
true
binding
false
true
rendered
false
true
style
false
true
styleClass
false
true
itemStyle
false
true
itemStyleClass
false
true
var
false
true
multiSelect
false
true
activeSelect
false
true
onchange
false
true
value
false
true
values
false
true
escapeItemLabel
false
true
escapeItemDescription
false
true
graphicImageExprEnable
org.apache.myfaces.taglib.html.HtmlGraphicImageTag
JSP
Renders an HTML img element.
Unless otherwise specified, all attributes accept static values
or EL expressions.
id
false
true
java.lang.String
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
binding
false
false
java.lang.String
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
rendered
false
false
java.lang.String
A boolean value that indicates whether this component should be rendered.
Default value: true.
url
false
false
java.lang.String
An alias for the "value" attribute.
value
false
false
java.lang.String
The URL of the image. If the URL starts with a '/', it is relative
to the context path of the web application.
dir
false
false
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
lang
false
false
HTML: The base language of this document.
style
false
false
HTML: CSS styling instructions.
title
false
false
HTML: An advisory title for this element. Often used by the user agent as a tooltip.
styleClass
false
false
The CSS class for this element. Corresponds to the HTML 'class' attribute.
onclick
false
false
HTML: Script to be invoked when the element is clicked.
ondblclick
false
false
HTML: Script to be invoked when the element is double-clicked.
onmousedown
false
false
HTML: Script to be invoked when the pointing device is pressed over this element.
onmouseup
false
false
HTML: Script to be invoked when the pointing device is released over this element.
onmouseover
false
false
HTML: Script to be invoked when the pointing device is moved into this element.
onmousemove
false
false
HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseout
false
false
HTML: Script to be invoked when the pointing device is moves out of this element.
onkeypress
false
false
HTML: Script to be invoked when a key is pressed over this element.
onkeydown
false
false
HTML: Script to be invoked when a key is pressed down over this element.
onkeyup
false
false
HTML: Script to be invoked when a key is released over this element.
alt
false
false
java.lang.String
HTML: Specifies alternative text that can be used by a browser that can't show this element.
height
false
false
java.lang.String
HTML: Overrides the natural height of this image, by specifying height in pixels.
ismap
false
false
java.lang.String
HTML: Specifies server-side image map handling for this image.
longdesc
false
false
java.lang.String
HTML: A link to a long description of the image.
usemap
false
false
java.lang.String
HTML: Specifies an image map to use with this image.
width
false
false
java.lang.String
HTML: Overrides the natural width of this image, by specifying width in pixels.
param
org.apache.myfaces.taglib.core.ParamTag
JSP
Add a child UIParameter component to the UIComponent
associated with the closed parent UIComponent custom action.
binding
false
false
Value binding expression to a backing bean property
bound to the component instance for the UIComponent
created by this custom action.
id
false
true
Component identifier of the UIParameter component to be created.
name
false
true
Name of the parameter to be created.
value
true
true
Value of the parameter to be set.