META-INF.sakai-jsf.tld Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsf-widgets Show documentation
Show all versions of jsf-widgets Show documentation
This is the Maven project for the custom JSF widgets.
The widgets and the resources projects are closely tied together.
These widgets will be deployed as a jar file containing Sakai JSF widgets
(components).
Web applications can include this jar in order to use the Sakai JSF
widgets in a JSF tool.
1.9
1.2
sakai
http://sakaiproject.org/jsf/sakai
Sakai style guide.]]>
view
org.sakaiproject.jsf.tag.ViewTag
JSP
Outermost container for a Sakai tool. Parent should be a f:view tag.
Contains all other Sakai tags. Responsible for rendering the HTML,
HEAD, and BODY tags (if necessary in the rendering context). If the
tool is being rendered as a fragment of HTML, this tag will detect
this and not render the HTML, HEAD, and BODY.
title
false
false
The page title. Rendered as the HTML title of the tool page, unless
the tool is being aggreggated and doesn't have its own HTML document.
toolCssHref
false
true
The URL of a stylesheet whose link should go between the base
Sakai stylesheet and the installation skin stylesheet.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
view_container
org.sakaiproject.jsf.tag.ViewTag
JSP
DEPRECATED - Use sakai:view tag instead.
]]>
title
false
false
The page title. Rendered as the HTML title of the tool page, unless
the tool is being aggreggated and doesn't have its own HTML document.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
view_content
org.sakaiproject.jsf.tag.ViewContentTag
JSP
DEPRECATED - no longer necessary. This tag has been
phased out and is only here for compatibility with older Sakai tools.
]]>
view_title
org.sakaiproject.jsf.tag.ViewTitleTag
empty
Output a view title according to the Sakai Style Guide. Usually displayed at the
top of a tool page.
indent
false
false
The integer intentation level at which to display this component - See the Sakai Style Guide.
Default is no special indentation.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
value
false
false
java.lang.String
The text of the title to display.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
]]>
tool_bar
org.sakaiproject.jsf.tag.ToolBarTag
JSP
Renders a Sakai style toolbar at the top of the tool.
Should be contained in an h:form tag. Children are tool_bar_ttem or tool_bar_spacer tags.
binding
false
false
The value binding expression linking this component to a property in a backing bean.
id
false
false
The component identifier for this component. This value must be unique
within the closest parent component that is a naming container.
rendered
false
false
boolean
Determine if this component is to be rendered.
separator
false
false
tool_bar_item
org.sakaiproject.jsf.tag.ToolBarItemTag
empty
Renders a Sakai style toolbar item (or button). Parent should be a tool_bar tag.
binding
false
false
The value binding expression linking this component to a property in a backing bean.
id
false
false
The component identifier for this component. This value must be unique
within the closest parent component that is a naming container.
action
false
false
java.lang.String
MethodBinding representing the application action to invoke when this
component is activated by the user. The expression must evaluate to a public method
that takes no parameters, and returns a String (the logical outcome) which is passed
to the NavigationHandler for this application.
value
false
false
java.lang.String
The displayed label of the toolbar item.
disabled
false
false
boolean
If true, the toolbar item is disabled. Clicking on the item does nothing.
immediate
false
false
boolean
Flag indicating that, if this component is activated by the user,
notifications should be delivered to interested listeners and actions immediately
(that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
style
false
false
CSS style(s) to be applied when this component is rendered.
styleClass
false
false
Space-separated list of CSS style class(es) to be applied when
this element is rendered. This value must be passed through
as the "class" attribute on generated markup.
current
false
false
boolean
Flag indicating whether or not this component represents the current page
tool_bar_spacer
org.sakaiproject.jsf.tag.ToolBarSpacerTag
empty
Renders a spacer (separator) in a Sakai style toolbar. Parent should be a tool_bar tag.
tool_bar_message
org.sakaiproject.jsf.tag.ToolBarMessageTag
empty
Renders a message in the toolbar location. Typically used instead of a toolbar.
Parent should usually be an h:form tag.
binding
false
false
The value binding expression linking this component to a property in a backing bean.
id
false
false
The component identifier for this component. This value must be unique
within the closest parent component that is a naming container.
value
false
false
The text of the message.
instruction_message
org.sakaiproject.jsf.tag.InstructionMessageTag
empty
Render an instructional message. Should be contained in a sakai:view tag.
binding
false
false
Component reference expression for this component.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
id
false
false
Component id of this component.
value
false
false
The message text
messages
org.sakaiproject.jsf.tag.MessagesTag
empty
Output JSF messages (Sakai alert messages). Parent should be a sakai:view tag.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
input_date
org.sakaiproject.jsf.tag.InputDateTag
JSP
id
false
false
Component id of this component.
showDate
false
false
If true, enable input for user to enter the date. Default is true.
showTime
false
false
If true, enable input for user to enter the time. Default is true.
showSecond
false
false
If true, and showTime is true, input seconds.
Default is false.
If false, default to zero seconds.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
value
false
false
The current value of this component.
rendered
false
false
Flag indicating that this element should be rendered.
Default is true;
disabled
false
false
Flag indicating that this element must never
receive focus or be included in a subsequent
submit.
output_date
org.sakaiproject.jsf.tag.OutputDateTag
empty
Output a date in the Sakai date format, for example 2003-Mar-07 07:42:00 pm.
See the Sakai Style Guide, under topic Date/Time Entry.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
value
false
false
The current value of this component.
showTime
false
false
If true, show time. Default is true.
If false, no time will be shown.
showDate
false
false
If true, show date. Default is true.
If false, no date will be shown.
showSeconds
false
false
If true and showTime is true, show seconds.
Default value is false.
button_bar
org.sakaiproject.jsf.tag.ButtonBarTag
JSP
Render Sakai style button ("action") bar at the bottom of the tool.
See the Sakai Style Guide, "Item Summary Detail" and "Aggregated Item Summary".
Children are button_bar_item tags.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
button_bar_item
org.sakaiproject.jsf.tag.ButtonBarItemTag
empty
Render an item in a Sakai style button bar. Parent should be a sakai:button_bar tag.
active
false
false
Whether this component is the "active" button (maybe the default button?). Default is false.
styleClass
false
false
To allow adding the css class of 'active' to the button in the button_bar that is most likely to be the default
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
action
false
false
java.lang.String
MethodBinding representing the application action to invoke when this component
is activated by the user. The expression must evaluate to a public method that
takes no parameters, and returns a String (the logical outcome) which is passed
to the NavigationHandler for this application.
value
false
false
java.lang.String
The current value of this component.
disabled
false
false
boolean
Flag indicating that this element must never receive focus or be included in a subsequent submit.
immediate
false
false
boolean
Flag indicating that, if this component is activated by the user,
notifications should be delivered to interested listeners and actions
immediately (that is, during Apply Request Values phase) rather than
waiting until Invoke Application phase.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
accesskey
false
false
Access key that, when pressed, transfers focus to this element.
tabindex
false
false
Position of this element in the tabbing order for the current document.
This value must be an integer between 0 and 32767.
title
false
false
Advisory title information about markup elements generated for this component.
style
false
false
CSS style(s) to be applied when this component is rendered.
onclick
false
false
Javascript code executed when a pointer button is
clicked over this element.
peer_refresh
org.sakaiproject.jsf.tag.PeerRefreshTag
empty
Adds a javascript refresh to a peer html element to the rendering.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
value
false
false
The name of the peer element.
courier
org.sakaiproject.jsf.tag.CourierTag
empty
Place a Sakai Courier in the response.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
refresh
false
false
The refresh interval, in seconds
flat_list
org.sakaiproject.jsf.tag.FlatListTag
JSP
Render a flat (non-hierarchical) list. See the Sakai Style Guide,
under topics "List" and "Actionable List".
binding
false
false
Component reference expression for this component.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
styleClass
false
false
Pass throught styleClass for this widget
style
false
false
Pass throught style for this widget
columnClasses
false
false
Pass throught columnClasses for this widget
summary
false
false
Pass throught summary for this widget
id
false
false
Component id of this component.
value
false
false
var
false
false
doc_properties
org.sakaiproject.jsf.tag.DocPropertiesTag
JSP
A 2 column name / value set of properties for a document
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
doc_section_title
org.sakaiproject.jsf.tag.DocSectionTitleTag
JSP
A document section title
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
doc_section
org.sakaiproject.jsf.tag.DocSectionTag
JSP
A document section
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
group_box
org.sakaiproject.jsf.tag.GroupBoxTag
JSP
DEPRECATED - use panel_titled instead.
]]>
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
title
false
false
The group box title
panel_titled
org.sakaiproject.jsf.tag.GroupBoxTag
JSP
Container that renders children components inside a titled grouping box.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
title
false
false
The group box title
panel_edit
org.sakaiproject.jsf.tag.PanelEditTag
JSP
Setup an editing panel. 2 column layout.
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
rich_text_area
org.sakaiproject.jsf.tag.RichTextAreaTag
JSP
DEPRECATED - use inputRichText tag instead. Only present
here for compatibility with older Sakai tools.
Renders a WYSIWYG text editor. Allows the user to edit HTML formatted text.
The JavaScript widget is based on the open-source
HTMLArea project.
]]>
value
false
false
binding
false
false
columns
false
false
Number of columns in the textarea (in character units). Complements the the 'width' attribute.
rows
false
false
Number of rows in the textarea (in character units). Complements the 'height' attribute.
width
false
false
Width of the widget (in pixel units). Complements the 'columns' attribute.
height
false
false
Height of the widget (in pixel units). Complements the 'rows' attribute.
toolbarButtonRows
false
false
Number of rows of buttons in the toolbar. Defaults to 2. Valid values are 0, 2, or 3.
javascriptLibrary
false
false
The URL to the directory of the HTMLArea JavaScript library.
Defaults to the Sakai legacy customized HTMLArea. May be a relative URL.
autoConfig
false
false
Whether to recalculate the configuration - defaults to false. If true,
the width, height, and toolbarButtonRows will be recalculated based on
the values given.
justArea
false
false
DEPRECATED]]> - use toolbarButtonRows=0 instead.
If true, the WYSIWYG toolbar is not shown. The text is still editable.
Keyboard shortcuts for formatting (like Ctrl-B for bold) still work.
inputRichText
org.sakaiproject.jsf.tag.InputRichTextTag
JSP
HTMLArea project.
HTMLArea is copyright
InteractiveTools.com
and Dynarch.com and it is released
under a BSD-style license.
HTMLArea was created and developed up to
version 2.03 by InteractiveTools.com. Version 3.0 is a full rewrite,
developed by Mihai Bazon.
It contains code sponsored by third-party
companies as well. Please see our About Box for details about
who sponsored what plugins.
]]>
value
false
false
The editable HTML displayed inside the textarea.
cols
false
false
Number of columns in the textarea (in character units). Defaults to 80.
Complements the the 'width' attribute. Passes through to the HTML textarea element.
rows
false
false
Number of rows in the textarea (in character units). Defaults to 15.
Complements the 'height' attribute. Passes through to the HTML textarea element.
width
false
false
Width of the widget (in pixel units).
If this attribute is not specified, the width is controlled by the 'cols' attribute.
height
false
false
Height of the widget (in pixel units).
If this attribute is not specified, the width is controlled by the 'rows' attribute.
textareaOnly
false
false
If true, only the textarea will be rendered. Defaults to false.
If true, the rich text toolbar
and external HTMLArea JavaScript will not be rendered. Attributes that
affect the textarea element will be rendered (for example style, styleClass).
This widget is then rendered as just a plain-old textarea.
enableFullPage
false
false
If true, this will set CKEditor's fullPage property, which captures the entire HTML document
with html, head and body tags.
buttonSet
false
false
Select toolbar from among a number precanned lists of command buttons.
Allowed values are: "none", "small", "medium", "large". (values tentative).
Defaults to "medium", which has 2 rows of buttons. For fine-grained
control of which buttons are shown, use the buttonList attribute
instead. "small" has 1 row
of buttons. "large" has 3 rows of buttons, almost everything available.
"none" has 0 rows of buttons, no buttons at all - The text is still editable;
Keyboard shortcuts for formatting (like Ctrl-B for bold) still work.
buttonList
false
false
Comma delimited list of toolbar command buttons registered with
component. If not specified, will default to a defined list.
javascriptLibraryExtensionURL
false
false
URL to an external JavaScript file with additional
JavaScript to execute beyond the default, for example
extra command button definitions. May be a relative URL.
Default is nothing.
javascriptLibraryURL
false
false
The URL to the directory of the HTMLArea JavaScript library.
This allows overriding the default HTMLArea JavaScript library
that comes with this component.
May be a relative URL.
showXPath
false
false
If true show XPath at bottom of editor. Default is true.
hideAble
false
false
Show sub control allowing you to hide editor.
Default is false.
autoConfig
false
false
___TODO: This is here for legacy purposes - is it really necessary anymore?___
Whether to recalculate the configuration - defaults to false. If true,
the width, height, and toolbar buttons will be recalculated based on
the values given.
binding
false
false
converter
false
false
Converter instance registered with this component.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
immediate
false
false
Flag indicating that this component's value must be
converted and validated immediately (that is, during
Apply Request Values phase), rather than waiting
until Process Validations phase.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
required
false
false
Flag indicating that the user is required to provide a submitted
value for this input component.
validator
false
false
MethodBinding representing a validator method that will be called
during Process Validations to perform correctness checks on the
value of this component. The expression must evaluate to a public
method that takes FacesContext, UIComponent, and Object parameters,
with a return type of void.
value
false
false
The current value of this component.
valueChangeListener
false
false
MethodBinding representing a value change listener method that will be
notified when a new value has been set for this input component. The
expression must evaluate to a public method that takes a
ValueChangeEvent parameter, with a return type of void.
accesskey
false
false
Access key that, when pressed, transfers focus
to this element.
dir
false
false
Direction indication for text that does not inherit directionality.
Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
disabled
false
false
Flag indicating that this element must never
receive focus or be included in a subsequent
submit.
lang
false
false
Code describing the language used in the generated markup
for this component.
readonly
false
false
Flag indicating that this component will prohibit
changes by the user. The element may receive focus
unless it has also been disabled.
style
false
false
CSS style(s) to be applied to the underlying textarea when it is rendered.
styleClass
false
false
Space-separated list of CSS style class(es) to be applied when
the underlying textarea is rendered. This value must be passed through
as the "class" attribute on generated markup.
tabindex
false
false
Position of the underlying textarea element in the tabbing order
for the current document. This value must be
an integer between 0 and 32767.
title
false
false
Advisory title information about markup elements generated
for this component.
attachedFiles
false
false
A list of SelectItems or a Map of link to label strings that
will be rendered as a list on the editor.
collectionBase
false
false
Collection with in Content Hosting to use for any ContentHostingService
interactions with in the editor, such as the FCK file browser.
inputFileUpload
org.sakaiproject.jsf.tag.InputFileUploadTag
JSP
Widget that allows the user to upload a file. The uploaded
file is available through the value of the component, through the FileItem
interface. See the Apache commons-fileupload 1.0 API for details at
http://jakarta.apache.org/commons/fileupload/. The recommended use of this
widget is to use the valueChangeListener attribute to call a method that
will process the uploaded file. The uploaded file is NOT persisted to
storage automatically; the application is responsible for that, not the
widget.
The widget needs a filter configured in web.xml. The Sakai
RequestFilter is recommended; however, a custom filter is permissable.
The widget is compatible with the MyFaces filter ("extensionsFilter") as an alternative.
A custom filter must expose the uploaded file though the commons-fileupload 1.0
FileItem interface, in one of two ways. It must be made available
either as a request attribute with the
field name, and would be accessible as follows:
FileItem item = (FileItem) request.getAttribute(fieldName);
OR as a method on a request wrapper with the following signature:
public org.apache.commons.fileupload.FileItem getFileItem(String fieldName)
value
false
false
The current value of this component. If the "directory" attribute is not
used, the value of the component is the uploaded FileItem. If the "directory"
attribute is used, the value of the component is the server-side absolute
path to the uploaded file.
directory
false
false
If present, the directory to which to persist uploaded files. Use of this
attribute is discouraged. If this attribute is used, a tool which contains
the tag will not
be cluster-safe since different application servers probably do not share
the same filesystem. If a file already exists and another file of the same
name is uploaded, the existing file will be overwritten.
valueChangeListener
false
false
This is the recommended way to access the uploaded file. The valueChangeListener
will be called when a file is uploaded.MethodBinding representing a value change
listener method that will be
notified when a new value has been set for this input component. The
expression must evaluate to a public method that takes a
ValueChangeEvent parameter, with a return type of void.
style
false
false
CSS style(s) to be applied to the underlying input tag when it is rendered.
styleClass
false
false
Space-separated list of CSS style class(es) to be applied when
the underlying input tag is rendered. This value must be passed through
as the "class" attribute on generated markup.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
binding
false
false
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
immediate
false
false
Flag indicating that this component's value must be
converted and validated immediately (that is, during
Apply Request Values phase), rather than waiting
until Process Validations phase.
required
false
false
Flag indicating that the user is required to provide a submitted
value for this input component.
validator
false
false
MethodBinding representing a validator method that will be called
during Process Validations to perform correctness checks on the
value of this component. The expression must evaluate to a public
method that takes FacesContext, UIComponent, and Object parameters,
with a return type of void.
accept
false
false
Pass-through attribute. Will be output as-is on the underlying input element.
align
false
false
Pass-through attribute. Will be output as-is on the underlying input element.
accesskey
false
false
Pass-through attribute. Will be output as-is on the underlying input element.
maxlength
false
false
Pass-through attribute. Will be output as-is on the underlying input element.
size
false
false
Pass-through attribute. Will be output as-is on the underlying input element.
disabled
false
false
Pass-through attribute. Will be output as-is on the underlying input element.
readonly
false
false
Pass-through attribute. Will be output as-is on the underlying input element.
tabindex
false
false
Pass-through attribute. Will be output as-is on the underlying input element.
In web.xml:
sakai.request
org.sakaiproject.util.RequestFilter
upload.enabled
true
In ExampleBean.java:
public void processFileUpload(ValueChangeEvent event) throws AbortProcessingException
{
try
{
FileItem item = (FileItem) event.getNewValue();
String fieldName = item.getFieldName();
String fileName = item.getName();
long fileSize = item.getSize();
// Read the file as a stream (may be more memory-efficient)
InputStream fileAsStream = item.getInputStream();
// OR INSTEAD read the contents as a byte array (probably less memory-efficient)
byte[] fileContents = item.get();
// now process the file. Do application-specific processing
// such as parsing the file, storing it in the database,
// or whatever needs to happen with the uploaded file.
}
catch (Exception ex)
{
// handle exception
}
}
]]>
pager
org.sakaiproject.jsf.tag.PagerTag
JSP
Pager widget that provides UI controls for paging a table. See the
Sakai style guide, under heading "List Navigator UI Components".
totalItems
true
false
Total number of items in the list. This attribute is read-only;
the widget will get this value, but not set it.
firstItem
false
false
The item number (0-based) of the first item displayed.
This attribute is read-write; the widget will get this value, and set it when
it is changed. Alternate to using the value attribute.
pageSize
false
false
Number of items to display in a single page of items.
Default is 20. This attribute is read-write; the widget will get this value, and set it when
it is changed. Alternate to using the value attribute.
accesskeys
false
false
Whether to have HTML "accesskey" attributes for the buttons. Default is false.
value
false
false
The value (which is the paging state of this widget) is two numbers
in a String, of the form "firstItem,pageSize".
See attributes firstItem and pageSize.
lastItem
false
false
One past the last item displayed (eg, items 1-10 would have lastItem=10).
This attribute is write-only; the widget calculates this attribute
and sets it when it has changed.
valueChangeListener
false
false
Register a listener that will be called when the widget value (the paging state) changes.
See the value attribute.
pageSizes
false
false
String which is a list of options of number of items per page. Default is "5,10,20,50,100".
renderFirst
false
false
Whether to display the "first item" button. Default is true.
renderPrev
false
false
Whether to display the "previous item" button. Default is true.
renderNext
false
false
Whether to display the "next item" button. Default is true.
renderLast
false
false
Whether to display the "last item" button. Default is true.
renderPageSize
false
false
Whether to display the select page size dropdown. Default is true.
textFirst
false
false
Text to display on the button which goes to the first page of items. Default is "|<".
textPrev
false
false
Text to display on the button which goes to the previous page of items. Default is "<".
textNext
false
false
Text to display on the button which goes to the next page of items. Default is ">".
textLast
false
false
Text to display on the button which goes to the last page of items. Default is ">|".
textPageSize
false
false
Text message to display for selecting page size. Default is "Show {0}".
textItem
false
false
Word that describes the items. Default is "items". This might be (for example) "students".
textStatus
false
false
Text message to display the status of paging. Default is "Viewing {0} to {1} of {2} {3}".
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
immediate
false
false
Flag indicating that this component's value must be
converted and validated immediately (that is, during
Apply Request Values phase), rather than waiting
until Process Validations phase.
Example #2 (Common usage):
Example #3 (Advanced customization):
debug
org.sakaiproject.jsf.tag.DebugTag
empty
This tag is strictly for debugging purposes. It outputs information
on various JSF variables and scopes, and should not be used in production.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
applet
org.sakaiproject.jsf.tag.AppletTag
JSP
render applet.
]]>
name
false
false
The applet name.
version
false
false
The applet version.
codebase
false
false
The applet codebase.
width
false
false
The applet width.
height
false
false
The applet height.
hspace
false
false
The applet horizontal space.
vspace
false
false
The applet vertical space.
javaClass
false
false
The applet Java class.
javaArchive
false
false
The applet Java archive.
paramList
false
false
The applet parameters in a comma separated key=value format.
TODO: escaping quoting etc.
dataLine
org.sakaiproject.jsf.tag.DataLineTag
JSP
Analogous to the data table in iterating over a list,
but without creating a surrounding table or using columns. "Rows"
are the data rows of the underlying data, not table rows.
]]>
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
separator
false
false
If not empty, the contents of this attribute are interpolated
between each iteration.
first
false
false
Zero-relative row number of the first row to be displayed. If this
property is set to zero, rendering will begin with the first row of
the underlying data.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
rows
false
false
The number of rows of the underlying data model to be displayed,
starting with the one identified by the
"first" property. If this value is set to zero, all available rows
in the underlying data model will be displayed.
value
false
false
The current value of this component.
var
false
false
Name of a request-scope attribute under which the model data for the
row selected by the current value of the "rowIndex" property (i.e.
also the current value of the "rowData" property) will be exposed.
lang
false
false
Code describing the language used in the generated markup
for this component.
onclick
false
false
Javascript code executed when a pointer button is
clicked over this element.
ondblclick
false
false
Javascript code executed when a pointer button is
double clicked over this element.
onkeydown
false
false
Javascript code executed when a key is
pressed down over this element.
onkeypress
false
false
Javascript code executed when a key is
pressed and released over this element.
onkeyup
false
false
Javascript code executed when a key is
released over this element.
onmousedown
false
false
Javascript code executed when a pointer button is
pressed down over this element.
onmousemove
false
false
Javascript code executed when a pointer button is
moved within this element.
onmouseout
false
false
Javascript code executed when a pointer button is
moved away from this element.
onmouseover
false
false
Javascript code executed when a pointer button is
moved onto this element.
onmouseup
false
false
Javascript code executed when a pointer button is
released over this element.
style
false
false
CSS style(s) to be applied when this component is rendered.
styleClass
false
false
Space-separated list of CSS style class(es) to be applied when
this element is rendered. This value must be passed through
as the "class" attribute on generated markup.
binding
false
false
The value binding expression linking this component to a property in a backing bean
dynaTable
org.sakaiproject.jsf.tag.DynaTableTag
JSP
Analogous to the data table in iterating over a list,
but without creating a surrounding table or using columns. "Rows"
are the data rows of the underlying data, not table rows.
]]>
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
first
false
false
Zero-relative row number of the first row to be displayed. If this
property is set to zero, rendering will begin with the first row of
the underlying data.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
rows
false
false
The number of rows of the underlying data model to be displayed,
starting with the one identified by the
"first" property. If this value is set to zero, all available rows
in the underlying data model will be displayed.
value
false
false
The current value of this component.
var
false
false
Name of a request-scope attribute under which the model data for the
row selected by the current value of the "rowIndex" property (i.e.
also the current value of the "rowData" property) will be exposed.
lang
false
false
Code describing the language used in the generated markup
for this component.
onclick
false
false
Javascript code executed when a pointer button is
clicked over this element.
ondblclick
false
false
Javascript code executed when a pointer button is
double clicked over this element.
onkeydown
false
false
Javascript code executed when a key is
pressed down over this element.
onkeypress
false
false
Javascript code executed when a key is
pressed and released over this element.
onkeyup
false
false
Javascript code executed when a key is
released over this element.
onmousedown
false
false
Javascript code executed when a pointer button is
pressed down over this element.
onmousemove
false
false
Javascript code executed when a pointer button is
moved within this element.
onmouseout
false
false
Javascript code executed when a pointer button is
moved away from this element.
onmouseover
false
false
Javascript code executed when a pointer button is
moved onto this element.
onmouseup
false
false
Javascript code executed when a pointer button is
released over this element.
style
false
false
CSS style(s) to be applied when this component is rendered.
styleClass
false
false
Space-separated list of CSS style class(es) to be applied when
this element is rendered. This value must be passed through
as the "class" attribute on generated markup.
binding
false
false
The value binding expression linking this component to a property in a backing bean
multiColumn
org.sakaiproject.jsf.tag.MultiColumnTag
JSP
Analogous to the data table in iterating over a list,
this is a 'non-visual' container for itnerated columns.
This is recognized by dynaTable.
]]>
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
first
false
false
Zero-relative row number of the first row to be displayed. If this
property is set to zero, rendering will begin with the first row of
the underlying data.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
rows
false
false
The number of rows of the underlying data model to be displayed,
starting with the one identified by the
"first" property. If this value is set to zero, all available rows
in the underlying data model will be displayed.
value
false
false
The current value of this component.
var
false
false
Name of a request-scope attribute under which the model data for the
row selected by the current value of the "rowIndex" property (i.e.
also the current value of the "rowData" property) will be exposed.
stylesheet
org.sakaiproject.jsf.tag.StylesheetTag
JSP
Render a reference to a context resolved external CSS file.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
path
true
false
Context resolved path to a external CSS file.
contextBase
false
false
Alternattive context to resolve path to a external CSS file.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
script
org.sakaiproject.jsf.tag.ScriptTag
JSP
Render a reference to a context resolved external JavaScript file.
id
false
false
Render a reference to a context resolved external JavaScript file.
path
true
false
Context resolved path to an external JavaScript file.
contextBase
false
false
Alternative context to resolve path to an external JavaScript file.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
inputColor
org.sakaiproject.jsf.tag.InputColorTag
JSP
Render a sample-color bar and a color picker icon, as well as
an hidden field with the component value. Clicking icon
causes color picker to popup. Transfer chosen
color picker value to hidden field and render bar in that color.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
value
false
false
The current value of this component.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
hideDivision
org.sakaiproject.jsf.tag.HideDivisionTag
JSP
Surround child components with a division.
Present a title bar and clickable icon,
Clicking icon causes the division to toggle
btween visible and invisibele.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
title
true
false
Title for title bar.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
onclick
false
false
Javascript code executed when a pointer button is
clicked over this element, after the internal
JavaScript.
ondblclick
false
false
Javascript code executed when a pointer button is
double clicked over this element, after the internal
JavaScript.
onkeydown
false
false
Javascript code executed when a key is
pressed down over this element.
onkeypress
false
false
Javascript code executed when a key is
pressed and released over this element.
onkeyup
false
false
Javascript code executed when a key is
released over this element.
onmousedown
false
false
Javascript code executed when a pointer button is
pressed down over this element.
onmousemove
false
false
Javascript code executed when a pointer button is
moved within this element.
onmouseout
false
false
Javascript code executed when a pointer button is
moved away from this element.
onmouseover
false
false
Javascript code executed when a pointer button is
moved onto this element.
onmouseup
false
false
Javascript code executed when a pointer button is
released over this element.
timerBar
org.sakaiproject.jsf.tag.TimerBarTag
JSP
Display a moving bar that keeps track of elapsed time.
height
true
false
Timer bar height.
width
true
false
Timer bar width.
wait
true
false
Total number of seconds duration for timer bar.
This is the total time that it will take if elapsed
is zero.
elapsed
true
false
Total number of tenths of a second elapsed.
Countdown will begin with wait time diminished
by elapsed times 10, progress will show appropriate
percentage remaining.
elapsedColor
false
false
Color indicating elapsed time on bar.
Valid values are supported HTML color names or RGB values.
Default: "gray".
remainingColor
false
false
Color indicating remaining time on bar.
Valid values are supported HTML color names or RGB values.
Default: "green".
expireScript
true
false
JavaScript expriration handling code.
expireMessage
true
false
JavaScript popup message.
expireHandling
false
false
Enable JavaScript expiration handlers.
If false, disables expireMessage and expireScript;
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
progressBar
org.sakaiproject.jsf.tag.ProgressBarTag
JSP
Display a moving bar indicating a wait.
Similar to timerBar, but without the options.
wait
true
false
Total number of seconds duration for progress bar.
This is the total time that it will take if elapsed
is zero.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
popup
org.sakaiproject.jsf.tag.PopupTag
JSP
Popup another window upon clicking a button or link.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
url
true
false
Valid URL for the contents of popup.
useButton
false
false
Instead of rendering children, display button.
Default is false or no.
title
false
false
The title text if a link, the button text if a button.
target
false
false
The name of target window. Default is "sakai_popup".
toolbar
false
false
Does the popup display a toolbar? Default is "no" or "false".
menubar
false
false
Does the popup display a menubar? Default is "no" or "false".
personalbar
false
false
Does the popup display a personalbar? Default is "no" or "false".
scrollbars
false
false
Does the popup display scrollbars? Default is "no" or "false".
width
false
false
Width of the popup. Default is 650.
height
false
false
Height of the popup. Default is 375.
scrollbars
false
false
Does the popup display scrollbars? Default is "no" or "false".
resizable
false
false
Is the popup display resizable? Default is "yes" or "true".
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
alphaIndex
org.sakaiproject.jsf.tag.AlphaIndexTag
JSP
Create a set of internal links to, or advance to something
starting with a different letter.
TODO: PLACEHOLDER. NEED TO DETERMINE INTEGRATION INTO SORT/PAGING.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
initials
false
false
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
anchorReference
org.sakaiproject.jsf.tag.AnchorReferenceTag
JSP
Render an HTML anchor tag with an name attribute.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
name
true
false
The name for the anchor.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
selectCommand
org.sakaiproject.jsf.tag.SelectCommandTag
JSP
Render an HTML option list with
onchange action behavior that acts like a
form submit button when clicked.
See the "Decode
Behavior for UISelectOne Components" section as well as for
"Decode
Behavior for UICommand Components".
Obtain the Map from the "requestParameterMap"
property of the ExternalContext.
If the value in theMap for the value of the "clientId" property of the
component is null, create a String by concatenating
the value of the "clientId" property of the component with the
String ".x" (without the quotes). Create another String in the
same manner, but concatenate ".y" (without the quotes). Ifnull is the value in the Map for both
Strings, return from decode(). If the value in theMap for the value of the "clientId" property of the
component is not null, get the value of the "type"
attribute, and convert it to lower case. If the result is equal
to the String "reset" (without the quotes), return fromdecode(). Otherwise, create ajavax.faces.event.ActionEvent around the component,
and pass it to the queueEvent() method of the
component, which must be an instance ofUICommand.
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 forListboxRenderer for more detail on how to render the "option" elements in this renderer.
]]>
converter
false
false
Converter instance registered with this component.
id
false
false
The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.
immediate
false
false
Flag indicating that this component's value must be
converted and validated immediately (that is, during
Apply Request Values phase), rather than waiting
until Process Validations phase.
rendered
false
false
Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent
form submit.
actionListener
false
false
MethodBinding representing an action listener method that will be
notified when this component is activated by the user. The
expression must evaluate to a public method that takes an
ActionEvent parameter, with a return type of void.
required
false
false
Flag indicating that the user is required to provide a submitted
value for this input component.
validator
false
false
MethodBinding representing a validator method that will be called
during Process Validations to perform correctness checks on the
value of this component. The expression must evaluate to a public
method that takes FacesContext, UIComponent, and Object parameters,
with a return type of void.
value
false
false
The current value of this component.
valueChangeListener
false
false
MethodBinding representing a value change listener method that will be
notified when a new value has been set for this input component. The
expression must evaluate to a public method that takes a
ValueChangeEvent parameter, with a return type of void.
accesskey
false
false
Access key that, when pressed, transfers focus
to this element.
dir
false
false
Direction indication for text that does not inherit directionality.
Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
disabled
false
false
Flag indicating that this element must never
receive focus or be included in a subsequent
submit.
disabledClass
false
false
CSS style class to apply to the rendered label
on disabled options.
enabledClass
false
false
CSS style class to apply to the rendered label
on enabled options.
lang
false
false
Code describing the language used in the generated markup
for this component.
onblur
false
false
Javascript code executed when this element loses focus.
onchange
false
false
Javascript code executed when this element loses focus
and its value has been modified since gaining focus.
onclick
false
false
Javascript code executed when a pointer button is
clicked over this element.
ondblclick
false
false
Javascript code executed when a pointer button is
double clicked over this element.
onfocus
false
false
Javascript code executed when this element receives focus.
onkeydown
false
false
Javascript code executed when a key is
pressed down over this element.
onkeypress
false
false
Javascript code executed when a key is
pressed and released over this element.
onkeyup
false
false
Javascript code executed when a key is
released over this element.
onmousedown
false
false
Javascript code executed when a pointer button is
pressed down over this element.
onmousemove
false
false
Javascript code executed when a pointer button is
moved within this element.
onmouseout
false
false
Javascript code executed when a pointer button is
moved away from this element.
onmouseover
false
false
Javascript code executed when a pointer button is
moved onto this element.
onmouseup
false
false
Javascript code executed when a pointer button is
released over this element.
onselect
false
false
Javascript code executed when text within this
element is selected by the user.
readonly
false
false
Flag indicating that this component will prohibit
changes by the user. The element may receive focus
unless it has also been disabled.
style
false
false
CSS style(s) to be applied when this component is rendered.
styleClass
false
false
Space-separated list of CSS style class(es) to be applied when
this element is rendered. This value must be passed through
as the "class" attribute on generated markup.
tabindex
false
false
Position of this element in the tabbing order
for the current document. This value must be
an integer between 0 and 32767.
title
false
false
Advisory title information about markup elements generated
for this component.
binding
false
false
The value binding expression linking this component to a property in a backing bean
flowState
org.sakaiproject.jsf.tag.FlowStateTag
JSP
id
false
false
bean
true
false
contentTypeMap
org.sakaiproject.jsf.tag.JsfContentTypeMapTag
empty
Exposes a map of the file types: images, names and extensions.
If image is the mapType, the returned value will be the file name for the fileType icon.
If name is the mapType, the returned value will be the display name for the fileType.
If extension is the mapType, the returned value will be the extension for the fileType
fileType
false
false
String representation of the mime type (like "text/xml")
mapType
false
false
Accepted values are image, name, extension
pathPrefix
false
false
Path prefix for where the image lives (only needed if mapType is image)
var
true
false
Name of a request-scope attribute under which the return value will be exposed.
separatedList
org.sakaiproject.jsf.tag.SeparatedListTag
JSP
Adds a separator between the child nodes
separator
false
false
styleClass
false
false
id
false
false
Component id of this component.