webuijsf
Tag contentPageTitle


Use the webuijsf:contentPageTitle tag to display an <h1> heading as a page title, and the following optional page elements:

The title text and help text can be specified by using the webuijsf:contentPageTitle tag's attributes, and also by using facets. The page buttons, page actions, and page view controls can only be specified with facets. The facets are described in the Facets section.

The separator image is displayed automatically when you use page buttons that are displayed on the bottom. You can set the separator attribute to false to prevent the separator from being rendered.

HTML Elements and Layout

The contentPageTitle component can be used to create just a title for a page, or to provide a title and structure to the content area of the web application page. The content area is the portion where the main content of the page is displayed, and the user can optionally interact with the information.

If your application page includes a masthead and breadcrumbs, the webuijsf:contentPageTitle tag should be used after the webuijsf:masthead and webuijsf:breadcrumbs tags. If you want to use the contentPageTitle component's other features, such as page buttons and actions, you should place the rest of the page content within the webuijsf:contentPageTitle tag. You can use the supported facets to place the controls in the page along with your content. If you simply want to create a title, place the page content outside the webuijsf:contentPageTitle tag.

The webuijsf:contentPageTitle tag must be placed in a form if you are using the page controls.

The following diagram shows the location of the page elements and the names of the facets you can use to specify the content for each area.

Page Title Text (or optional pageTitle facet)

Optional pageButtonsTop facet

Optional help text or pageHelp facet
Optional pageActions facet

Optional pageViews facet

 

... JSF Page Content ..

 

Optional Page Separator or pageSeparator facet

  Optional pageButtonsBottom facet

 

Facets

The webuijsf:contentPageTitle tag supports the facets in the following table.

pageTitle
Specifies a component tag to use for the title of the content page of the web application. This facet overrides the title attribute.
pageButtonsTop

Specifies the buttons to use for the page buttons at the top right of the page. By default no buttons are rendered, so you must use this facet to display top page buttons. To display two or more buttons, enclose the webuijsf:button tags within a webuijsf:panelGroup tag.

pageButtonsBottom

Specifies the buttons to use for the page buttons at the bottom right of the page. By default no buttons are rendered, so you must use this facet to display bottom page buttons. To display two or more buttons, enclose the webuijsf:button tags within a webuijsf:panelGroup tag.

pageHelp Specifies a component tag to use for brief help text that is displayed under the page title. This facet overrides the helptext attribute.
pageActions Specifies component tags to use for any components that can be used to launch actions. Tags that might be used to launch actions include webuijsf:button and webuijsf:dropDown.
pageViews
Specifies a component tag that allows the user to change the view of the page. The webuijsf:dropDown tag can be used to provide a list of views.
pageSeparator Specifies a component tag to use for the separator image, such as the webuijsf:image tag. Display of the separator is controlled by the separator attribute.

Theme Identifiers

TBA

Client Side Javascript Functions

None.

Code Examples

Example 1: Using facets for optional contentPageTitle elements

<webuijsf:contentPageTitle title="Masthead and Page Title Example" helpText="Help text would go here">
   <f:facet name="pageButtonsTop">
     <webuijsf:panelGroup id="pageButtonsGroupTop"> 
       <webuijsf:button label="Save" action="#{MastheadBean.saveClicked}" /> 
       <webuijsf:button label="Reset" secondary="true" action="#{MastheadBean.resetClicked}" />
     </webuijsf:panelGroup> 
   </f:facet> 
   <f:facet name="pageButtonsBottom">
     <webuijsf:panelGroup id="pageButtonsGroupBottom"> 
       <webuijsf:button label="Save" action="#{MastheadBean.saveClicked}" /> 
       <webuijsf:button label="Reset" secondary="true" action="#{MastheadBean.resetClicked}" />
     </webuijsf:panelGroup> 
   </f:facet> 
   <f:facet name="pageActions">
     <webuijsf:panelGroup id="pageActionsGroup">
       <webuijsf:button label="Action 1" action="#{MastheadBean.action1Clicked}" />
       <webuijsf:button label="Action 2" action="#{MastheadBean.action2Clicked}" />
       <webuijsf:button label="Action 3" action="#{MastheadBean.action3Clicked}" />
     </webuijsf:panelGroup>
   </f:facet> 
   <f:facet name="pageViews">
     <webuijsf:dropDown label="View:" items="#{MastheadBean.views}" />
   </f:facet> 
       ... JSF page content ... 
 </webuijsf:contentPageTitle>


Tag Information
Tag Classcom.sun.webui.jsf.component.ContentPageTitleTag
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 binding 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 to be applied to the outermost HTML element when this component is rendered.

titlefalsefalsejava.lang.String

The text that is displayed as the page title.

separatorfalsefalsejava.lang.String

Indicates that the page title separator should be displayed, when set to true. The separator is a thin line that displays by default when bottom buttons are used. Set this attibute to false if the separator should not be displayed. This attribute also determines whether to display the pageSeparator facet.

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 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
helpTextfalsefalsejava.lang.String

The help text to display just below the page title.


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.