|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXShowDetail
oracle.adf.view.rich.component.rich.layout.RichShowDetail
public class RichShowDetail
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="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> <section name="Unsupported_Attributes"> <html:p> The disclosedTransient
attribute is not supported by the rich client renderers and may only be used with the Apache MyFaces Trinidad RenderKit. If this attribute is set to true in an ADF page, the component will not function correctly. This attribute appears in ADF due to it being inherited from UIXShowDetail
. The value must either not be set, or must be set to false, a value of true will cause problems. </html:p> </section> <section name="Attachment_Mode"> In Attachment Mode, contentDelivery will be forced to contentDelivery="immediate" </section>
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 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 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 |
UNSECURE_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 |
getContentDelivery() Gets whether the undisclosed content is delivered with the initial page. |
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 |
getDisclosedText() Gets the text to display when the children are disclosed. |
java.lang.String[] |
getDontPersist() Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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 attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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. |
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 |
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 |
setContentDelivery(java.lang.String contentDelivery) Sets whether the undisclosed content is delivered with the initial page. |
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 |
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 attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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 attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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 |
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.UIXShowDetail |
---|
addDisclosureListener, broadcast, getDisclosureListener, getDisclosureListeners, getRenderedFacetsAndChildren, isDisclosed, isDisclosedTransient, isImmediate, queueEvent, removeDisclosureListener, setDisclosed, setDisclosedTransient, setDisclosureListener, setDisclosureListener, setImmediate |
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, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, 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 |
---|
public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE
public static final java.lang.String CONTENT_DELIVERY_LAZY_UNCACHED
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISCLOSED_TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNDISCLOSED_TEXT_KEY
public static final java.lang.String PROMPT_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichShowDetail()
protected RichShowDetail(java.lang.String rendererType)
Method Detail |
---|
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public final javax.faces.component.UIComponent getPrompt()
public final void setPrompt(javax.faces.component.UIComponent promptFacet)
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final java.lang.String[] getPersist()
public final void setPersist(java.lang.String[] persist)
persist
- the new persist valuepublic final java.lang.String[] getDontPersist()
public final void setDontPersist(java.lang.String[] dontPersist)
dontPersist
- the new dontPersist valuepublic final java.lang.String getContentDelivery()
public final void setContentDelivery(java.lang.String contentDelivery)
contentDelivery
- the new contentDelivery valuepublic final java.lang.String getDisclosedText()
public final void setDisclosedText(java.lang.String disclosedText)
disclosedText
- the new disclosedText valuepublic final java.lang.String getUndisclosedText()
public final void setUndisclosedText(java.lang.String undisclosedText)
undisclosedText
- the new undisclosedText valuepublic java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXShowDetail
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXShowDetail
|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |