com.sun.webui.jsf.component
Class Page

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.Page
All Implemented Interfaces:
javax.faces.component.StateHolder

public class Page
extends javax.faces.component.UIComponentBase

The Page component is used to indicate the beginning of the part of the JSP page that is used by the Sun Java Web UI Components.


Constructor Summary
Page()
          Construct a new Page.
 
Method Summary
 java.lang.String getFamily()
          Return the family for this component.
 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 setId(java.lang.String id)
          The component identifier for this component.
 void setRendered(boolean rendered)
          Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page.
 void setXhtml(boolean xhtml)
          XHTML transitional page or HTML transitional page.
 
Methods inherited from class javax.faces.component.UIComponentBase
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Page

public Page()

Construct a new Page.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

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

setId

public void setId(java.lang.String id)
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

Overrides:
setId in class javax.faces.component.UIComponentBase

setRendered

public void setRendered(boolean rendered)
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.

Overrides:
setRendered in class javax.faces.component.UIComponentBase

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> attribute. 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> attribute. 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> attribute. 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> attribute. 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


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.