webuijsf
Tag commonTasksSection


Use the webuijsf:commonTasksSection tag to create a page or area of a page to present a number of tasks that users might commonly perform in the web application. The tasks typically are intended to make it easier for users to perform actions that could also be done using various features of the application.

Tasks can be:

The tasks can be grouped into categories of related tasks.

The common tasks section is created with the following tags:

See the documentation for the webuijsf:commonTasksGroup and webuijsf:commonTask tags for more information about those tags.

HTML Elements and Layout

The commonTasksSection component renders XHTML <div> and <table> elements. The component will accept any number of task groups and tasks, and distribute them on the page so that they are visually balanced into columns of roughly equal size.

The following diagram shows the relative location of the component's areas for which you can define content, and the attributes or facets that can be used for each area. The diagram shows the default two-column layout. A single column or multiple column layout would contain similar content areas.

The areas that are specified with the webuijsf:commonTasksSection tag  attributes are highlighted in blue. The grayed out areas are controlled with webuijsf:commonTasksGroup and webuijsf:commonTask tags, but are shown here for context.

Common Tasks Section Title (title attribute)
Help text (helpText attribute or help facet)
Common Task Group 1 Title
Common Task Group 2 Title (title attribute)
Image
Common Task 1 Text
Info
button
Image
Common Task 2 Text
Info
button

Image
Common Task 1 Text
Info
button
Image
Common Task 2 Text
Info
button

Common Task 3 Text
Info
button

Configuring the webuijsf:commonTasksSection tag

You can configure the title, help text, and number of columns displayed in the common tasks section.

Title: The webuijsf:commonTasksSection jsp tag provides the title attribute, which you can use to specify the text to display in the Common Task Section title. If you do not specify a title, the title "Common Tasks" is rendered by default.

Help text: The help text that is displayed under the title can be specified with the helpText attribute, or the help facet. See the Facets section for more information about the facet. When you use the helpText attribute, the specified help text is displayed in a smaller font below the title. If you do not specify the help text, the default help text is displayed: "To access information about a task select the "i" info button."

Number of Columns: The common tasks section displays tasks grouped in two columns by default, when there are no task groups, or multiple task groups. If there is one task group, a single column layout is used. You can customize the number of columns on the common tasks section by setting the columns attribute to the number of columns you want to display. For example, if you specify columns="3", the common tasks groups will be displayed in three columns.

Setting the Page Background Color

In a JSP page where you use the webuijsf:commonTasksSection tag, you should set the style class to commonTaskbgColor for the body tag. For example:

 <webuijsf:body styleClass="#{themeStyles.CTS_BACKGROUND}" >

The commonTaskbgColor style class sets the page's background color to the same gradient color used in the commonTasksSection component. If this color is not used, you might see a white space after the common tasks section.

Facets

You can use the commonTasksSection component's help facet to specify a different component to use to display the help text. The help is rendered below the title by the component that you specify. See the Examples section for an example that uses the help facet. 

Code Examples

Example 1: Specifying a custom title

<webuijsf:commonTasksSection id="tasks1" title = "#{tasks.tskTtl}">
    <webuijsf:commonTaskGroup id="Taskgroup1" title="#{tasks.grpTtl}">
       <webuijsf:commonTask id="task1" text="#{tasks.tskTxt1}" actio
nExpression="task1" />
       <webuijsf:commonTask id="task2" text="#{tasks.tskTxt2}" actio
nExpression="task2" />
    </webuijsf:commonTaskGroup>
</webuijsf:commonTasksSection>


Example 2: Overriding the default inline help with the help facet

 <webuijsf:commonTasksSection id="tasks1" title = "#{tasks.tskTtl}">
    <f:facet name="help" >
       <webuijsf:helpInline id="commontaskshelp" text="#{tasks.hlpTxt}"/> 
    </f:facet> 
    <webuijsf:commonTaskGroup id="Taskgroup1" title="#{tasks.grpTtl}">
       <webuijsf:commonTask id="task1" text="#{tasks.tskTxt1}" actio
nExpression="task1" />
       <webuijsf:commonTask id="task2" text="#{tasks.tskTxt2}" actio
nExpression="task2"/>
    </webuijsf:commonTaskGroup>
 </webuijsf:commonTasksSection>


Example 3: Specifying three columns

<webuijsf:commonTasksSection id="tasks1" title = "#{tasks.tskTtl}" columns="3">
    <webuijsf:commonTaskGroup id="Taskgroup1" title="#{tasks.grpTtl}">
       <webuijsf:commonTask id="task1" text="#{tasks.tskTxt1}" actionExpression="task1" />
       <webuijsf:commonTask id="task2" text="#{tasks.tskTxt2}" actio
nExpression="task2" />
    </webuijsf:commonTaskGroup>
</webuijsf:commonTasksSection>


The Common Tasks Section component. This encapsulates a number of common task group components.


Tag Information
Tag Classcom.sun.webui.jsf.component.CommonTasksSectionTag
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 or classes that are applied to the outermost HTML element when the commontaskssection component is rendered.

titlefalsefalsejava.lang.String

The title text to be displayed for the common tasks section.

visiblefalsefalsejava.lang.String

Indicates 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 or styles that are applied to the outermost HTML element when the commontaskssection 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.
columnsfalsefalsejava.lang.String

Specifies the number of task columns to display in the common tasks section.

idfalsetruejava.lang.StringNo Description
helpTextfalsefalsejava.lang.String

The help text to be displayed for the common tasks section.


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.