sakai
Tag 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.


Tag Information
Tag Classorg.sakaiproject.jsf.tag.InputRichTextTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
valuefalsefalsejava.lang.String The editable HTML displayed inside the textarea.
colsfalsefalsejava.lang.String Number of columns in the textarea (in character units). Defaults to 80. Complements the the 'width' attribute. Passes through to the HTML textarea element.
rowsfalsefalsejava.lang.String Number of rows in the textarea (in character units). Defaults to 15. Complements the 'height' attribute. Passes through to the HTML textarea element.
widthfalsefalsejava.lang.String Width of the widget (in pixel units). If this attribute is not specified, the width is controlled by the 'cols' attribute.
heightfalsefalsejava.lang.String Height of the widget (in pixel units). If this attribute is not specified, the width is controlled by the 'rows' attribute.
textareaOnlyfalsefalsejava.lang.String 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.
buttonSetfalsefalsejava.lang.String 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.
buttonListfalsefalsejava.lang.String Comma delimited list of toolbar command buttons registered with component. If not specified, will default to a defined list.
javascriptLibraryExtensionURLfalsefalsejava.lang.String 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.
javascriptLibraryURLfalsefalsejava.lang.String 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.
showXPathfalsefalsejava.lang.String If true show XPath at bottom of editor. Default is true.
hideAblefalsefalsejava.lang.String Show sub control allowing you to hide editor. Default is false.
autoConfigfalsefalsejava.lang.String ___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.
bindingfalsefalsejava.lang.String
converterfalsefalsejava.lang.String Converter instance registered with this component.
idfalsefalsejava.lang.String The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediatefalsefalsejava.lang.String 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.
renderedfalsefalsejava.lang.String Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
requiredfalsefalsejava.lang.String Flag indicating that the user is required to provide a submitted value for this input component.
validatorfalsefalsejava.lang.String 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.
valuefalsefalsejava.lang.String The current value of this component.
valueChangeListenerfalsefalsejava.lang.String 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.
accesskeyfalsefalsejava.lang.String Access key that, when pressed, transfers focus to this element.
dirfalsefalsejava.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
disabledfalsefalsejava.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit.
langfalsefalsejava.lang.String Code describing the language used in the generated markup for this component.
readonlyfalsefalsejava.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.
stylefalsefalsejava.lang.String CSS style(s) to be applied to the underlying textarea when it is rendered.
styleClassfalsefalsejava.lang.String 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.
tabindexfalsefalsejava.lang.String Position of the underlying textarea element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
titlefalsefalsejava.lang.String Advisory title information about markup elements generated for this component.
attachedFilesfalsefalsejava.lang.String A list of SelectItems or a Map of link to label strings that will be rendered as a list on the editor.
collectionBasefalsefalsejava.lang.String Collection with in Content Hosting to use for any ContentHostingService interactions with in the editor, such as the FCK file browser.

Variables
No Variables Defined.


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