org.apache.myfaces.trinidad.component.core
Class CoreDocument

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.UIXDocument
                  extended by org.apache.myfaces.trinidad.component.core.CoreDocument
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class CoreDocument
extends UIXDocument
implements javax.faces.component.behavior.ClientBehaviorHolder

The CoreDocument creates each of the standard root elements of an HTML page: <html>, <body>, and <head>, but by abstracting away from those components, can be used in non-HTML pages as well.

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 INITIAL_FOCUS_ID_KEY
           
static PropertyKey INLINE_STYLE_KEY
           
static String META_CONTAINER_FACET
           
static String MODE_DEFAULT
           
static PropertyKey MODE_KEY
           
static String MODE_QUIRKS
           
static String MODE_STRICT
           
static PropertyKey ONCLICK_KEY
           
static PropertyKey ONDBLCLICK_KEY
           
static PropertyKey ONKEYDOWN_KEY
           
static PropertyKey ONKEYPRESS_KEY
           
static PropertyKey ONKEYUP_KEY
           
static PropertyKey ONLOAD_KEY
           
static PropertyKey ONMOUSEDOWN_KEY
           
static PropertyKey ONMOUSEMOVE_KEY
           
static PropertyKey ONMOUSEOUT_KEY
           
static PropertyKey ONMOUSEOVER_KEY
           
static PropertyKey ONMOUSEUP_KEY
           
static PropertyKey ONUNLOAD_KEY
           
static PropertyKey PARTIAL_TRIGGERS_KEY
           
static PropertyKey SHORT_DESC_KEY
           
static String STATE_SAVING_CLIENT
           
static String STATE_SAVING_DEFAULT
           
static PropertyKey STATE_SAVING_KEY
           
static String STATE_SAVING_SERVER
           
static PropertyKey STYLE_CLASS_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
  CoreDocument()
          Construct an instance of the CoreDocument.
protected CoreDocument(String rendererType)
          Construct an instance of the CoreDocument.
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
protected  FacesBean.Type getBeanType()
           
 Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
 String getDefaultEventName()
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
 Collection<String> getEventNames()
           
 String getFamily()
           
 String getInitialFocusId()
          Gets the id of the component to which you want the focus to be when the full page renders.
 String getInlineStyle()
          Gets the CSS styles to use for this component.
 javax.faces.component.UIComponent getMetaContainer()
          Content to be rendered as meta data inside the "head" section.
 String getMode()
          Gets Set if the page should render in default standards mode, quirks mode, or strict mode.
 String getOnclick()
          Gets an onclick Javascript handler.
 String getOndblclick()
          Gets an ondblclick Javascript handler.
 String getOnkeydown()
          Gets an onkeydown Javascript handler.
 String getOnkeypress()
          Gets an onkeypress Javascript handler.
 String getOnkeyup()
          Gets an onkeyup Javascript handler.
 String getOnload()
          Gets an onload Javascript handler.
 String getOnmousedown()
          Gets an onmousedown Javascript handler.
 String getOnmousemove()
          Gets an onmousemove Javascript handler.
 String getOnmouseout()
          Gets an onmouseout Javascript handler.
 String getOnmouseover()
          Gets an onmouseover Javascript handler.
 String getOnmouseup()
          Gets an onmouseup Javascript handler.
 String getOnunload()
          Gets an onunload Javascript handler.
 String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 String getShortDesc()
          Gets The short description of the component.
 String getStateSaving()
          Gets Specify the state saving behavior for this page.
 String getStyleClass()
          Gets a CSS style class to use for this component.
 String getTitle()
          Gets The title of the document.
 void setInitialFocusId(String initialFocusId)
          Sets the id of the component to which you want the focus to be when the full page renders.
 void setInlineStyle(String inlineStyle)
          Sets the CSS styles to use for this component.
 void setMetaContainer(javax.faces.component.UIComponent metaContainerFacet)
          Content to be rendered as meta data inside the "head" section.
 void setMode(String mode)
          Sets Set if the page should render in default standards mode, quirks mode, or strict mode.
 void setOnclick(String onclick)
          Sets an onclick Javascript handler.
 void setOndblclick(String ondblclick)
          Sets an ondblclick Javascript handler.
 void setOnkeydown(String onkeydown)
          Sets an onkeydown Javascript handler.
 void setOnkeypress(String onkeypress)
          Sets an onkeypress Javascript handler.
 void setOnkeyup(String onkeyup)
          Sets an onkeyup Javascript handler.
 void setOnload(String onload)
          Sets an onload Javascript handler.
 void setOnmousedown(String onmousedown)
          Sets an onmousedown Javascript handler.
 void setOnmousemove(String onmousemove)
          Sets an onmousemove Javascript handler.
 void setOnmouseout(String onmouseout)
          Sets an onmouseout Javascript handler.
 void setOnmouseover(String onmouseover)
          Sets an onmouseover Javascript handler.
 void setOnmouseup(String onmouseup)
          Sets an onmouseup Javascript handler.
 void setOnunload(String onunload)
          Sets an onunload Javascript handler.
 void setPartialTriggers(String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setShortDesc(String shortDesc)
          Sets The short description of the component.
 void setStateSaving(String stateSaving)
          Sets Specify the state saving behavior for this page.
 void setStyleClass(String styleClass)
          Sets a CSS style class to use for this component.
 void setTitle(String title)
          Sets The title of the document.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXDocument
setupVisitingContext, tearDownVisitingContext
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, 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

STATE_SAVING_DEFAULT

public static final String STATE_SAVING_DEFAULT
See Also:
Constant Field Values

STATE_SAVING_CLIENT

public static final String STATE_SAVING_CLIENT
See Also:
Constant Field Values

STATE_SAVING_SERVER

public static final String STATE_SAVING_SERVER
See Also:
Constant Field Values

MODE_DEFAULT

public static final String MODE_DEFAULT
See Also:
Constant Field Values

MODE_STRICT

public static final String MODE_STRICT
See Also:
Constant Field Values

MODE_QUIRKS

public static final String MODE_QUIRKS
See Also:
Constant Field Values

TYPE

public static final FacesBean.Type TYPE

TITLE_KEY

public static final PropertyKey TITLE_KEY

STATE_SAVING_KEY

public static final PropertyKey STATE_SAVING_KEY

MODE_KEY

public static final PropertyKey MODE_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

ONLOAD_KEY

public static final PropertyKey ONLOAD_KEY

ONUNLOAD_KEY

public static final PropertyKey ONUNLOAD_KEY

INITIAL_FOCUS_ID_KEY

public static final PropertyKey INITIAL_FOCUS_ID_KEY

META_CONTAINER_FACET

public static final String META_CONTAINER_FACET
See Also:
Constant Field Values

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

CoreDocument

public CoreDocument()
Construct an instance of the CoreDocument.


CoreDocument

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

Method Detail

getMetaContainer

public final javax.faces.component.UIComponent getMetaContainer()
Content to be rendered as meta data inside the "head" section.


setMetaContainer

public final void setMetaContainer(javax.faces.component.UIComponent metaContainerFacet)
Content to be rendered as meta data inside the "head" section.


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

getStateSaving

public final String getStateSaving()
Gets Specify the state saving behavior for this page. client=force to be (full) client; server=force to be server-side; default=follows the settings of the web.xml

Returns:
the new stateSaving value

setStateSaving

public final void setStateSaving(String stateSaving)
Sets Specify the state saving behavior for this page. client=force to be (full) client; server=force to be server-side; default=follows the settings of the web.xml

Parameters:
stateSaving - the new stateSaving value

getMode

public final String getMode()
Gets Set if the page should render in default standards mode, quirks mode, or strict mode. Behavior of the modes are:

Returns:
the new mode value

setMode

public final void setMode(String mode)
Sets Set if the page should render in default standards mode, quirks mode, or strict mode. Behavior of the modes are:

Parameters:
mode - the new mode value

getInlineStyle

public final String getInlineStyle()
Gets the CSS styles to use for this component.

Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.

Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final String getStyleClass()
Gets a CSS style class to use for this component.

Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(String styleClass)
Sets a CSS style class to use for this component.

Parameters:
styleClass - the new styleClass value

getShortDesc

public final String getShortDesc()
Gets The short description of the component. This text is commonly used by user agents to display tooltip help text.

Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)
Sets The short description of the component. This text is commonly used by user agents to display tooltip help text.

Parameters:
shortDesc - the new shortDesc 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.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

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.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

Parameters:
partialTriggers - the new partialTriggers value

getOnclick

public final String getOnclick()
Gets an onclick Javascript handler.

Returns:
the new onclick value

setOnclick

public final void setOnclick(String onclick)
Sets an onclick Javascript handler.

Parameters:
onclick - the new onclick value

getOndblclick

public final String getOndblclick()
Gets an ondblclick Javascript handler.

Returns:
the new ondblclick value

setOndblclick

public final void setOndblclick(String ondblclick)
Sets an ondblclick Javascript handler.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public final String getOnmousedown()
Gets an onmousedown Javascript handler.

Returns:
the new onmousedown value

setOnmousedown

public final void setOnmousedown(String onmousedown)
Sets an onmousedown Javascript handler.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public final String getOnmouseup()
Gets an onmouseup Javascript handler.

Returns:
the new onmouseup value

setOnmouseup

public final void setOnmouseup(String onmouseup)
Sets an onmouseup Javascript handler.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public final String getOnmouseover()
Gets an onmouseover Javascript handler.

Returns:
the new onmouseover value

setOnmouseover

public final void setOnmouseover(String onmouseover)
Sets an onmouseover Javascript handler.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public final String getOnmousemove()
Gets an onmousemove Javascript handler.

Returns:
the new onmousemove value

setOnmousemove

public final void setOnmousemove(String onmousemove)
Sets an onmousemove Javascript handler.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public final String getOnmouseout()
Gets an onmouseout Javascript handler.

Returns:
the new onmouseout value

setOnmouseout

public final void setOnmouseout(String onmouseout)
Sets an onmouseout Javascript handler.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public final String getOnkeypress()
Gets an onkeypress Javascript handler.

Returns:
the new onkeypress value

setOnkeypress

public final void setOnkeypress(String onkeypress)
Sets an onkeypress Javascript handler.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public final String getOnkeydown()
Gets an onkeydown Javascript handler.

Returns:
the new onkeydown value

setOnkeydown

public final void setOnkeydown(String onkeydown)
Sets an onkeydown Javascript handler.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public final String getOnkeyup()
Gets an onkeyup Javascript handler.

Returns:
the new onkeyup value

setOnkeyup

public final void setOnkeyup(String onkeyup)
Sets an onkeyup Javascript handler.

Parameters:
onkeyup - the new onkeyup value

getOnload

public final String getOnload()
Gets an onload Javascript handler.

Returns:
the new onload value

setOnload

public final void setOnload(String onload)
Sets an onload Javascript handler.

Parameters:
onload - the new onload value

getOnunload

public final String getOnunload()
Gets an onunload Javascript handler.

Returns:
the new onunload value

setOnunload

public final void setOnunload(String onunload)
Sets an onunload Javascript handler.

Parameters:
onunload - the new onunload value

getInitialFocusId

public final String getInitialFocusId()
Gets the id of the component to which you want the focus to be when the full page renders. The accessibility-mode must be set to "inaccessible" for this feature to be on.

Returns:
the new initialFocusId value

setInitialFocusId

public final void setInitialFocusId(String initialFocusId)
Sets the id of the component to which you want the focus to be when the full page renders. The accessibility-mode must be set to "inaccessible" for this feature to be on.

Parameters:
initialFocusId - the new initialFocusId value

getDefaultEventName

public String getDefaultEventName()
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getDefaultEventName in class UIXComponentBase
Returns:
null
See Also:
ClientBehaviorHolder.getDefaultEventName()

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getClientBehaviors in class UIXComponentBase
Returns:
Read-only map of the client behaviors for this component
See Also:
ClientBehaviorHolder.getClientBehaviors()

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class UIXComponentBase
Parameters:
eventName - The event name
behavior - The behavior to add
See Also:
ClientBehaviorHolder.addClientBehavior(String, ClientBehavior)

getFamily

public String getFamily()
Overrides:
getFamily in class UIXDocument

getBeanType

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


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