org.apache.myfaces.custom.document
Class AbstractDocument

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.document.AbstractDocument

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

Document, DocumentBody, DocumentHead

public class AbstractDocument
extends javax.faces.component.UIComponentBase

Base class to handle the document family

Version:

$Revision: 673833 $ $Date: 2008-07-03 16:58:05 -0500 (Thu, 03 Jul 2008) $

Author:

Mario Ivankovits (latest modification by $Author: skitching $)

Field Summary

static java.lang.String

COMPONENT_FAMILY

Constructor Summary

AbstractDocument(java.lang.String renderType)

Method Summary

java.lang.String	getFamily()
java.lang.String	getState() state="start|end".
boolean	hasState()
boolean	isEndState()
boolean	isStartState()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setState(java.lang.String state)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, 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

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

AbstractDocument

public AbstractDocument(java.lang.String renderType)

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setState

public void setState(java.lang.String state)

getState

public java.lang.String getState()

state="start|end". Used to demarkate the document boundaries

hasState

public boolean hasState()

isStartState

public boolean isStartState()

isEndState

public boolean isEndState()

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase