Skip navigation links

Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E10684-08


oracle.adf.view.rich.component.rich.layout
Class RichPanelAccordion

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.UIXPanel
                  extended by oracle.adf.view.rich.component.rich.layout.RichPanelAccordion

All Implemented Interfaces:
javax.faces.component.StateHolder

public class RichPanelAccordion
extends org.apache.myfaces.trinidad.component.UIXPanel

The panelAccordion control can be used to display a set of contents belonging to showDetailItem components. Each disclosed showDetailItem is shown as expanded and its contents are displayed; if the showDetailItem is not disclosed, only the title bar is displayed. Typically you would put one or more showDetailItem components inside of the panelAccordion but you may also alternatively place a facetRef, group, iterator, or switcher inside of the panelAccordion as long as these wrappers provide showDetailItem components as a result of their execution. <section name="Disabled_showDetailItem_Children"> A disabled showDetailItem child does not display any mechanisms to have its disclosed state changed. However, it can be still be changed programmatically as well as if required to do so when the disclosed state of a sibling showDetailItem changes (depending upon the rules specified in the panelAccordion's discloseMany and discloseNone attributes). </section> <section name="Item_Flexibility"> <html:ul> <html:li>If a showDetailItem has a non-zero flex attribute value assigned to it and if it has only one child, that child will be stretched (regardless of discloseMany setting)</html:li> <html:li>The contents of a showDetailItem in a panelAccordion will not be stretched if the flex attribute for that showDetailItem is set to zero</html:li> <html:li>If every disclosed showDetailItem has a flex attribute value of zero, the last item (the one furthest down) will be stretched as if it had a flex value of 1 (however, if there is more than one child in that showDetailItem, the children will not be stretched)</html:li> </html:ul> </section> <section name="Printable_Pages"> If you use an <af:showPrintablePageBehavior> within one of the panes of the accordion, only that pane will be present for printing when the user activates that behavior. </section> <section name="Attachment_Mode"> contentDelivery will be automatically forced to "immediate". You must set discloseMany="true" for content to be loaded for all items in the accordion. </section> <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout if the dimensionsFrom attribute of this panelAccordion is set to "parent".</html:li> <html:li>This component uses <af:showDetailItem> to organize content into each accordion panel. The <af:showDetailItem> will allow stretching if: <html:ul> <html:li>The panelAccordion has dimensionsFrom="parent"</html:li> <html:li>It contains a single child</html:li> <html:li>It has stretchChildren="first" specified</html:li> <html:li>The child has no width, height, margin, border, and padding</html:li> <html:li>The child must be capable of being stretched</html:li> </html:ul> Examples of components that can be stretched inside of a <af:showDetailItem> include: <html:ul> <html:li><af:decorativeBox></html:li> <html:li><af:panelAccordion></html:li> <html:li><af:panelBox></html:li> <html:li><af:panelCollection></html:li> <html:li><af:panelGroupLayout layout="scroll"></html:li> <html:li><af:panelGroupLayout layout="vertical"></html:li> <html:li><af:panelHeader></html:li> <html:li><af:panelSplitter></html:li> <html:li><af:panelStretchLayout></html:li> <html:li><af:panelTabbed></html:li> <html:li><af:region></html:li> <html:li><af:table></html:li> <html:li><af:tree></html:li> <html:li><af:treeTable></html:li> </html:ul> If you try to put a component inside of this component and that child component does not support being stretched, then the component hierarchy is illegal. To make it legal, you need to insert another intermediate component between this component and the child component. This intermediate component must support being stretched and must not stretch its children. An example of such a component that is commonly used for this purpose is <af:panelGroupLayout layout="scroll">. By using a wrapper like this, you create a flowing layout area where nothing will be stretched inside of it. Examples of components that do not support being stretched inside of these panelStretchLayout facets (and therefore need to be wrapped) include: <html:ul> <html:li><af:panelBorderLayout></html:li> <html:li><af:panelFormLayout></html:li> <html:li><af:panelGroupLayout layout="default"></html:li> <html:li><af:panelGroupLayout layout="horizontal"></html:li> <html:li><af:panelLabelAndMessage></html:li> <html:li><af:panelList></html:li> <html:li><trh:tableLayout></html:li> </html:ul> </html:li> </html:ul> There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor: <html:ul> <html:li>You can specify dimensionsFrom="children" for the panelAccordion to be as tall as the currently-disclosed af:showDetailItem children. When using this "children" setting, the stretchChildren, flex, and inflexibleHeight attributes on af:showDetailItem and any height assignment (e.g. inlineStyle or styleClass) on the panelAccordion must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>You can also specify dimensionsFrom="parent" to make the panelAccordion get its dimensions from the inlineStyle and if not provided from there then from its parent component or if not provided from the parent then from the skin (stretchChildren, flex, inflexibleHeight on af:showDetailItem will be honored).</html:li> <html:li>Using dimensionsFrom="auto" will choose either "children" or "parent" depending on whether the panelAccordion is being stretched by its parent.</html:li> </html:ul> </section>

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 events 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 org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String CONTENT_DELIVERY_IMMEDIATE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
           
static java.lang.String CONTENT_DELIVERY_LAZY_UNCACHED
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
          Deprecated. 
static java.lang.String DIMENSIONS_FROM_AUTO
           
static java.lang.String DIMENSIONS_FROM_CHILDREN
           
static org.apache.myfaces.trinidad.bean.PropertyKey DIMENSIONS_FROM_KEY
           
static java.lang.String DIMENSIONS_FROM_PARENT
           
static org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSE_MANY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSE_NONE_KEY
           
static java.lang.String DISCLOSURE_EVENT_BROADCAST
          When a disclosure event is queued in an accordion, the accordion will track to see if that event has been broadcast.
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static java.lang.String REORDER_DISABLE
           
static java.lang.String REORDER_ENABLE
           
static org.apache.myfaces.trinidad.bean.PropertyKey REORDER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey 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
bindings

 

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

 

Method Summary
 void broadcast(javax.faces.event.FacesEvent event)
          
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 java.lang.String getContentDelivery()
          Gets This property is not currently supported for general use, and is intended to remain in its default lazyUncached state.
 java.lang.String getCustomizationId()
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 java.lang.String getDimensionsFrom()
          Gets
 java.lang.String getFamily()
           
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 java.lang.String getReorder()
          Gets Sets if reordering of the panel accordion's items should be allowed.
 java.lang.String getShortDesc()
          Gets the short description of the component.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 java.util.Set<java.lang.String> getUnsecure()
          Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 boolean isClientComponent()
          Gets whether a client-side component will be generated.
 boolean isDiscloseMany()
          Gets whether more than one detail item may be disclosed at a time.
 boolean isDiscloseNone()
          Gets whether a minimum of one detail item must be disclosed at a time.
 boolean isVisible()
          Gets the visibility of the component.
 java.lang.Object processSaveState(javax.faces.context.FacesContext context)
           
 void queueEvent(javax.faces.event.FacesEvent event)
          
 void setClientAttributes(java.util.Set clientAttributes)
          Sets a set of client attribute names.
 void setClientComponent(boolean clientComponent)
          Sets whether a client-side component will be generated.
 void setClientListeners(ClientListenerSet clientListeners)
          Sets a set of client listeners.
 void setContentDelivery(java.lang.String contentDelivery)
          Sets This property is not currently supported for general use, and is intended to remain in its default lazyUncached state.
 void setCustomizationId(java.lang.String customizationId)
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 void setDimensionsFrom(java.lang.String dimensionsFrom)
          Sets
 void setDiscloseMany(boolean discloseMany)
          Sets whether more than one detail item may be disclosed at a time.
 void setDiscloseNone(boolean discloseNone)
          Sets whether a minimum of one detail item must be disclosed at a time.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setReorder(java.lang.String reorder)
          Sets Sets if reordering of the panel accordion's items should be allowed.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the component.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setUnsecure(java.util.Set<java.lang.String> unsecure)
          Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 void setVisible(boolean visible)
          Sets the visibility of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, 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, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

 

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

DIMENSIONS_FROM_AUTO

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

DIMENSIONS_FROM_CHILDREN

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

DIMENSIONS_FROM_PARENT

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

CONTENT_DELIVERY_IMMEDIATE

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

CONTENT_DELIVERY_LAZY_UNCACHED

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

REORDER_ENABLE

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

REORDER_DISABLE

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

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

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

STYLE_CLASS_KEY

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

SHORT_DESC_KEY

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

UNSECURE_KEY

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

VISIBLE_KEY

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

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
Deprecated. 

CLIENT_COMPONENT_KEY

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

CLIENT_ATTRIBUTES_KEY

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

PARTIAL_TRIGGERS_KEY

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

CLIENT_LISTENERS_KEY

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

DIMENSIONS_FROM_KEY

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

CONTENT_DELIVERY_KEY

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

DISCLOSE_NONE_KEY

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

DISCLOSE_MANY_KEY

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

REORDER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey REORDER_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

DISCLOSURE_EVENT_BROADCAST

public static final java.lang.String DISCLOSURE_EVENT_BROADCAST
When a disclosure event is queued in an accordion, the accordion will track to see if that event has been broadcast. A renderer can query for a boolean attribute of this name to see if the event was broadcast. A null property will be returned if the event was not queued, true if it was queued and broadcast and false if it was queued and not broadcast.
See Also:
Constant Field Values

Constructor Detail

RichPanelAccordion

public RichPanelAccordion()
Construct an instance of the RichPanelAccordion.

RichPanelAccordion

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

Method Detail

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Overrides:
broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase
Throws:
javax.faces.event.AbortProcessingException

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)
Overrides:
queueEvent in class org.apache.myfaces.trinidad.component.UIXComponentBase

processSaveState

public java.lang.Object processSaveState(javax.faces.context.FacesContext context)
Overrides:
processSaveState in class org.apache.myfaces.trinidad.component.UIXComponentBase

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Parameters:
styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Parameters:
shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.
Returns:
the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.
Parameters:
unsecure - the new unsecure value

isVisible

public final boolean isVisible()
Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Returns:
the new visible value

setVisible

public final void setVisible(boolean visible)
Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Parameters:
visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Returns:
the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Parameters:
customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()
Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Returns:
the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Parameters:
clientComponent - the new clientComponent value

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

getPartialTriggers

public final java.lang.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. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.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. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Parameters:
partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()
Gets a set of client listeners.
Returns:
the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
Parameters:
clientListeners - the new clientListeners value

getDimensionsFrom

public final java.lang.String getDimensionsFrom()
Gets

determines how the component will handle geometry management. This specifies where the dimensions of the decorativeBox come from:

<html:ul> <html:li>auto - either "children" or "parent", depending on the container the decorativeBox is inside; if the decorativeBox is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the decorativeBox will get its dimensions from the children (topHeight will still be honored so the contents of this facet will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>parent - the decorativeBox will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin</html:li> </html:ul>

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".

Returns:
the new dimensionsFrom value

setDimensionsFrom

public final void setDimensionsFrom(java.lang.String dimensionsFrom)
Sets

determines how the component will handle geometry management. This specifies where the dimensions of the decorativeBox come from:

<html:ul> <html:li>auto - either "children" or "parent", depending on the container the decorativeBox is inside; if the decorativeBox is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the decorativeBox will get its dimensions from the children (topHeight will still be honored so the contents of this facet will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the decorativeBox must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>parent - the decorativeBox will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin</html:li> </html:ul>

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".

Parameters:
dimensionsFrom - the new dimensionsFrom value

getContentDelivery

public final java.lang.String getContentDelivery()
Gets This property is not currently supported for general use, and is intended to remain in its default lazyUncached state. It is currently only used when the page is rendered in attachment mode, and the contentDelivery is forced to an immediate setting.

Determines whether content is delivered with the initial page. When contentDelivery is "immediate", the accordion item content is inlined into the initial page. By default, contentDelivery is lazyUncached.

Returns:
the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String contentDelivery)
Sets This property is not currently supported for general use, and is intended to remain in its default lazyUncached state. It is currently only used when the page is rendered in attachment mode, and the contentDelivery is forced to an immediate setting.

Determines whether content is delivered with the initial page. When contentDelivery is "immediate", the accordion item content is inlined into the initial page. By default, contentDelivery is lazyUncached.

Parameters:
contentDelivery - the new contentDelivery value

isDiscloseNone

public final boolean isDiscloseNone()
Gets whether a minimum of one detail item must be disclosed at a time. Use "false" (the default) to keep a minimum of one detail item disclosed at all times. Use "true" to make it possible for zero detail items to be disclosed.
Returns:
the new discloseNone value

setDiscloseNone

public final void setDiscloseNone(boolean discloseNone)
Sets whether a minimum of one detail item must be disclosed at a time. Use "false" (the default) to keep a minimum of one detail item disclosed at all times. Use "true" to make it possible for zero detail items to be disclosed.
Parameters:
discloseNone - the new discloseNone value

isDiscloseMany

public final boolean isDiscloseMany()
Gets whether more than one detail item may be disclosed at a time. Use "false" (the default) to keep a maximum of one detail item disclosed at all times. Use "true" to make it possible for multiple detail items to be disclosed.
Returns:
the new discloseMany value

setDiscloseMany

public final void setDiscloseMany(boolean discloseMany)
Sets whether more than one detail item may be disclosed at a time. Use "false" (the default) to keep a maximum of one detail item disclosed at all times. Use "true" to make it possible for multiple detail items to be disclosed.
Parameters:
discloseMany - the new discloseMany value

getReorder

public final java.lang.String getReorder()
Gets Sets if reordering of the panel accordion's items should be allowed.

After a reorder, an event is sent to the server. If all the children components of the panel accordion are <c>RichShowDetailItem</c> components, the display indexes will be updated to reflect the new order. The accordion will update as many items as needed to ensure they appear in the proper order. This means that if there are five items all with the default index of -1, and the first is moved to position 3, the items now first, second and third (where the third is the old first) will have their display indexes updated to 0, 1 and 2 respectively.

The updating of display indexes in flattened components is not supported at this time.

Returns:
the new reorder value

setReorder

public final void setReorder(java.lang.String reorder)
Sets Sets if reordering of the panel accordion's items should be allowed.

After a reorder, an event is sent to the server. If all the children components of the panel accordion are <c>RichShowDetailItem</c> components, the display indexes will be updated to reflect the new order. The accordion will update as many items as needed to ensure they appear in the proper order. This means that if there are five items all with the default index of -1, and the first is moved to position 3, the items now first, second and third (where the third is the old first) will have their display indexes updated to 0, 1 and 2 respectively.

The updating of display indexes in flattened components is not supported at this time.

Parameters:
reorder - the new reorder value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXPanel

getBeanType

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

Skip navigation links

Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E10684-08


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