org.apache.myfaces.trinidad.component.core.layout
Class CoreShowDetail

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
                  extended by org.apache.myfaces.trinidad.component.core.layout.CoreShowDetail
All Implemented Interfaces:
javax.faces.component.StateHolder

public class CoreShowDetail
extends UIXShowDetail

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.

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

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_TEXT_KEY
           
static PropertyKey INLINE_STYLE_KEY
           
static PropertyKey ONCLICK_KEY
           
static PropertyKey ONDBLCLICK_KEY
           
static PropertyKey ONKEYDOWN_KEY
           
static PropertyKey ONKEYPRESS_KEY
           
static PropertyKey ONKEYUP_KEY
           
static PropertyKey ONMOUSEDOWN_KEY
           
static PropertyKey ONMOUSEMOVE_KEY
           
static PropertyKey ONMOUSEOUT_KEY
           
static PropertyKey ONMOUSEOVER_KEY
           
static PropertyKey ONMOUSEUP_KEY
           
static PropertyKey PARTIAL_TRIGGERS_KEY
           
static java.lang.String PROMPT_FACET
           
static PropertyKey SHORT_DESC_KEY
           
static PropertyKey STYLE_CLASS_KEY
           
static FacesBean.Type TYPE
           
static PropertyKey UNDISCLOSED_TEXT_KEY
           
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail
DISCLOSED_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
  CoreShowDetail()
          Construct an instance of the CoreShowDetail.
protected CoreShowDetail(java.lang.String rendererType)
          Construct an instance of the CoreShowDetail.
 
Method Summary
protected  FacesBean.Type getBeanType()
           
 java.lang.String getDisclosedText()
          Gets the text to display when the children are disclosed.
 java.lang.String getFamily()
           
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 java.lang.String getOnclick()
          Gets an onclick Javascript handler.
 java.lang.String getOndblclick()
          Gets an ondblclick Javascript handler.
 java.lang.String getOnkeydown()
          Gets an onkeydown Javascript handler.
 java.lang.String getOnkeypress()
          Gets an onkeypress Javascript handler.
 java.lang.String getOnkeyup()
          Gets an onkeyup Javascript handler.
 java.lang.String getOnmousedown()
          Gets an onmousedown Javascript handler.
 java.lang.String getOnmousemove()
          Gets an onmousemove Javascript handler.
 java.lang.String getOnmouseout()
          Gets an onmouseout Javascript handler.
 java.lang.String getOnmouseover()
          Gets an onmouseover Javascript handler.
 java.lang.String getOnmouseup()
          Gets an onmouseup Javascript handler.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 javax.faces.component.UIComponent getPrompt()
          Component rendered next to the hide or show icon.
 java.lang.String getShortDesc()
          Gets The short description of the component.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 java.lang.String getUndisclosedText()
          Gets the text to display when the children are undisclosed.
 void setDisclosedText(java.lang.String disclosedText)
          Sets the text to display when the children are disclosed.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setOnclick(java.lang.String onclick)
          Sets an onclick Javascript handler.
 void setOndblclick(java.lang.String ondblclick)
          Sets an ondblclick Javascript handler.
 void setOnkeydown(java.lang.String onkeydown)
          Sets an onkeydown Javascript handler.
 void setOnkeypress(java.lang.String onkeypress)
          Sets an onkeypress Javascript handler.
 void setOnkeyup(java.lang.String onkeyup)
          Sets an onkeyup Javascript handler.
 void setOnmousedown(java.lang.String onmousedown)
          Sets an onmousedown Javascript handler.
 void setOnmousemove(java.lang.String onmousemove)
          Sets an onmousemove Javascript handler.
 void setOnmouseout(java.lang.String onmouseout)
          Sets an onmouseout Javascript handler.
 void setOnmouseover(java.lang.String onmouseover)
          Sets an onmouseover Javascript handler.
 void setOnmouseup(java.lang.String onmouseup)
          Sets an onmouseup Javascript handler.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setPrompt(javax.faces.component.UIComponent promptFacet)
          Component rendered next to the hide or show icon.
 void setShortDesc(java.lang.String shortDesc)
          Sets The short description of the component.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setUndisclosedText(java.lang.String undisclosedText)
          Sets the text to display when the children are undisclosed.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail
addDisclosureListener, broadcast, getDisclosureListener, getDisclosureListeners, isDisclosed, isImmediate, processDecodes, processUpdates, processValidators, queueEvent, removeDisclosureListener, setDisclosed, 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, 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

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

DISCLOSED_TEXT_KEY

public static final PropertyKey DISCLOSED_TEXT_KEY

UNDISCLOSED_TEXT_KEY

public static final PropertyKey UNDISCLOSED_TEXT_KEY

PROMPT_FACET

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

CoreShowDetail

public CoreShowDetail()
Construct an instance of the CoreShowDetail.


CoreShowDetail

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

Method Detail

getPrompt

public final javax.faces.component.UIComponent getPrompt()
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.


setPrompt

public final void setPrompt(javax.faces.component.UIComponent promptFacet)
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.


getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component.

Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component.

Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component.

Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component.

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.

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.

Parameters:
shortDesc - the new shortDesc 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, 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, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, 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, 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, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.

Parameters:
partialTriggers - the new partialTriggers value

getOnclick

public final java.lang.String getOnclick()
Gets an onclick Javascript handler.

Returns:
the new onclick value

setOnclick

public final void setOnclick(java.lang.String onclick)
Sets an onclick Javascript handler.

Parameters:
onclick - the new onclick value

getOndblclick

public final java.lang.String getOndblclick()
Gets an ondblclick Javascript handler.

Returns:
the new ondblclick value

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)
Sets an ondblclick Javascript handler.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public final java.lang.String getOnmousedown()
Gets an onmousedown Javascript handler.

Returns:
the new onmousedown value

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)
Sets an onmousedown Javascript handler.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public final java.lang.String getOnmouseup()
Gets an onmouseup Javascript handler.

Returns:
the new onmouseup value

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)
Sets an onmouseup Javascript handler.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public final java.lang.String getOnmouseover()
Gets an onmouseover Javascript handler.

Returns:
the new onmouseover value

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)
Sets an onmouseover Javascript handler.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public final java.lang.String getOnmousemove()
Gets an onmousemove Javascript handler.

Returns:
the new onmousemove value

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)
Sets an onmousemove Javascript handler.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public final java.lang.String getOnmouseout()
Gets an onmouseout Javascript handler.

Returns:
the new onmouseout value

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)
Sets an onmouseout Javascript handler.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public final java.lang.String getOnkeypress()
Gets an onkeypress Javascript handler.

Returns:
the new onkeypress value

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)
Sets an onkeypress Javascript handler.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public final java.lang.String getOnkeydown()
Gets an onkeydown Javascript handler.

Returns:
the new onkeydown value

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)
Sets an onkeydown Javascript handler.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public final java.lang.String getOnkeyup()
Gets an onkeyup Javascript handler.

Returns:
the new onkeyup value

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)
Sets an onkeyup Javascript handler.

Parameters:
onkeyup - the new onkeyup value

getDisclosedText

public final java.lang.String getDisclosedText()
Gets 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.

Returns:
the new disclosedText value

setDisclosedText

public final void setDisclosedText(java.lang.String disclosedText)
Sets 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.

Parameters:
disclosedText - the new disclosedText value

getUndisclosedText

public final java.lang.String getUndisclosedText()
Gets 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.

Returns:
the new undisclosedText value

setUndisclosedText

public final void setUndisclosedText(java.lang.String undisclosedText)
Sets 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.

Parameters:
undisclosedText - the new undisclosedText value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIXShowDetail

getBeanType

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


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