Parent Project
Project Documentation

Summary

Tag name: <tr:showDetail>
UIComponent class: org.apache.myfaces.trinidad.component.core.layout.CoreShowDetail
Component type: org.apache.myfaces.trinidad.CoreShowDetail
The showDetail provides a means of toggling a group of components between being disclosed or undisclosed. A showDetail should be used to:

  • hide/show an entire section or a part of a section of information within the contents of a page such as:
    • show more information / hide more information
    • show details / hide details
    • show "section name" / hide "section name"
    • show graph/hide graph, etc.
  • hide/show functionality such as:
    • simple/advance search
  • hide/show details of a table row

On mobile devices the showDetail renders nothing itself, but does renders its children.

Appearance

If the "disclosed" property on the showDetail is set to false, the an icon indicating that the item is not disclosed will be rendered and the "prompt" facet will be rendered next to the icon. In this case the children of showDetail will not be rendered. If the "disclosed" property is set to false, the icon indicating that the item IS disclosed will be rendered and the and the "prompt" facet will be rendered next to the icon. In this case, the children of showDetail WILL be rendered.

If the "prompt" facet is not present, but either the disclosedText or undisclosedText attributes are present (not both), the text in the attribute will appear next to the disclosure icon for both states.

If the "prompt" facet is not present and both the disclosedText and or undisclosedText attributes are present , the text in the disclosedText attribute will appear when disclosed="true" and the text in the undisclosedText attribute will appear when disclosed="false".

Finally, if the "prompt" facet is not present and neither the disclosedText or undisclosedText attributes are present, then the word "hide" will appear next to the disclosure icon when disclosed="true" and the word "show" will appear next to the disclosure icon when disclosed="false". In this case both the "hide" and "show" labels will be links and mnd may be clicked in order to toggle the disclosure.

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.

Code Example(s)

An interactive showDetail

<tr:showDetail id="showDetail1">
  <tr:panelHeader text="Header" />
</tr:showDetail>

Supported Client Events for Client Behaviors

  • click (default)
  • dblclick
  • keydown
  • keypress
  • keyup
  • mousedown
  • mousemove
  • mouseout
  • mouseover
  • mouseup

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 event might include the width of a column that supported client-side resizing.

Supported Facets

Name Description
prompt 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.

Attributes

Name Type Supports EL? Description
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.CoreShowDetail 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.
disclosed boolean Yes Default Value: false

whether or not to disclose the children
disclosedText String Yes 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.
disclosedTransient boolean Yes Default Value: false

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
id String No the identifier for the component. Every component may be named by a component identifier that must conform to the following rules:
  • They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ).
  • Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
immediate boolean Yes Default Value: false

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 Default Value: true

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). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
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.
undisclosedText String Yes 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.