|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIPanel
org.ajax4jsf.component.UIAjaxRegion
org.ajax4jsf.component.html.HtmlPage
public class HtmlPage
Component-Type org.ajax4jsf.components.Page Component-Family org.ajax4jsf.components.AjaxRegion Renderer-Type org.ajax4jsf.components.AjaxPageRenderer This component renders a full HTML page structure. It must be the first (and only) child for the view root (JSP <f:view> tag). No HTML code can be outside of this component. It also has support for processing child components in AJAX requests, just like <a4j:region>. For a normal request, it will render the results of a <script> element with a client-side library at the page's <head>. If this component includes a "head" facet, the facet's content will also be rendered at the <head> element. For an AJAX request, only affected components in the full document structure will be rendered. Here's an example of using it in JSP (jspx version): <jsp:root xmlns:.... <f:view> <a4j:page><f:facet name="head"> ... </f:facet> <!-- page content here --> </a4j:page> </f:view></jsp:root>
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
Constructor Summary | |
---|---|
HtmlPage()
Constructor to init default renderers |
Method Summary | |
---|---|
java.lang.String |
getContentType()
Set custom mime content type to response Getter for contentType |
java.lang.String |
getDir()
Direction indication for text that does not inherit directionality. |
java.lang.String |
getFamily()
|
java.lang.String |
getFormat()
Page layout format ( html, xhtml, html-transitional, html-3.2 ) for encoding DOCTYPE, namespace and Content-Type definitions Getter for format |
java.lang.String |
getLang()
Code describing the language used in the generated markup for this component Getter for lang |
java.lang.String |
getNamespace()
Set html element default namespace Getter for namespace |
java.lang.String |
getOnload()
JavaScript code to execute on a page load. |
java.lang.String |
getOnunload()
JavaScript code to execute on a page unload. |
java.lang.String |
getPageTitle()
String for output as a page title. |
java.lang.String |
getStyle()
CSS style(s) is/are to be applied when this component is rendered Getter for style |
java.lang.String |
getStyleClass()
Corresponds to the HTML class attribute Getter for styleClass |
java.lang.String |
getTitle()
Advisory title information about markup elements generated for this component Getter for title |
boolean |
isRenderRegionOnly()
Flag to disable rendering in AJAX responses content outside of active region. |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setContentType(java.lang.String __contentType)
Set custom mime content type to response Setter for contentType |
void |
setDir(java.lang.String __dir)
Direction indication for text that does not inherit directionality. |
void |
setFormat(java.lang.String __format)
Page layout format ( html, xhtml, html-transitional, html-3.2 ) for encoding DOCTYPE, namespace and Content-Type definitions Setter for format |
void |
setLang(java.lang.String __lang)
Code describing the language used in the generated markup for this component Setter for lang |
void |
setNamespace(java.lang.String __namespace)
Set html element default namespace Setter for namespace |
void |
setOnload(java.lang.String __onload)
JavaScript code to execute on a page load. |
void |
setOnunload(java.lang.String __onunload)
JavaScript code to execute on a page unload. |
void |
setPageTitle(java.lang.String __pageTitle)
String for output as a page title. |
void |
setRenderRegionOnly(boolean __renderRegionOnly)
Flag to disable rendering in AJAX responses content outside of active region. |
void |
setStyle(java.lang.String __style)
CSS style(s) is/are to be applied when this component is rendered Setter for style |
void |
setStyleClass(java.lang.String __styleClass)
Corresponds to the HTML class attribute Setter for styleClass |
void |
setTitle(java.lang.String __title)
Advisory title information about markup elements generated for this component Setter for title |
Methods inherited from class org.ajax4jsf.component.UIAjaxRegion |
---|
addAjaxListener, broadcast, encodeAjax, encodeChildren, getAjaxListener, getAjaxListeners, isImmediate, isSelfRendered, isSubmitted, removeAjaxListener, setAjaxListener, setImmediate, setSelfRendered, setSubmitted |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeBegin, 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 |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
Constructor Detail |
---|
public HtmlPage()
Method Detail |
---|
public void setContentType(java.lang.String __contentType)
contentType
- - new valuepublic java.lang.String getContentType()
public void setDir(java.lang.String __dir)
dir
- - new valuepublic java.lang.String getDir()
public void setFormat(java.lang.String __format)
format
- - new valuepublic java.lang.String getFormat()
public void setLang(java.lang.String __lang)
lang
- - new valuepublic java.lang.String getLang()
public void setNamespace(java.lang.String __namespace)
namespace
- - new valuepublic java.lang.String getNamespace()
public void setOnload(java.lang.String __onload)
onload
- - new valuepublic java.lang.String getOnload()
public void setOnunload(java.lang.String __onunload)
onunload
- - new valuepublic java.lang.String getOnunload()
public void setPageTitle(java.lang.String __pageTitle)
pageTitle
- - new valuepublic java.lang.String getPageTitle()
public void setRenderRegionOnly(boolean __renderRegionOnly)
renderRegionOnly
- - new valuepublic boolean isRenderRegionOnly()
public void setStyle(java.lang.String __style)
style
- - new valuepublic java.lang.String getStyle()
public void setStyleClass(java.lang.String __styleClass)
styleClass
- - new valuepublic java.lang.String getStyleClass()
public void setTitle(java.lang.String __title)
title
- - new valuepublic java.lang.String getTitle()
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIPanel
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class UIAjaxRegion
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class UIAjaxRegion
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |