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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.rave.web.ui.component.PageBase
All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
Page

public abstract class PageBase
extends javax.faces.component.UIComponentBase

Use the ui:page tag to indicate the beginning of the part of the JSP page that is used by the Sun Java Web UI Components. All the JSF components used in the page must be nested within the ui:page tag. You must use the ui:html and ui:head tags first, after the opening of the ui:page tag.  Then you must use either the ui:body tag or the ui:frameset tag.  The ui:page tag takes care of generating the preamble for the HTML page.

HTML Elements and Layout

If the application is used in a servlet environment, the rendered HTML will include <?xml> and <!DOCTYPE> headers. The content of the headers is determined by the ui:page attributes that you specify.  Use the frameset and xhtml attributes to create the <!DOCTYPE> header that you want.  For example, if you set frameset and xhtml attributes to true, the rendered <!DOCTYPE> header will indicate XHTML Frameset, as in the following example:

<!DOCTYPE HTML 
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">

If you set both attributes to false,  the rendered <!DOCTYPE> header will indicate HTML Transitional,  as in the following example:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

You can also use the frameset and xhtml attributes to specify  XHTML Transitional and HTML Frameset.

Client Side Javascript Functions

None.

Example

Example 1: Using the page tag appropriately in a JSP page:

<?xml version="1.0" encoding="UTF-8"?>
<jsp:root version="1.2" xmlns:f="http://java.sun.com/jsf/core" xmlns:h="http://java.sun.com/jsf/html" xmlns:jsp="http://java.sun.com/JSP/Page" xmlns:ui="http://www.sun.com/web/ui">
<jsp:directive.page contentType="text/html;charset=ISO-8859-1" pageEncoding="UTF-8"/>
<f:view>
  <ui:page>
    <ui:html>
       ......
    <
/ui:html>
  </ui:page>
</f:view>

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


Field Summary
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
PageBase()
          Construct a new PageBase.
 
Method Summary
 java.lang.String getFamily()
          Return the identifier of the component family to which this component belongs.
 boolean isFrame()
          Use the frame attribute to indicate whether the page should render frames.
 boolean isXhtml()
          XHTML transitional page or HTML transitional page.
 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 setFrame(boolean frame)
          Use the frame attribute to indicate whether the page should render frames.
 void setXhtml(boolean xhtml)
          XHTML transitional page or HTML transitional page.
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageBase

public PageBase()

Construct a new PageBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.

Specified by:
getFamily in class javax.faces.component.UIComponent

isFrame

public boolean isFrame()

Use the frame attribute to indicate whether the page should render frames. If this attribute is true, the rendered HTML page includes a <frameset> element. If false, the rendered page uses a <body> tag.  This attribute also influences the rendering of the <!DOCTYPE> declaration. If frameset is true, the <!DOCTYPE> will be one of the following, depending on the setting of xhtml attribute.

<!DOCTYPE html 
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">

<!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
"http://www.w3.org/TR/html4/DTD/frameset.dtd">


setFrame

public void setFrame(boolean frame)

Use the frame attribute to indicate whether the page should render frames. If this attribute is true, the rendered HTML page includes a <frameset> element. If false, the rendered page uses a <body> tag.  This attribute also influences the rendering of the <!DOCTYPE> declaration. If frameset is true, the <!DOCTYPE> will be one of the following, depending on the setting of xhtml attribute.

<!DOCTYPE html 
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">

<!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
"http://www.w3.org/TR/html4/DTD/frameset.dtd">

See Also:
isFrame()

isXhtml

public boolean isXhtml()

XHTML transitional page or HTML transitional page. This attribute influences the rendering of the <!DOCTYPE> declaration. If xhtml is true, the <!DOCTYPE> will be one of the following, depending on the setting of frameset attribute.

<!DOCTYPE html 
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"
<!DOCTYPE html 
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


setXhtml

public void setXhtml(boolean xhtml)

XHTML transitional page or HTML transitional page. This attribute influences the rendering of the <!DOCTYPE> declaration. If xhtml is true, the <!DOCTYPE> will be one of the following, depending on the setting of frameset attribute.

<!DOCTYPE html 
PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"
<!DOCTYPE html 
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

See Also:
isXhtml()

restoreState

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

Restore the state of this component.

Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase

saveState

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

Save the state of this component.

Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase