sakai


Standard Syntax:
     <%@ taglib prefix="sakai" uri="http://sakaiproject.org/jsf/sakai" %>

XML Syntax:
     <anyxmlelement xmlns:sakai="http://sakaiproject.org/jsf/sakai" />

     This tag library contains Sakai 2.0 JavaServer Faces
    component tags for creating user interface elements specified in the
    Sakai style guide.
  

Tag Library Information
Display NameNone
Version1.9
Short Namesakai
URIhttp://sakaiproject.org/jsf/sakai
 

Tag Summary
view 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.
view_container DEPRECATED - Use sakai:view tag instead.
view_content DEPRECATED - no longer necessary. This tag has been phased out and is only here for compatibility with older Sakai tools.
view_title Output a view title according to the Sakai Style Guide. Usually displayed at the top of a tool page.
tool_bar 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.
tool_bar_item Renders a Sakai style toolbar item (or button). Parent should be a tool_bar tag.
tool_bar_spacer Renders a spacer (separator) in a Sakai style toolbar. Parent should be a tool_bar tag.
tool_bar_message Renders a message in the toolbar location. Typically used instead of a toolbar. Parent should usually be an h:form tag.
instruction_message Render an instructional message. Should be contained in a sakai:view tag.
messages Output JSF messages (Sakai alert messages). Parent should be a sakai:view tag.
input_date Date entry widget that allows entering date and/or time. Date can be selected through a text input as well as a date-picker popup calendar. Time is available through a text input
output_date 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.
button_bar 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.
button_bar_item Render an item in a Sakai style button bar. Parent should be a sakai:button_bar tag.
peer_refresh Adds a javascript refresh to a peer html element to the rendering.
courier Place a Sakai Courier in the response.
flat_list Render a flat (non-hierarchical) list. See the Sakai Style Guide, under topics "List" and "Actionable List".
doc_properties A 2 column name / value set of properties for a document
doc_section_title A document section title
doc_section A document section
group_box DEPRECATED - use panel_titled instead.
panel_titled Container that renders children components inside a titled grouping box.
panel_edit Setup an editing panel. 2 column layout.
rich_text_area 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.
inputRichText Renders a WYSIWYG text editor and toolbar within an HTML "textarea" element. Allows the user to edit HTML formatted text. The textarea is decorated using the HTMLArea JavaScript library. The JavaScript widget is based on the open-source 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.
inputFileUpload 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)
pager Pager widget that provides UI controls for paging a table. See the Sakai style guide, under heading "List Navigator UI Components".
debug This tag is strictly for debugging purposes. It outputs information on various JSF variables and scopes, and should not be used in production.
applet

render applet.

dataLine

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.

dynaTable

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.

multiColumn

Analogous to the data table in iterating over a list, this is a 'non-visual' container for itnerated columns.

This is recognized by dynaTable.

stylesheet Render a reference to a context resolved external CSS file.
script Render a reference to a context resolved external JavaScript file.
inputColor 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.
hideDivision Surround child components with a division. Present a title bar and clickable icon, Clicking icon causes the division to toggle btween visible and invisibele.
timerBar Display a moving bar that keeps track of elapsed time.
progressBar Display a moving bar indicating a wait. Similar to timerBar, but without the options.
popup Popup another window upon clicking a button or link.
alphaIndex 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.
anchorReference Render an HTML anchor tag with an name attribute.
selectCommand

Render an HTML option list with onchange action behavior that acts like a form submit button when clicked.

Decode Behavior

    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.

flowStateNo Description
contentTypeMap 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
 


Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-3 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.