Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.1.0)
E17488-02


oracle.adf.view.rich.component.fragment
Class UIXDeclarativeComponent

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 oracle.adf.view.rich.component.fragment.ContextSwitchingComponent
                  extended by oracle.adf.view.rich.component.fragment.UIXInclude
                      extended by oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent

All Implemented Interfaces:
java.util.EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.apache.myfaces.trinidad.component.FlattenedComponent
Direct Known Subclasses:
RichDeclarativeComponent

public class UIXDeclarativeComponent
extends UIXInclude
implements javax.faces.component.NamingContainer

Includes a declarative component. Declarative components allow the UI definition of a component to be defined in terms of a composition of other components and then treated as a single component.

You can pass attributes using JSP tag attributes, or by using <f:attribute>. Facets can also be set as normal using <f:facet> tags. The definition can refer to the attributes of the component by using the "var" EL variable and the component itself using the "componentVar" EL variable that are setup on the <af:componentDef> tag. The definition can reference a facet using the <af:facetRef> tag. Each facet can only be referenced once.

If you put a component as a child of a declarative component but fail to put it inside of a facet and fail to reference that facet in the component definition file (via facetRef), that component will not be rendered.

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 org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           

 

Fields inherited from class oracle.adf.view.rich.component.fragment.UIXInclude
COMPONENT_VAR_KEY, VAR_KEY, VIEW_ID_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
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

 

Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR

 

Constructor Summary
  UIXDeclarativeComponent()
          Construct an instance of the UIXDeclarativeComponent.
protected UIXDeclarativeComponent(java.lang.String rendererType)
          Construct an instance of the UIXDeclarativeComponent.

 

Method Summary
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 java.lang.String getFamily()
           
 void setClientAttributes(java.util.Set clientAttributes)
          Sets a set of client attribute names.

 

Methods inherited from class oracle.adf.view.rich.component.fragment.UIXInclude
broadcast, createFacesBean, getAttribute, getComponentVar, getRenderedFacetsAndChildren, getVar, getViewId, invokeOnComponent, queueEvent, resumeContext, setAttribute, setComponentVar, setupChildrenVisitingContext, setVar, suspendChange, suspendContext, tearDownChildrenVisitingContext

 

Methods inherited from class oracle.adf.view.rich.component.fragment.ContextSwitchingComponent
finishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, 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, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, 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, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownEncodingContext, tearDownVisitingContext, 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 org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

UIXDeclarativeComponent

public UIXDeclarativeComponent()
Construct an instance of the UIXDeclarativeComponent.

UIXDeclarativeComponent

protected UIXDeclarativeComponent(java.lang.String rendererType)
Construct an instance of the UIXDeclarativeComponent.

Method Detail

getClientAttributes

public final java.util.Set getClientAttributes()
Gets a set of client attribute names.
Returns:
the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)
Sets a set of client attribute names.
Parameters:
clientAttributes - the new clientAttributes value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIXInclude

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXInclude

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.1.0)
E17488-02


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.