com.ibm.xsp.component
Class UIDataPanelBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              com.ibm.xsp.component.UIDataPanelBase

All Implemented Interfaces:

FacesComponent, FacesDataProvider, javax.faces.component.StateHolder

Direct Known Subclasses:

UIPanelEx, UIRepeatContainer

public abstract class UIDataPanelBase
extends javax.faces.component.UIPanel
implements FacesComponent, FacesDataProvider

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Fields inherited from interface com.ibm.xsp.component.FacesDataProvider

DATA, DATA_CONTEXTS

Constructor Summary

UIDataPanelBase()

Method Summary

void	_xspCleanTransientData()
void	addData(DataSource data) Add a DataSource instance to the set associated with this component.
void	addDataContext(DataContext dataContext) Add a DataContext instance to the set associated with this component.
protected void	afterEncoding(javax.faces.context.FacesContext context)
protected void	beforeEncoding(javax.faces.context.FacesContext context)
void	broadcast(javax.faces.event.FacesEvent event)
void	buildContents(javax.faces.context.FacesContext context, FacesComponentBuilder builder) Build the component children and facets, the default implementation is usually: builder.buildAll(context, this, true); // includeFacets=true
void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeEnd(javax.faces.context.FacesContext context)
ACL	getAcl() Return the ACL
java.util.List<DataSource>	getData() Returns the list of data source objects.
java.util.List<DataContext>	getDataContexts() Returns the list of data context objects.
protected boolean	hasUserAccess(javax.faces.context.FacesContext context, int minRights) Check does user have access to this panel
void	initAfterContents(javax.faces.context.FacesContext context) Perform component initialization after it's children and facets are added.
void	initBeforeContents(javax.faces.context.FacesContext context) Perform component initialization before its children and facets are added.
boolean	invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback)
protected boolean	isAllowCreateViewPublish(javax.faces.context.FacesContext context)
boolean	isReadonly() This is not a plain getter for the "readonly" property in the All Properties tab, as it also uses the "acl" property, see getAcl().
boolean	isRendered()
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
protected java.util.List<DataPublisher.ShadowedObject>	publishControlData(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
protected void	revokeControlData(java.util.List<DataPublisher.ShadowedObject> shadowedData, javax.faces.context.FacesContext context)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAcl(ACL acl) Set the ACL
void	setReadonly(boolean readonly)
boolean	visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

_xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, isVisitable, markInitialState, setControlState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIDataPanelBase

public UIDataPanelBase()

Method Detail

isRendered

public boolean isRendered()

Overrides:

isRendered in class javax.faces.component.UIComponentBase

_xspCleanTransientData

public void _xspCleanTransientData()

Overrides:

_xspCleanTransientData in class javax.faces.component.UIComponentBase

isReadonly

public boolean isReadonly()

This is not a plain getter for the "readonly" property in the All Properties tab, as it also uses the "acl" property, see getAcl().

setReadonly

public void setReadonly(boolean readonly)

getData

public java.util.List<DataSource> getData()

Returns the list of data source objects.

Specified by:

getData in interface FacesDataProvider

Returns:

The list of data source objects.

addData

public void addData(DataSource data)

Add a DataSource instance to the set associated with this component.

Specified by:

addData in interface FacesDataProvider

Parameters:

data - The data source to add.

getDataContexts

public java.util.List<DataContext> getDataContexts()

Returns the list of data context objects.

Specified by:

getDataContexts in interface FacesDataProvider

Returns:

The list of data context objects.

addDataContext

public void addDataContext(DataContext dataContext)

Add a DataContext instance to the set associated with this component.

Specified by:

addDataContext in interface FacesDataProvider

Parameters:

dataContexts - The data context to add.

getAcl

public ACL getAcl()

Return the ACL

setAcl

public void setAcl(ACL acl)

Set the ACL

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

beforeEncoding

protected void beforeEncoding(javax.faces.context.FacesContext context)

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws java.io.IOException

Overrides:

encodeEnd in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

afterEncoding

protected void afterEncoding(javax.faces.context.FacesContext context)

isAllowCreateViewPublish

protected boolean isAllowCreateViewPublish(javax.faces.context.FacesContext context)

Parameters:

context -

Returns:

See Also:

DataPublisher.isAllowCreateViewPublish(javax.faces.component.UIComponent)

publishControlData

protected java.util.List<DataPublisher.ShadowedObject> publishControlData(javax.faces.context.FacesContext context)

Parameters:

context -

Returns:

See Also:

DataPublisher.publishControlData(javax.faces.component.UIComponent)

revokeControlData

protected void revokeControlData(java.util.List<DataPublisher.ShadowedObject> shadowedData,
                                 javax.faces.context.FacesContext context)

Parameters:

shadowedData -

context -

See Also:

DataPublisher.revokeControlData(List, javax.faces.component.UIComponent)

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class javax.faces.component.UIComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 java.lang.String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class javax.faces.component.UIComponent

Throws:

javax.faces.FacesException

visitTree

public boolean visitTree(javax.faces.component.visit.VisitContext context,
                         javax.faces.component.visit.VisitCallback callback)

Overrides:

visitTree in class javax.faces.component.UIComponent

initBeforeContents

public void initBeforeContents(javax.faces.context.FacesContext context)
                        throws javax.faces.FacesException

Description copied from interface: FacesComponent

Perform component initialization before its children and facets are added.

Specified by:

initBeforeContents in interface FacesComponent

Throws:

javax.faces.FacesException

buildContents

public void buildContents(javax.faces.context.FacesContext context,
                          FacesComponentBuilder builder)
                   throws javax.faces.FacesException

Description copied from interface: FacesComponent

Build the component children and facets, the default implementation is usually:
builder.buildAll(context, this, true); // includeFacets=true

Specified by:

buildContents in interface FacesComponent

Throws:

javax.faces.FacesException

initAfterContents

public void initAfterContents(javax.faces.context.FacesContext context)
                       throws javax.faces.FacesException

Description copied from interface: FacesComponent

Perform component initialization after it's children and facets are added.

Specified by:

initAfterContents in interface FacesComponent

Throws:

javax.faces.FacesException

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

hasUserAccess

protected boolean hasUserAccess(javax.faces.context.FacesContext context,
                                int minRights)

Check does user have access to this panel