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

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.CoreShowDetailItem
All Implemented Interfaces:
javax.faces.component.StateHolder

public class CoreShowDetailItem
extends UIXShowDetail

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.

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 PropertyKey ACCESS_KEY_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static PropertyKey DISABLED_KEY
           
static PropertyKey FLEX_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 PropertyKey SHORT_DESC_KEY
           
static PropertyKey STYLE_CLASS_KEY
           
static PropertyKey TEXT_KEY
           
static java.lang.String TOOLBAR_FACET
           
static FacesBean.Type TYPE
           
 
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
  CoreShowDetailItem()
          Construct an instance of the CoreShowDetailItem.
protected CoreShowDetailItem(java.lang.String rendererType)
          Construct an instance of the CoreShowDetailItem.
 
Method Summary
 char getAccessKey()
          Gets Character used to gain quick access to this showDetailItem.
protected  FacesBean.Type getBeanType()
           
 java.lang.String getFamily()
           
 int getFlex()
          Gets A non-negative integer that indicates the flexibility of this component in its container.
 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.
 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 getText()
          Gets the textual label of the showDetailItem.
 javax.faces.component.UIComponent getToolbar()
          The content for the toolbar region of the detail item.
 boolean isDisabled()
          Gets If value is "true", the component becomes non-interactive.
 void setAccessKey(char accessKey)
          Sets Character used to gain quick access to this showDetailItem.
 void setDisabled(boolean disabled)
          Sets If value is "true", the component becomes non-interactive.
 void setFlex(int flex)
          Sets A non-negative integer that indicates the flexibility of this component in its container.
 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 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 setText(java.lang.String text)
          Sets the textual label of the showDetailItem.
 void setToolbar(javax.faces.component.UIComponent toolbarFacet)
          The content for the toolbar region of the detail item.
 
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

DISABLED_KEY

public static final PropertyKey DISABLED_KEY

TEXT_KEY

public static final PropertyKey TEXT_KEY

ACCESS_KEY_KEY

public static final PropertyKey ACCESS_KEY_KEY

FLEX_KEY

public static final PropertyKey FLEX_KEY

TOOLBAR_FACET

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

CoreShowDetailItem

public CoreShowDetailItem()
Construct an instance of the CoreShowDetailItem.


CoreShowDetailItem

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

Method Detail

getToolbar

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


setToolbar

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


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

isDisabled

public final boolean isDisabled()
Gets If value is "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.

Returns:
the new disabled value

setDisabled

public final void setDisabled(boolean disabled)
Sets If value is "true", the component becomes non-interactive. Otherwise,the default value is "false" and component assumes its expected behavior.

Parameters:
disabled - the new disabled value

getText

public final java.lang.String getText()
Gets the textual label of the showDetailItem.

Returns:
the new text value

setText

public final void setText(java.lang.String text)
Sets the textual label of the showDetailItem.

Parameters:
text - the new text value

getAccessKey

public final char getAccessKey()
Gets 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".

Returns:
the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)
Sets 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".

Parameters:
accessKey - the new accessKey value

getFlex

public final int getFlex()
Gets 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.

Returns:
the new flex value

setFlex

public final void setFlex(int flex)
Sets 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.

Parameters:
flex - the new flex 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.