org.apache.myfaces.trinidad.component

## Class UIXShowDetail

- 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

- All Implemented Interfaces:
    javax.faces.component.StateHolder
  Direct Known Subclasses:
    CoreShowDetail, CoreShowDetailHeader, CoreShowDetailItem

      public class UIXShowDetail
      extends UIXComponentBase

  #### 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

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `COMPONENT_FAMILY`
    `static String` | `COMPONENT_TYPE`
    `static PropertyKey` | `DISCLOSED_KEY`
    `static PropertyKey` | `DISCLOSED_TRANSIENT_KEY`
    `static PropertyKey` | `DISCLOSURE_LISTENER_KEY`
    `static PropertyKey` | `IMMEDIATE_KEY`
    `static FacesBean.Type` | `TYPE`

    - ### 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

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `` | `UIXShowDetail()` Construct an instance of the UIXShowDetail.
    `protected` | `UIXShowDetail(String rendererType)` Construct an instance of the UIXShowDetail.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addDisclosureListener(DisclosureListener listener)` Adds a disclosure listener.
    `void` | `broadcast(javax.faces.event.FacesEvent event)`
    `protected FacesBean.Type` | `getBeanType()`
    `javax.el.MethodExpression` | `getDisclosureListener()` Gets a method reference to a disclosure listener
    `DisclosureListener[]` | `getDisclosureListeners()` Returns an array of attached disclosure listeners.
    `String` | `getFamily()`
    `boolean` | `isDisclosed()` Gets whether or not to disclose the children
    `boolean` | `isDisclosedTransient()` Gets stops the local value of disclosed from being set by renderers.
    `boolean` | `isImmediate()` Gets whether data validation - client-side or server-side - should be skipped when events are generated by this component.
    `void` | `processDecodes(javax.faces.context.FacesContext context)`
    `void` | `processUpdates(javax.faces.context.FacesContext context)`
    `void` | `processValidators(javax.faces.context.FacesContext context)`
    `void` | `queueEvent(javax.faces.event.FacesEvent e)`
    `void` | `removeDisclosureListener(DisclosureListener listener)` Removes a disclosure listener.
    `void` | `setDisclosed(boolean disclosed)` Sets whether or not to disclose the children
    `void` | `setDisclosedTransient(boolean disclosedTransient)` Sets stops the local value of disclosed from being set by renderers.
    `void` | `setDisclosureListener(javax.faces.el.MethodBinding binding)` Deprecated.
    `void` | `setDisclosureListener(javax.el.MethodExpression disclosureListener)` Sets a method reference to a disclosure listener
    `void` | `setImmediate(boolean immediate)` Sets whether data validation - client-side or server-side - should be skipped when events are generated by this component.
    `protected boolean` | `visitChildren(VisitContext visitContext, VisitCallback callback)` Hook for subclasses to override the manner in which the component's children are visited.

    - ### Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

      `adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, 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, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenVisitingContext, 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

    - #### TYPE

          public static final FacesBean.Type TYPE

    - #### DISCLOSED_KEY

          public static final PropertyKey DISCLOSED_KEY

    - #### DISCLOSED_TRANSIENT_KEY

          public static final PropertyKey DISCLOSED_TRANSIENT_KEY

    - #### IMMEDIATE_KEY

          public static final PropertyKey IMMEDIATE_KEY

    - #### DISCLOSURE_LISTENER_KEY

          public static final PropertyKey DISCLOSURE_LISTENER_KEY

    - #### COMPONENT_FAMILY

          public static final String COMPONENT_FAMILY

      See Also:
        Constant Field Values

    - #### COMPONENT_TYPE

          public static final String COMPONENT_TYPE

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### UIXShowDetail

          public UIXShowDetail()

      Construct an instance of the UIXShowDetail.

    - #### UIXShowDetail

          protected UIXShowDetail(String rendererType)

      Construct an instance of the UIXShowDetail.

  - ### Method Detail

    - #### setDisclosureListener

          @Deprecated
          public void setDisclosureListener(javax.faces.el.MethodBinding binding)

      Deprecated.

    - #### processDecodes

          public void processDecodes(javax.faces.context.FacesContext context)

      Overrides:
        `processDecodes` in class `UIXComponentBase`

    - #### processValidators

          public void processValidators(javax.faces.context.FacesContext context)

      Overrides:
        `processValidators` in class `UIXComponentBase`

    - #### processUpdates

          public void processUpdates(javax.faces.context.FacesContext context)

      Overrides:
        `processUpdates` in class `UIXComponentBase`

    - #### broadcast

          public void broadcast(javax.faces.event.FacesEvent event)
                         throws javax.faces.event.AbortProcessingException

      Overrides:
        `broadcast` in class `UIXComponentBase`
      Throws:
        `javax.faces.event.AbortProcessingException`

    - #### queueEvent

          public void queueEvent(javax.faces.event.FacesEvent e)

      Overrides:
        `queueEvent` in class `UIXComponentBase`

    - #### visitChildren

          protected boolean visitChildren(VisitContext visitContext,
                              VisitCallback callback)

      Description copied from class: `UIXComponent`
      Hook for subclasses to override the manner in which the component's children are visited. The default implementation visits all of the children and facets of the Component. `setupChildrenVisitingContext` will have been called before this method is invoked and `tearDownChildrenVisitingContext` will be called after. respectively. If the purpose of this visit was to encode the component and the component uses a CoreRenderer, the CoreRenderer's `setupChildrenEncodingContext` and `tearDownChildrenEncodingContext` will be called before and after this method is invoked, respectively.
      Overrides:
        `visitChildren` in class `UIXComponent`
      Parameters:
        `visitContext` - the `VisitContext` for this visit
        `callback` - the `VisitCallback` instance
      Returns:
        `true` if the visit is complete.
      See Also:
        `UIXComponent.setupChildrenVisitingContext(javax.faces.context.FacesContext)`, `UIXComponent.tearDownChildrenVisitingContext(javax.faces.context.FacesContext)`, `CoreRenderer.setupChildrenEncodingContext(javax.faces.context.FacesContext, org.apache.myfaces.trinidad.context.RenderingContext, javax.faces.component.UIComponent)`, `CoreRenderer.tearDownChildrenEncodingContext(javax.faces.context.FacesContext, org.apache.myfaces.trinidad.context.RenderingContext, javax.faces.component.UIComponent)`

    - #### isDisclosed

          public final boolean isDisclosed()

      Gets whether or not to disclose the children
      Returns:
        the new disclosed value

    - #### setDisclosed

          public final void setDisclosed(boolean disclosed)

      Sets whether or not to disclose the children
      Parameters:
        `disclosed` - the new disclosed value

    - #### isDisclosedTransient

          public final boolean isDisclosedTransient()

      Gets 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)
      Returns:
        the new disclosedTransient value

    - #### setDisclosedTransient

          public final void setDisclosedTransient(boolean disclosedTransient)

      Sets 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)
      Parameters:
        `disclosedTransient` - the new disclosedTransient value

    - #### isImmediate

          public final boolean isImmediate()

      Gets 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.
      Returns:
        the new immediate value

    - #### setImmediate

          public final void setImmediate(boolean immediate)

      Sets 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.
      Parameters:
        `immediate` - the new immediate value

    - #### getDisclosureListener

          public final javax.el.MethodExpression getDisclosureListener()

      Gets a method reference to a disclosure listener
      Returns:
        the new disclosureListener value

    - #### setDisclosureListener

          public final void setDisclosureListener(javax.el.MethodExpression disclosureListener)

      Sets a method reference to a disclosure listener
      Parameters:
        `disclosureListener` - the new disclosureListener value

    - #### addDisclosureListener

          public final void addDisclosureListener(DisclosureListener listener)

      Adds a disclosure listener.
      Parameters:
        `listener` - the disclosure listener to add

    - #### removeDisclosureListener

          public final void removeDisclosureListener(DisclosureListener listener)

      Removes a disclosure listener.
      Parameters:
        `listener` - the disclosure listener to remove

    - #### getDisclosureListeners

          public final DisclosureListener[] getDisclosureListeners()

      Returns an array of attached disclosure listeners.
      Returns:
        an array of attached disclosure listeners.

    - #### getFamily

          public String getFamily()

      Specified by:
        `getFamily` in class `UIXComponentBase`

    - #### getBeanType

          protected FacesBean.Type getBeanType()

      Overrides:
        `getBeanType` in class `UIXComponentBase`

Copyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.