org.apache.myfaces.commons.renderOne
Class UIRenderOne

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.commons.renderOne.AbstractUIRenderOne
              extended by org.apache.myfaces.commons.renderOne.UIRenderOne
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIRenderOne
extends AbstractUIRenderOne


Nested Class Summary
protected static class UIRenderOne.PropertyKeys
           
 
Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
UIRenderOne()
           
 
Method Summary
 java.lang.String getFamily()
           
 java.lang.String getType()
          The filter type: first|index.
 java.lang.Integer getValue()
          The value valid for the type.
 void setType(java.lang.String type)
           
 void setValue(java.lang.Integer value)
           
 
Methods inherited from class org.apache.myfaces.commons.renderOne.AbstractUIRenderOne
encodeChildren, getRendersChildren, selectFirstChildByIndex, selectFirstChildOnly, selectOneChild
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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

UIRenderOne

public UIRenderOne()
Method Detail

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

getType

public java.lang.String getType()
Description copied from class: AbstractUIRenderOne
The filter type: first|index. first: the first list value should evaluate to a Number or a value that can be parsed into an integer. index: A collection, array or comma-separated list of numbers. (Default: "first")

Specified by:
getType in class AbstractUIRenderOne
Returns:
the type

setType

public void setType(java.lang.String type)
Specified by:
setType in class AbstractUIRenderOne
Parameters:
type - the type to set

getValue

public java.lang.Integer getValue()
Description copied from class: AbstractUIRenderOne
The value valid for the type. If this evaluates to null, the first child will be rendered. If the type is "first", this value will be ignored, as "first" always renders the first rendered item. If the type is "index", the value must be a number.

Specified by:
getValue in class AbstractUIRenderOne
Returns:
the value

setValue

public void setValue(java.lang.Integer value)
Specified by:
setValue in class AbstractUIRenderOne
Parameters:
value - the value to set


Copyright © 2007-2010 The Apache Software Foundation. All Rights Reserved.