com.sun.webui.jsf.component
Class Head

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

public class Head
extends javax.faces.component.UIComponentBase

The Head component is used to provide information to be used in the head element.


Field Summary
static java.lang.String TITLE_FACET
          Title facet identifier
 
Constructor Summary
Head()
          Construct a new Head.
 
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 isDebug()
          Test flag indicating that debugging is enabled.
 boolean isDefaultBase()
          Flag (true or false) indicating that a default html base tag should be shown or not.
 boolean isDijitAll()
          Deprecated. Dojo is no longer included in the page.
 boolean isJavaScript()
          Test flag indicating that component JavaScript should be output in page.
 boolean isJsfx()
          Test flag indicating to include JSF Extensions.
 boolean isMeta()
          Deprecated. Using meta tags and pragma headers are not very effective for broswer caching. In fact, they are only honored by a few browser caches. For more information, see http://www.mnot.net/cache_docs/#META.
 boolean isParseOnLoad()
          Test flag indicating to parse HTML markup.
 boolean isStyleSheet()
          If set to true, a link element with a reference to the theme stylesheet resource is rendered.
 boolean isWebuiAll()
          Test flag indicating to include all webui functionality.
 boolean isWebuiJsfx()
          Test flag indicating to include default Ajax functionality.
 boolean isWebuiOnLoad()
          Test flag indicating to include default Ajax functionality.
 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 setDebug(boolean debug)
          Set flag indicating that debugging is enabled.
 void setDefaultBase(boolean defaultBase)
          Flag (true or false) indicating that a default html base tag should be shown or not.
 void setDijitAll(boolean dijitAll)
          Deprecated. Dojo is no longer included in the page.
 void setId(java.lang.String id)
          The component identifier for this component.
 void setJavaScript(boolean javaScript)
          Set flag indicating that component JavaScript should be output in page.
 void setJsfx(boolean jsfx)
          Set flag indicating to include JSF Extensions.
 void setMeta(boolean meta)
          Deprecated. Using meta tags and pragma headers are not very effective for broswer caching. In fact, they are only honored by a few browser caches. For more information, see http://www.mnot.net/cache_docs/#META.
 void setParseOnLoad(boolean parseOnLoad)
          Set flag indicating to parse HTML markup.
 void setProfile(java.lang.String profile)
          A space separated list of URL's that contains meta data information about the page
 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 setStyleSheet(boolean styleSheet)
          If set to true, a link element with a reference to the theme stylesheet resource is rendered.
 void setTitle(java.lang.String title)
          Title of the document to be displayed in the browser title bar.
 void setWebuiAll(boolean webuiAll)
          Flag indicating to include all webui functionality.
 void setWebuiJsfx(boolean webuiJsfx)
          Set flag indicating to include default Ajax functionality.
 void setWebuiOnLoad(boolean webuiOnLoad)
          Set flag indicating to include default Ajax functionality.
 
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
 

Field Detail

TITLE_FACET

public static final java.lang.String TITLE_FACET
Title facet identifier

See Also:
Constant Field Values
Constructor Detail

Head

public Head()

Construct a new Head.

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

isDebug

public boolean isDebug()
Test flag indicating that debugging is enabled.


setDebug

public void setDebug(boolean debug)
Set flag indicating that debugging is enabled.


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 webuijsf: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 webuijsf:anchor to not work properly. The default value is false.

See Also:
isDefaultBase()

isDijitAll

public boolean isDijitAll()
Deprecated. Dojo is no longer included in the page.

Test flag indicating to include all Dojo dijit functionality.


setDijitAll

public void setDijitAll(boolean dijitAll)
Deprecated. Dojo is no longer included in the page.

Set flag indicating to include all Dojo dijit functionality.


isJavaScript

public boolean isJavaScript()
Test flag indicating that component JavaScript should be output in page.


setJavaScript

public void setJavaScript(boolean javaScript)
Set flag indicating that component JavaScript should be output in page.


isJsfx

public boolean isJsfx()
Test flag indicating to include JSF Extensions.


setJsfx

public void setJsfx(boolean jsfx)
Set flag indicating to include JSF Extensions.


isMeta

public boolean isMeta()
Deprecated. Using meta tags and pragma headers are not very effective for broswer caching. In fact, they are only honored by a few browser caches. For more information, see http://www.mnot.net/cache_docs/#META.

Test flag indicating if the default meta data should be rendered.


setMeta

public void setMeta(boolean meta)
Deprecated. Using meta tags and pragma headers are not very effective for broswer caching. In fact, they are only honored by a few browser caches. For more information, see http://www.mnot.net/cache_docs/#META.

Set flag indicating if the default meta data should be rendered.


isParseOnLoad

public boolean isParseOnLoad()
Test flag indicating to parse HTML markup.


setParseOnLoad

public void setParseOnLoad(boolean parseOnLoad)
Set flag indicating to parse HTML markup.


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()

isStyleSheet

public boolean isStyleSheet()

If set to true, a link element with a reference to the theme stylesheet resource is rendered.


setStyleSheet

public void setStyleSheet(boolean styleSheet)

If set to true, a link element with a reference to the theme stylesheet resource is rendered.

See Also:
isStyleSheet()

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()

isWebuiAll

public boolean isWebuiAll()
Test flag indicating to include all webui functionality.


setWebuiAll

public void setWebuiAll(boolean webuiAll)
Flag indicating to include all webui functionality.


isWebuiJsfx

public boolean isWebuiJsfx()
Test flag indicating to include default Ajax functionality.


setWebuiJsfx

public void setWebuiJsfx(boolean webuiJsfx)
Set flag indicating to include default Ajax functionality.


isWebuiOnLoad

public boolean isWebuiOnLoad()
Test flag indicating to include default Ajax functionality.


setWebuiOnLoad

public void setWebuiOnLoad(boolean webuiOnLoad)
Set flag indicating to include default Ajax functionality.


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.