webuijsf
Tag helpInline


Use the <webuijsf:helpInline> tag to display inline help in the rendered HTML page. The tag supports two types of inline help: page help and field help. Page help is displayed in a medium size font and is intended for information about the page or section as a whole. Field help is displayed in a smaller font and is intended for information about individual fields in the page.

You can make links to additional help that is displayed in a secondary browser window by embedding the webuijsf:helpWindow tag in the webuijsf:helpInline tag's text.

HTML Elements and Layout

The rendered HTML page displays the body content of the <webuijsf:helpInline> tag inside of an XHTML compliant <div> element. An appropriate style class will be set for the <div> element based upon the helpInline type (page or field).

Client Side Javascript Functions

None.

Examples

Example 1: Inline page help

This example shows how to use the webuijsf:helpInline tag to create page level inline help. The type attribute is not specified because the default type is page.

<webuijsf:helpInline id="pageHelp" text="This is page inline help." />

Example 2: Inline field help

This example sets the type attribute to specify field help.

<webuijsf:helpInline id="fieldHelp" type="field" text="This is field inline help." />

Example 3: Add a HelpWindow link in inline help

This example shows how to create a hyperlink within the inline help text of an application page to open the help window. This approach is used to provide more detailed help on a topic.

<webuijsf:helpInline id="pageHelp1" type="page"
    text="Page inline help can be enhanced by a link to
       provide more information using webuijsf:helpWindow tag.">
   
    <webuijsf:helpWindow windowTitle="Window Title Param"
            pageTitle="Page Title Param"
            mastheadImageUrl="/images/webconsole.png"
            mastheadImageDescription="Sun Java Web Console Logo"           
            helpFile="accessibility.html"
            toolTip="Help for This Page (Opens a New Window)"
            linkIcon="true" linkText="Click for more about Accessibility." />
</webuijsf:helpInline>


Tag Information
Tag Classcom.sun.webui.jsf.component.HelpInlineTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingfalsefalsejava.lang.String A ValueExpression that resolves to the UIComponent that corresponds to this tag. This attribute allows the Java bean that contains the UIComponent to manipulate the UIComponent, its properties, and its children.
styleClassfalsefalsejava.lang.String

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

textfalsefalsejava.lang.String

The inline help text to display.

converterfalsefalsejava.lang.String The converter attribute is used to specify a method to translate native property values to String and back for this component. The converter attribute value must be one of the following:
  • A JavaServer Faces EL expression that resolves to a backing bean or bean property that implements the javax.faces.converter.Converter interface; or
  • the ID of a registered converter (a String).
typefalsefalsejava.lang.String

The type of inline help to display. Valid values are "page" or "field". Page help is displayed by default.

visiblefalsefalsejava.lang.String

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.

stylefalsefalsejava.lang.String

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

renderedfalsefalsejava.lang.String Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.
idfalsetruejava.lang.StringNo Description

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.