org.apache.myfaces.trinidad.component
Class UIXShowDetail

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by 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 Invoke Application The disclosure event is delivered when a node is disclosed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent 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 java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static PropertyKey DISCLOSED_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
  UIXShowDetail()
          Construct an instance of the UIXShowDetail.
protected UIXShowDetail(java.lang.String rendererType)
          Construct an instance of the UIXShowDetail.
 
Method Summary
 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.
 java.lang.String getFamily()
           
 boolean isDisclosed()
          Gets whether or not to disclose the children
 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 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.
 
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, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class javax.faces.component.UIComponent
getContainerClientId, invokeOnComponent
 
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

IMMEDIATE_KEY

public static final PropertyKey IMMEDIATE_KEY

DISCLOSURE_LISTENER_KEY

public static final PropertyKey DISCLOSURE_LISTENER_KEY

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

UIXShowDetail

public UIXShowDetail()
Construct an instance of the UIXShowDetail.


UIXShowDetail

protected UIXShowDetail(java.lang.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

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

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 java.lang.String getFamily()
Specified by:
getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXComponentBase


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.