org.apache.myfaces.trinidad.component.html
Class HtmlHead

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.html.HtmlHead
All Implemented Interfaces:
EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class HtmlHead
extends UIXComponentBase

Tag for the HTML head element, including the document's title and any style sheets needed by th current look-and-feel. Page authors that use this do not need to use a styleSheet component, as it will automatically be included. The head component resets the Trinidad EL context when code re-enters the component via an invoke on component call or a visit tree call. See the org.apache.myfaces.trinidad.context.ComponentContextManager for more information.

Events:

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke
Application
Apply
Request
Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.


Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static PropertyKey PARTIAL_TRIGGERS_KEY
           
static PropertyKey TITLE_KEY
           
static FacesBean.Type TYPE
           
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
  HtmlHead()
          Construct an instance of the HtmlHead.
protected HtmlHead(String rendererType)
          Construct an instance of the HtmlHead.
 
Method Summary
protected  FacesBean.Type getBeanType()
           
 String getFamily()
           
 String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 String getTitle()
          Gets The title of the document.
 void setPartialTriggers(String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setTitle(String title)
          Sets The title of the document.
protected  void setupVisitingContext(javax.faces.context.FacesContext facesContext)
          Suspends any context changes before allowing invokeOnComponent or visitTree calls to continue, allowing components to undo any context changes during a re-entrant call.
protected  void tearDownVisitingContext(javax.faces.context.FacesContext facesContext)
          Re-applies the suspended context changes.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final FacesBean.Type TYPE

TITLE_KEY

public static final PropertyKey TITLE_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlHead

public HtmlHead()
Construct an instance of the HtmlHead.


HtmlHead

protected HtmlHead(String rendererType)
Construct an instance of the HtmlHead.

Method Detail

setupVisitingContext

protected void setupVisitingContext(javax.faces.context.FacesContext facesContext)
Suspends any context changes before allowing invokeOnComponent or visitTree calls to continue, allowing components to undo any context changes during a re-entrant call.

Overrides:
setupVisitingContext in class UIXComponent
Parameters:
facesContext - the faces context
See Also:
ComponentContextManager.suspend(FacesContext)

tearDownVisitingContext

protected void tearDownVisitingContext(javax.faces.context.FacesContext facesContext)
Re-applies the suspended context changes.

Overrides:
tearDownVisitingContext in class UIXComponent
Parameters:
facesContext - the faces context
See Also:
setupVisitingContext(FacesContext), ComponentContextManager.resume(FacesContext, SuspendedContextChanges)

getTitle

public final String getTitle()
Gets The title of the document. (This title doesn't have to match the title on any contained panelPage.)

Returns:
the new title value

setTitle

public final void setTitle(String title)
Sets The title of the document. (This title doesn't have to match the title on any contained panelPage.)

Parameters:
title - the new title value

getPartialTriggers

public final String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Parameters:
partialTriggers - the new partialTriggers value

getFamily

public String getFamily()
Specified by:
getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXComponentBase


Copyright © 2001-2012 The Apache Software Foundation. All Rights Reserved.