public abstract class PartialRichShowDetail
extends org.apache.myfaces.trinidad.component.UIXShowDetail
implements javax.faces.component.behavior.ClientBehaviorHolder
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="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component.</html:li> <html:li>This component does not have support for stretching its children.</html:li> </html:ul> </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 event might include the width of a column that supported client-side resizing. |
Modifier and Type | Field and Description |
---|---|
static String |
CHILD_CREATION_IMMEDIATE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CHILD_CREATION_KEY |
static String |
CHILD_CREATION_LAZY |
static String |
CHILD_CREATION_LAZY_UNCACHED |
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 String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
CONTENT_DELIVERY_IMMEDIATE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CONTENT_DELIVERY_KEY |
static String |
CONTENT_DELIVERY_LAZY |
static 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 String |
HANDLE_DISCLOSURE_CLIENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HANDLE_DISCLOSURE_KEY
Deprecated.
|
static String |
HANDLE_DISCLOSURE_SERVER |
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 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 |
DISCLOSED_KEY, DISCLOSED_TRANSIENT_KEY, DISCLOSURE_LISTENER_KEY, IMMEDIATE_KEY
Modifier | Constructor and Description |
---|---|
protected |
PartialRichShowDetail(String rendererType)
Construct an instance of the PartialRichShowDetail.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
String |
getChildCreation()
Gets Controls when the children components are created.
|
Set |
getClientAttributes()
Gets a set of client attribute names.
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners()
Gets a set of client listeners.
|
String |
getContentDelivery()
Gets Whether the undisclosed content is delivered with the initial page.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
String |
getDisclosedText()
Gets the text to display when the children are disclosed.
|
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.
|
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getHandleDisclosure()
Deprecated.
This attribute is deprecated. The "contentDelivery" attribute should be used instead. The value of "client" would correspond to a content delivery of "lazy" and a "server" would correspond to a value of "lazyUncached".
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
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.
|
String |
getShortDesc()
Gets the short description of the component.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getUndisclosedText()
Gets the text to display when the children are undisclosed.
|
Set<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 |
setChildCreation(String childCreation)
Sets Controls when the children components are created.
|
void |
setClientAttributes(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(String contentDelivery)
Sets Whether the undisclosed content is delivered with the initial page.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
void |
setDisclosedText(String disclosedText)
Sets the text to display when the children are disclosed.
|
void |
setDontPersist(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 |
setHandleDisclosure(String handleDisclosure)
Deprecated.
This attribute is deprecated. The "contentDelivery" attribute should be used instead. The value of "client" would correspond to a content delivery of "lazy" and a "server" would correspond to a value of "lazyUncached".
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setPersist(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(String shortDesc)
Sets the short description of the component.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setUndisclosedText(String undisclosedText)
Sets the text to display when the children are undisclosed.
|
void |
setUnsecure(Set<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.
|
addDisclosureListener, broadcast, getDisclosureListener, getDisclosureListeners, getRenderedFacetsAndChildren, isDisclosed, isDisclosedTransient, isImmediate, queueEvent, removeDisclosureListener, setDisclosed, setDisclosedTransient, setDisclosureListener, setDisclosureListener, setImmediate
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, 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, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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
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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String HANDLE_DISCLOSURE_CLIENT
public static final String HANDLE_DISCLOSURE_SERVER
public static final String CONTENT_DELIVERY_IMMEDIATE
public static final String CONTENT_DELIVERY_LAZY
public static final String CONTENT_DELIVERY_LAZY_UNCACHED
public static final String CHILD_CREATION_IMMEDIATE
public static final String CHILD_CREATION_LAZY
public static final String CHILD_CREATION_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
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey HANDLE_DISCLOSURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CHILD_CREATION_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 String PROMPT_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
protected PartialRichShowDetail(String rendererType)
public final javax.faces.component.UIComponent getPrompt()
public final void setPrompt(javax.faces.component.UIComponent promptFacet)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
public final void setShortDesc(String shortDesc)
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final String[] getPersist()
public final void setPersist(String[] persist)
persist
- the new persist valuepublic final String[] getDontPersist()
public final void setDontPersist(String[] dontPersist)
dontPersist
- the new dontPersist value@Deprecated public final String getHandleDisclosure()
This attribute is deprecated. The contentDelivery attribute should be used instead.
@Deprecated public final void setHandleDisclosure(String handleDisclosure)
This attribute is deprecated. The contentDelivery attribute should be used instead.
handleDisclosure
- the new handleDisclosure valuepublic final String getContentDelivery()
public final void setContentDelivery(String contentDelivery)
contentDelivery
- the new contentDelivery valuepublic final String getChildCreation()
The non-immediate settings will only work when the children components are created via the UIXComponentELTag and are not in a stamping component (like af:iterator).
Legal values are:public final void setChildCreation(String childCreation)
The non-immediate settings will only work when the children components are created via the UIXComponentELTag and are not in a stamping component (like af:iterator).
Legal values are:childCreation
- the new childCreation valuepublic final String getDisclosedText()
public final void setDisclosedText(String disclosedText)
disclosedText
- the new disclosedText valuepublic final String getUndisclosedText()
public final void setUndisclosedText(String undisclosedText)
undisclosedText
- the new undisclosedText valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public 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