Apache MyFaces Trinidad - <tr:showDetailItem>

Foundation

Project Documentation

Summary

Tag name: <tr:showDetailItem>
UIComponent class: org.apache.myfaces.trinidad.component.core.layout.CoreShowDetailItem
Component type: org.apache.myfaces.trinidad.CoreShowDetailItem

The showDetailItem component is used inside of a showOne component to contain a group of children. It is identified visually by the the text attribute value and lays out its children. When inside of a parent showOne, "disclosed" and "rendered" mean different things: if "rendered" is false, it means that this item and its contents are not available at all to the user, while if "disclosed" is false, it means that the contents of the item are not currently visible, but may be made visible by the user. It is generally used inside of a showOne component, but may be used on its own, in which case "disclosed" functions equivalently to "rendered", and the "text" attribute is ignored.

Example(s):

Two showDetailItems, the first of which is "disclosed":

<tr:panelTabbed>
  <tr:showDetailItem text="First" disclosed="true"/>
  <tr:showDetailItem text="Second"/>
</tr:panelTabbed>

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.

Supported Facets

Name	Description
toolbar	The content for the toolbar region of the detail item. This facet will not be rendered as part of this component but should, instead, be rendered by containers which support toobars.

Attributes

Name	Type	Supports EL?	Description
accessKey	char	Yes	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".
attributeChangeListener	javax.el.MethodExpression	Only EL	a method reference to an attribute change listener. 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.
binding	org.apache.myfaces.trinidad.component.core.layout.CoreShowDetailItem	Only EL	an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
disabled	boolean	Yes	If value is "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.
disclosed	boolean	Yes	whether or not to disclose the children
disclosedTransient	boolean	Yes	stops the local value of disclosed from being set by renderers. This allows the value to always be taken from the value of the disclosed value expression. Disclosed values must be updated in other ways (i.e. from a disclosure listener)
disclosureListener	javax.el.MethodExpression	Only EL	a method reference to a disclosure listener
flex	int	Yes	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.
id	String	No	the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML: Must not be a zero-length String. First character must be an ASCII letter (A-Za-z) or an underscore ('_'). Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
immediate	boolean	Yes	whether data validation - client-side or server-side - should be skipped when events are generated by this component. When immediate is false (the default), the disclosure event will be delivered during the Invoke Application phase, which will trigger validation. When set to true, the disclosure event will be executed during the Apply Request Values phase.
inlineStyle	String	Yes	the CSS styles to use for this component.
onclick	String	Yes	an onclick Javascript handler.
ondblclick	String	Yes	an ondblclick Javascript handler.
onkeydown	String	Yes	an onkeydown Javascript handler.
onkeypress	String	Yes	an onkeypress Javascript handler.
onkeyup	String	Yes	an onkeyup Javascript handler.
onmousedown	String	Yes	an onmousedown Javascript handler.
onmousemove	String	Yes	an onmousemove Javascript handler.
onmouseout	String	Yes	an onmouseout Javascript handler.
onmouseover	String	Yes	an onmouseover Javascript handler.
onmouseup	String	Yes	an onmouseup Javascript handler.
partialTriggers	String[]	Yes	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. Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2" Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
rendered	boolean	Yes	whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client).
shortDesc	String	Yes	The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClass	String	Yes	a CSS style class to use for this component.
text	String	Yes	the textual label of the showDetailItem.
textAndAccessKey	String	Yes	An attribute that will simultaneously set both the "text" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation. For example, setting this attribute to "T&ext" will set the text to "Text" and the access key to 'e'.