META-INF.sakai-jsf2.tld Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsf2-widgets Show documentation
Show all versions of jsf2-widgets Show documentation
This is the Maven project for the custom JSF 2 widgets.
The widgets and the resources projects are closely tied together.
These widgets will be deployed as a jar file containing Sakai JSF 2 widgets
(components).
Web applications can include this jar in order to use the Sakai JSF 2 widgets in a JSF tool.
2.1
2.0
sakai
http://sakaiproject.org/jsf2/sakai
Sakai style guide.]]>
view
org.sakaiproject.jsf2.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_title
org.sakaiproject.jsf2.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.jsf2.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
instruction_message
org.sakaiproject.jsf2.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
tool_bar_spacer
org.sakaiproject.jsf2.tag.ToolBarSpacerTag
empty
Renders a spacer (separator) in a Sakai style toolbar. Parent should be a tool_bar tag.
button_bar
org.sakaiproject.jsf2.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.
group_box
org.sakaiproject.jsf2.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_edit
org.sakaiproject.jsf2.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.
separatedList
org.sakaiproject.jsf2.tag.SeparatedListTag
JSP
Adds a separator between the child nodes
separator
false
false
styleClass
false
false
id
false
false
Component id of this component.
pager
org.sakaiproject.jsf2.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):
flowState
org.sakaiproject.jsf2.tag.FlowStateTag
JSP
id
false
false
bean
true
false
tool_bar_item
org.sakaiproject.jsf2.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_message
org.sakaiproject.jsf2.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.
inputRichText
org.sakaiproject.jsf2.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.
doc_section
org.sakaiproject.jsf2.tag.DocSectionTag
JSP
A document section
binding
false
false
Component reference expression for this component.
id
false
false
Component id of this component.
contentTypeMap
org.sakaiproject.jsf2.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.
panel_titled
org.sakaiproject.jsf2.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
view_container
org.sakaiproject.jsf2.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.jsf2.tag.ViewContentTag
JSP
DEPRECATED - no longer necessary. This tag has been
phased out and is only here for compatibility with older Sakai tools.
]]>
input_date
org.sakaiproject.jsf2.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.
inputFileUpload
org.sakaiproject.jsf2.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
}
}
]]>
timerBar
org.sakaiproject.jsf2.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.