Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-01


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

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

All Implemented Interfaces:
javax.faces.component.StateHolder

public class RichShowDetail
extends org.apache.myfaces.trinidad.component.UIXShowDetail

The showDetail provides a means of toggling a group of components between being disclosed or undisclosed. A showDetail should be used to: <html:ul> <html:li> hide/show an entire section or a part of a section of information within the contents of a page such as: </html:li> <html:ul> <html:i> <html:li>show more information / hide more information</html:li> <html:li>show details / hide details</html:li> <html:li> show "section name" / hide "section name" </html:li> <html:li>show graph/hide graph, etc.</html:li> </html:i> </html:ul> <html:li>hide/show functionality such as:</html:li> <html:ul> <html:i> <html:li>simple/advance search</html:li> </html:i> </html:ul> <html:li>hide/show details of a table row</html:li> </html:ul> <html:p> On mobile devices the showDetail renders nothing itself, but does renders its children. </html:p> <section name="Appearance"> The appearance of the showDetail is dependent upon the disclosed, disclosedText, and undisclosedText properties, as well as the presence of a prompt facet. <html:ul> <html:li> If the "disclosed" property is set to false, the showDetail is considered closed. An open "+" icon will be rendered next to the undisclosedText and the showDetail children will not be shown. </html:li> <html:li> If the "disclosed" property is set to true, the showDetail is considered opened. A close "-" icon will be rendered next to the disclosedText and the showDetail children will be shown. </html:li> </html:ul> If you do not specify a "disclosedText" property for the component, the text "Hide" will be used instead. If you do not specify an "undisclosedText" property for the component, the text "Show" will be used instead. Alternatively, you can specify your own prompt by using the "prompt" facet. </section> <section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component that stretches its children, e.g., panelStretchLayout.</html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section> <section name="Events"> Clicking on the icon of the showDetail will deliver a DisclosureEvent to the server. If a "prompt" facet is used, changing the value of the disclosed attribute on this component will also deliver the event. </section>

Events:

Type Phases Description
org.apache.myfaces.trinidad.event.DisclosureEvent Apply Request Values
Invoke Application
The disclosure event is delivered when a node is disclosed.
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 org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSED_TEXT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
           
static java.lang.String PROMPT_FACET
           
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 UNDISCLOSED_TEXT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
           

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail
DISCLOSED_KEY, DISCLOSED_TRANSIENT_KEY, DISCLOSURE_LISTENER_KEY, IMMEDIATE_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
  RichShowDetail()
          Construct an instance of the RichShowDetail.
protected RichShowDetail(java.lang.String rendererType)
          Construct an instance of the RichShowDetail.

 

Method Summary
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 getCustomizationId()
          Gets The id used to locate this component when applying persistent customizations.
 java.lang.String getDisclosedText()
          Gets the text to display when the children are disclosed.
 java.lang.String[] getDontPersist()
          Gets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
 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[] getPersist()
          Gets a list of persistent attributes that are persisting to a registered "Persistent Change Manager".
 javax.faces.component.UIComponent getPrompt()
          Component rendered next to the hide or show icon.
 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.lang.String getUndisclosedText()
          Gets the text to display when the children are undisclosed.
 boolean isClientComponent()
          Gets whether a client-side component will be generated.
 boolean isVisible()
          Gets the visibility of the component.
 void processDecodes(javax.faces.context.FacesContext context)
           
 void processUpdates(javax.faces.context.FacesContext context)
           
 void processValidators(javax.faces.context.FacesContext context)
           
 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 setCustomizationId(java.lang.String customizationId)
          Sets The id used to locate this component when applying persistent customizations.
 void setDisclosedText(java.lang.String disclosedText)
          Sets the text to display when the children are disclosed.
 void setDontPersist(java.lang.String[] dontPersist)
          Sets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
 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 setPersist(java.lang.String[] persist)
          Sets a list of persistent attributes that are persisting to a registered "Persistent Change Manager".
 void setPrompt(javax.faces.component.UIComponent promptFacet)
          Component rendered next to the hide or show icon.
 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 setUndisclosedText(java.lang.String undisclosedText)
          Sets the text to display when the children are undisclosed.
 void setVisible(boolean visible)
          Sets the visibility of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail
addDisclosureListener, broadcast, getDisclosureListener, getDisclosureListeners, isDisclosed, isDisclosedTransient, isImmediate, queueEvent, removeDisclosureListener, setDisclosed, setDisclosedTransient, setDisclosureListener, setDisclosureListener, setImmediate

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, 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
processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren

 

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

 

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

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

VISIBLE_KEY

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

CUSTOMIZATION_ID_KEY

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

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

DISCLOSED_TEXT_KEY

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

UNDISCLOSED_TEXT_KEY

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

PERSIST_KEY

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

DONT_PERSIST_KEY

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

PROMPT_FACET

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

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

RichShowDetail

public RichShowDetail()
Construct an instance of the RichShowDetail.

RichShowDetail

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

Method Detail

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)
Overrides:
processDecodes in class org.apache.myfaces.trinidad.component.UIXShowDetail

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)
Overrides:
processUpdates in class org.apache.myfaces.trinidad.component.UIXShowDetail

processValidators

public void processValidators(javax.faces.context.FacesContext context)
Overrides:
processValidators in class org.apache.myfaces.trinidad.component.UIXShowDetail

getPrompt

public final javax.faces.component.UIComponent getPrompt()
Component rendered next to the hide or show icon. If this facet is present, this will be used instead of the disclosedText and undisclosedText attributes.

setPrompt

public final void setPrompt(javax.faces.component.UIComponent promptFacet)
Component rendered next to the hide or show icon. If this facet is present, this will be used instead of the disclosedText and undisclosedText attributes.

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.
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.
Parameters:
shortDesc - the new shortDesc 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

public final java.lang.String getCustomizationId()
Gets The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.
Returns:
the new customizationId value

setCustomizationId

public final void setCustomizationId(java.lang.String customizationId)
Sets The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.
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

getDisclosedText

public final java.lang.String getDisclosedText()
Gets the text to display when the children are disclosed. If this attribute is set and the undisclosedText attribute is not set, this text will be displayed for both the disclosed state AND the undisclosed state.
Returns:
the new disclosedText value

setDisclosedText

public final void setDisclosedText(java.lang.String disclosedText)
Sets the text to display when the children are disclosed. If this attribute is set and the undisclosedText attribute is not set, this text will be displayed for both the disclosed state AND the undisclosed state.
Parameters:
disclosedText - the new disclosedText value

getUndisclosedText

public final java.lang.String getUndisclosedText()
Gets the text to display when the children are undisclosed. If this attribute is set and the disclosedText attribute is not set, this text will be displayed for both the disclosed state AND the undisclosed state.
Returns:
the new undisclosedText value

setUndisclosedText

public final void setUndisclosedText(java.lang.String undisclosedText)
Sets the text to display when the children are undisclosed. If this attribute is set and the disclosedText attribute is not set, this text will be displayed for both the disclosed state AND the undisclosed state.
Parameters:
undisclosedText - the new undisclosedText value

getPersist

public final java.lang.String[] getPersist()
Gets a list of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.
Returns:
the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)
Sets a list of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.
Parameters:
persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()
Gets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.
Returns:
the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)
Sets a list of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.
Parameters:
dontPersist - the new dontPersist value

getFamily

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

getBeanType

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

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-01


Copyright © 1998, 2008, Oracle. All rights reserved.