Skip navigation links

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

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.RichShowDetailItem

All Implemented Interfaces:

javax.faces.component.StateHolder

public class RichShowDetailItem

extends org.apache.myfaces.trinidad.component.UIXShowDetail

<html:p> The showDetailItem component is used inside of a panelAccordion or panelTabbed component to contain a group of children. It is identified visually by the the <html:strong>text</html:strong> attribute value and lays out its children. Note the difference between "disclosed" and "rendered": if "rendered" is false, it means that this the accordion header bar or tab link and its corresponding contents are not available at all to the user, whereas if "disclosed" is false, it means that the contents of the item are not currently visible, but may be made visible by the user since the accordion header bar or tab link are still visible.

The lifecycle (including validation) is not run for any components in a showDetailItem which is not disclosed. The lifecycle is only run on the showDetailItem(s) which is disclosed. </html:p> <section name="Geometry_Management"> <html:ul> <html:li>This component should never have any width or height specified in its inlineStyle because it will always gets its dimensions from its ancestor component.</html:li> <html:li>This component cannot be used by itself, refer to the <af:panelAccordion> and <af:panelTabbed> tag documentation for more details about geometry management.</html:li> </html:ul> </section> <section name="Disclosure_Events"> <html:p> The af:showDetailItem component inside of af:panelAccordion and af:panelTabbed supports queuing of disclosure events so that validation can properly be handled--both on the server and on the client. </html:p> <html:p> If you have an af:panelTabbed or an af:panelAccordion (with discloseMany="false" and discloseNone="false"): </html:p> <html:ul> <html:li>On client: <html:ul> <html:li>showDetailItem 1 is showing but not showDetailItem 2</html:li> <html:li>user clicks to disclose item 2</html:li> <html:li>a client-only disclosure event gets kicked off to set disclosed to false for item 1</html:li> <html:li>if this first event is not canceled, another client disclosure event gets kicked off to set disclosed to true for item 2</html:li> <html:li>if this second event is not canceled, it gets sent to the server</html:li> <html:li>otherwise, no more disclosure changes</html:li> </html:ul></html:li> <html:li>On server: <html:ul> <html:li>the server disclosure event is kicked off to set disclosed to true on item 2</html:li> <html:li>if this first server event is not canceled, another server disclosure event gets kicked off to set disclosed to false for item 1</html:li> <html:li>if neither server event is canceled, the new states get rendered and the user will see the newly disclosed states on the client</html:li> <html:li>otherwise, the client looks the same as it was before</html:li> </html:ul></html:li> </html:ul> <html:p> For af:panelAccordion with discloseMany="false" and discloseNone="true", the process is the same as above only when the disclosure change forces a paired change (when 2 disclosed states are involved). If only one disclosure change is involved, there will just be 1 client and 1 server disclosure event. </html:p> <html:p> For af:panelAccordion with discloseMany="true" (and any discloseNone setting), only one disclosure change is involved; there will just be 1 client and 1 server disclosure event. </html:p> </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	ACCESS_KEY_KEY
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 Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	DISABLED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_INDEX_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FLEX_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ICON_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INFLEXIBLE_HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ITEM_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static java.lang.String	STRETCH_CHILDREN_FIRST
static org.apache.myfaces.trinidad.bean.PropertyKey	STRETCH_CHILDREN_KEY
static java.lang.String	STRETCH_CHILDREN_NONE
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TEXT_KEY
static java.lang.String	TOOLBAR_FACET
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.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

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

Method Summary

void	broadcast(javax.faces.event.FacesEvent event)
char	getAccessKey() Gets a character used to gain quick access to this showDetailItem.
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() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
int	getDisplayIndex() Gets When placed inside of a component that supports reordering, this attribute is used to determine the index that the child should be displayed in.
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()
int	getFlex() Gets
java.lang.String	getIcon() Gets the URI of an image to be displayed with the showDetailItem.
int	getInflexibleHeight() Gets
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
javax.el.MethodExpression	getItemListener() Gets a method reference to an item listener
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.
java.lang.String	getShortDesc() Gets the short description of the component.
java.lang.String	getStretchChildren() Gets The stretching behavior for children.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.String	getText() Gets the textual label of the showDetailItem.
javax.faces.component.UIComponent	getToolbar() The content for the toolbar region of the accordion header bar.
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	isDisabled() Gets a boolean which if the value is "true", the component becomes non-interactive.
boolean	isVisible() Gets the visibility of the component.
void	setAccessKey(char accessKey) Sets a character used to gain quick access to this showDetailItem.
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) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDisabled(boolean disabled) Sets a boolean which if the value is "true", the component becomes non-interactive.
void	setDisplayIndex(int displayIndex) Sets When placed inside of a component that supports reordering, this attribute is used to determine the index that the child should be displayed in.
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	setFlex(int flex) Sets
void	setIcon(java.lang.String icon) Sets the URI of an image to be displayed with the showDetailItem.
void	setInflexibleHeight(int inflexibleHeight) Sets
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setItemListener(javax.el.MethodExpression itemListener) Sets a method reference to an item listener
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	setShortDesc(java.lang.String shortDesc) Sets the short description of the component.
void	setStretchChildren(java.lang.String stretchChildren) Sets The stretching behavior for children.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setText(java.lang.String text) Sets the textual label of the showDetailItem.
void	setToolbar(javax.faces.component.UIComponent toolbarFacet) The content for the toolbar region of the accordion header bar.
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, getDisclosureListener, getDisclosureListeners, isDisclosed, isDisclosedTransient, isImmediate, processDecodes, processUpdates, processValidators, 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, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, 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, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STRETCH_CHILDREN_NONE

public static final java.lang.String STRETCH_CHILDREN_NONE

See Also:

Constant Field Values

STRETCH_CHILDREN_FIRST

public static final java.lang.String STRETCH_CHILDREN_FIRST

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

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

DISABLED_KEY

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

ICON_KEY

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

TEXT_KEY

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

ACCESS_KEY_KEY

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

FLEX_KEY

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

INFLEXIBLE_HEIGHT_KEY

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

STRETCH_CHILDREN_KEY

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

ITEM_LISTENER_KEY

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

DISPLAY_INDEX_KEY

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

TOOLBAR_FACET

public static final java.lang.String TOOLBAR_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

RichShowDetailItem

public RichShowDetailItem()

Construct an instance of the RichShowDetailItem.

RichShowDetailItem

protected RichShowDetailItem(java.lang.String rendererType)

Construct an instance of the RichShowDetailItem.

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.UIXShowDetail

Throws:

javax.faces.event.AbortProcessingException

getToolbar

public final javax.faces.component.UIComponent getToolbar()

The content for the toolbar region of the accordion header bar. It will be displayed when the disclosed="true".

This facet is only applicable when used with the panelAccordion.

setToolbar

public final void setToolbar(javax.faces.component.UIComponent toolbarFacet)

The content for the toolbar region of the accordion header bar. It will be displayed when the disclosed="true".

This facet is only applicable when used with the panelAccordion.

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

getPersist

public final 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. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

Returns:

the new persist value

setPersist

public final 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. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

Parameters:

persist - the new persist value

getDontPersist

public final 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. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

Returns:

the new dontPersist value

setDontPersist

public final 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. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

Parameters:

dontPersist - the new dontPersist value

isDisabled

public final boolean isDisabled()

Gets a boolean which if the value is "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.

Returns:

the new disabled value

setDisabled

public final void setDisabled(boolean disabled)

Sets a boolean which if the value is "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.

Parameters:

disabled - the new disabled value

getIcon

public final java.lang.String getIcon()

Gets the URI of an image to be displayed with the showDetailItem. This attribute supports these various types of URIs:

• absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"
• relative - a path located relatively to the source page, like "bullet.jpg"
• context relative - a path relatively based on the web application's context root, like "/images/error.png"
• server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.

Returns:

the new icon value

setIcon

public final void setIcon(java.lang.String icon)

Sets the URI of an image to be displayed with the showDetailItem. This attribute supports these various types of URIs:

• absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"
• relative - a path located relatively to the source page, like "bullet.jpg"
• context relative - a path relatively based on the web application's context root, like "/images/error.png"
• server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.

Parameters:

icon - the new icon value

getText

public final java.lang.String getText()

Gets the textual label of the showDetailItem.

Returns:

the new text value

setText

public final void setText(java.lang.String text)

Sets the textual label of the showDetailItem.

Parameters:

text - the new text value

getAccessKey

public final char getAccessKey()

Gets a character used to gain quick access to this showDetailItem. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

Returns:

the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)

Sets a character used to gain quick access to this showDetailItem. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

Parameters:

accessKey - the new accessKey value

getFlex

public final int getFlex()

Gets

a non-negative integer that indicates the flexibility of this component in its container. If the container supports it, flex is used to determine how space is distributed among its children. Components with larger flex values will be made larger than components with lower flex values. This is done so at the ratio determined by the flex of each of the two components. The actual value is only relevant if there are other flexible components (components with flex values larger than zero) within the same container.

This attribute is only applicable when used with the panelAccordion.

Returns:

the new flex value

setFlex

public final void setFlex(int flex)

Sets

a non-negative integer that indicates the flexibility of this component in its container. If the container supports it, flex is used to determine how space is distributed among its children. Components with larger flex values will be made larger than components with lower flex values. This is done so at the ratio determined by the flex of each of the two components. The actual value is only relevant if there are other flexible components (components with flex values larger than zero) within the same container.

This attribute is only applicable when used with the panelAccordion.

Parameters:

flex - the new flex value

getInflexibleHeight

public final int getInflexibleHeight()

Gets

the number of pixels that the item will use when in a container that allocates size among multiple sibling items. If this item has flex="0", this is the size that will be used and the remaining space will be dispersed among the non-zero flex items. If this item cannot fit within its container using this number of pixels, other nearby items may be pushed out into overflow menus.

This attribute is only applicable when used with the panelAccordion.

Returns:

the new inflexibleHeight value

setInflexibleHeight

public final void setInflexibleHeight(int inflexibleHeight)

Sets

the number of pixels that the item will use when in a container that allocates size among multiple sibling items. If this item has flex="0", this is the size that will be used and the remaining space will be dispersed among the non-zero flex items. If this item cannot fit within its container using this number of pixels, other nearby items may be pushed out into overflow menus.

This attribute is only applicable when used with the panelAccordion.

Parameters:

inflexibleHeight - the new inflexibleHeight value

getStretchChildren

public final java.lang.String getStretchChildren()

Gets The stretching behavior for children. Acceptable values include:

• "none": does not attempt to stretch any children (the default value and the value you need to use if you have more than a single child; also the value you need to use if the child does not support being stretched)
• "first": stretches the first child (not to be used if you have multiple children as such usage will produce unreliable results; also not to be used if the child does not support being stretched)

Returns:

the new stretchChildren value

setStretchChildren

public final void setStretchChildren(java.lang.String stretchChildren)

Sets The stretching behavior for children. Acceptable values include:

• "none": does not attempt to stretch any children (the default value and the value you need to use if you have more than a single child; also the value you need to use if the child does not support being stretched)
• "first": stretches the first child (not to be used if you have multiple children as such usage will produce unreliable results; also not to be used if the child does not support being stretched)

Parameters:

stretchChildren - the new stretchChildren value

getItemListener

public final javax.el.MethodExpression getItemListener()

Gets a method reference to an item listener

Returns:

the new itemListener value

setItemListener

public final void setItemListener(javax.el.MethodExpression itemListener)

Sets a method reference to an item listener

Parameters:

itemListener - the new itemListener value

getDisplayIndex

public final int getDisplayIndex()

Gets When placed inside of a component that supports reordering, this attribute is used to determine the index that the child should be displayed in. It will be updated when the component is reordered in the parent.

A display index of -1 (default) means that items will appear at the end, in the order they appear in the component tree. All values at 0 or above appear before the -1 values in ascending order.

Returns:

the new displayIndex value

setDisplayIndex

public final void setDisplayIndex(int displayIndex)

Sets When placed inside of a component that supports reordering, this attribute is used to determine the index that the child should be displayed in. It will be updated when the component is reordered in the parent.

A display index of -1 (default) means that items will appear at the end, in the order they appear in the component tree. All values at 0 or above appear before the -1 values in ascending order.

Parameters:

displayIndex - the new displayIndex 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