oracle.adf.view.rich.component.rich.layout

Class RichPanelDashboard

java.lang.Object

javax.faces.component.UIComponent

org.apache.myfaces.trinidad.component.UIXComponent

org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXPanel

oracle.adf.view.rich.component.rich.layout.PartialRichPanelDashboard

oracle.adf.view.rich.component.rich.layout.RichPanelDashboard

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichPanelDashboard
extends PartialRichPanelDashboard

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields inherited from class oracle.adf.view.rich.component.rich.layout.PartialRichPanelDashboard

CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY, CLIENT_LISTENERS_KEY, COLUMNS_KEY, COMPONENT_FAMILY, COMPONENT_TYPE, CUSTOMIZATION_ID_KEY, DIMENSIONS_FROM_AUTO, DIMENSIONS_FROM_CHILDREN, DIMENSIONS_FROM_KEY, DIMENSIONS_FROM_PARENT, DROP_LISTENER_KEY, INLINE_STYLE_KEY, PARTIAL_TRIGGERS_KEY, ROW_HEIGHT_KEY, SHORT_DESC_KEY, STYLE_CLASS_KEY, TYPE, UNSECURE_KEY, VISIBLE_KEY

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

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
	RichPanelDashboard() Construct an instance of the RichPanelDashboard.
protected	RichPanelDashboard(String rendererType) Construct an instance of the RichPanelDashboard.

Method Summary

Methods

Modifier and Type	Method and Description
void	prepareOptimizedEncodingOfDeletedChild(javax.faces.context.FacesContext context, int deletedChildIndex) To be used by an action listener that is modifying the children of this panelDashboard.
void	prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context) To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert".
void	prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context, int insertedChildIndex) To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert".

Methods inherited from class oracle.adf.view.rich.component.rich.layout.PartialRichPanelDashboard

addClientBehavior, getBeanType, getClientAttributes, getClientBehaviors, getClientListeners, getColumns, getCustomizationId, getDefaultEventName, getDimensionsFrom, getDropListener, getEventNames, getFamily, getInlineStyle, getPartialTriggers, getRowHeight, getShortDesc, getStyleClass, getUnsecure, isClientComponent, isVisible, setClientAttributes, setClientComponent, setClientListeners, setColumns, setCustomizationId, setDimensionsFrom, setDropListener, setInlineStyle, setPartialTriggers, setRowHeight, setShortDesc, setStyleClass, setUnsecure, setVisible

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, 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, removeComponentChangeFilter, 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, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

Constructor Detail

RichPanelDashboard

public RichPanelDashboard()

Construct an instance of the RichPanelDashboard.

RichPanelDashboard

protected RichPanelDashboard(String rendererType)

Construct an instance of the RichPanelDashboard.

Method Detail

prepareOptimizedEncodingOfInsertedChild

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

To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert". The behavior tag will create the DOM and display a "loading" message. In your action listener, you will adjust the component tree for your children of the panelDashboard. Once that is done, you would then call this method to cause the panelDashboard to draw only its last child. This will skip encoding of all of the other children and swap out the temporary "loading" box with this new last child.

Parameters:

context - the FacesContext

prepareOptimizedEncodingOfInsertedChild

public void prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context,
                                           int insertedChildIndex)

To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert". The behavior tag will create the DOM and display a "loading" message. In your action listener, you will adjust the component tree for your children of the panelDashboard. Once that is done, you would then call this method to cause the panelDashboard to draw only the specified child. This will skip encoding of all of the other children and swap out the temporary "loading" box with this new child.

Parameters:

context - the FacesContext

insertedChildIndex - the index of the child that has been inserted

prepareOptimizedEncodingOfDeletedChild

public void prepareOptimizedEncodingOfDeletedChild(javax.faces.context.FacesContext context,
                                          int deletedChildIndex)

To be used by an action listener that is modifying the children of this panelDashboard. Once you have done the work to delete the child, call this method so that the panelDashboard can draw the deletion of this child.

Parameters:

context - the FacesContext

deletedChildIndex - the index of the child that has been deleted