Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.sun.rave.web.ui.component
Class HeadBase

java.lang.Object
  extended byjavax.faces.component.UIComponent
      extended byjavax.faces.component.UIComponentBase
          extended bycom.sun.rave.web.ui.component.HeadBase
All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
Head
public abstract class HeadBase
extends javax.faces.component.UIComponentBase

Use the ui:head tag to provide information about the document, to be used in the <head> element of the rendered HTML page.  The ui:head tag must be placed immediately after the ui:html tag, within the ui:page tag.   The following tags can be used as children of the ui:head tag:

HTML Elements and Layout

The <head> element is rendered in the HTML page, and can include information that is valid for inclusion in the HTML <head> element. For example, if you use the ui:link tag in the ui:head tag, you can provide the URL to a style sheet. The style sheet link  will be rendered as a <link> element in the <head> element of the HTML page.  In addition this tag will output the appropriate stylesheets for the included components on the page.

The browser does not display the information in the <head> element to the user, with the exception of the title that is used in the browser's title bar.  

Client Side Javascript Functions

None.

Example

Example 1: Create a head tag

<ui:page>
    <ui:html>
        <ui:head title="Name of the page..title is required">
            <ui:link url="/relativepath/x.css" />
                <ui:script url="/relativepath/x.js" />
        </ui:head>
        <ui:body>
            ....your page content....
        </ui:body>
    </ui:html> </ui:page> 

Auto-generated component class. Do NOT modify; all changes will be lost!

Constructor Summary
HeadBase()
          Construct a new HeadBase.
 
Method Summary
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getProfile()
          A space separated list of URL's that contains meta data information about the page
 java.lang.String getTitle()
          Title of the document to be displayed in the browser title bar.
 boolean isDefaultBase()
          Flag (true or false) indicating that a default html base tag should be shown or not.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
          Restore the state of this component.
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
          Save the state of this component.
 void setDefaultBase(boolean defaultBase)
          Flag (true or false) indicating that a default html base tag should be shown or not.
 void setProfile(java.lang.String profile)
          A space separated list of URL's that contains meta data information about the page
 void setTitle(java.lang.String title)
          Title of the document to be displayed in the browser title bar.
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HeadBase

public HeadBase()

Construct a new HeadBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

isDefaultBase

public boolean isDefaultBase()

Flag (true or false) indicating that a default html base tag should be shown or not. Changing this attribute could cause ui:anchor to not work properly. The default value is false.

setDefaultBase

public void setDefaultBase(boolean defaultBase)

Flag (true or false) indicating that a default html base tag should be shown or not. Changing this attribute could cause ui:anchor to not work properly. The default value is false.

See Also:
isDefaultBase()

getProfile

public java.lang.String getProfile()

A space separated list of URL's that contains meta data information about the page

setProfile

public void setProfile(java.lang.String profile)

A space separated list of URL's that contains meta data information about the page

See Also:
getProfile()

getTitle

public java.lang.String getTitle()

Title of the document to be displayed in the browser title bar.

setTitle

public void setTitle(java.lang.String title)

Title of the document to be displayed in the browser title bar.

See Also:
getTitle()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD