org.openfaces.component
Interface OUIObjectIterator
- All Superinterfaces:
- OUIComponent
- All Known Implementing Classes:
- DayTable, ForEach, OUIObjectIteratorBase
public interface OUIObjectIterator
- extends OUIComponent
This interface denotes the components those multiply their child components to display multiple entries of an
associated data collection. The way of specifying collection is component-specific and is not defined by this
interface.
This interface defines a notion of current object Id with its objectId
attribute. The semantics of
handling the current object is specific to each particular component, and it is typically used to refer to a data
entry currently being rendered, or an entry that generated the server action that is being processed.
This interface extends the NamingContainer interface because all components that are rendered multiple times are
expected to have a compound ID based on ID of the main component (a component implementing this interface). E.g. if
there's a multiplied component with id "myOutputText" in a UIObjectIterator component with a client id of
"myIterator1", child component's client id should be formatted as follows: "myIterator1:objectId:myOutputText".
Method Summary |
java.lang.String |
getObjectId()
|
void |
setObjectId(java.lang.String objectId)
Selects an object with the specified id in this component. |
Methods inherited from interface org.openfaces.component.OUIComponent |
getOnblur, getOnclick, getOncontextmenu, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRolloverClass, getRolloverStyle, getStyle, getStyleClass, setOnblur, setOnclick, setOncontextmenu, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRolloverClass, setRolloverStyle, setStyle, setStyleClass |
OBJECT_ID_SEPARATOR
static final java.lang.String OBJECT_ID_SEPARATOR
- See Also:
- Constant Field Values
setObjectId
void setObjectId(java.lang.String objectId)
- Selects an object with the specified id in this component. The semantics of handling the current object is specific
to each particular component, and the current object typically points to a data entry currently being rendered, or
an entry that generated the server action that is being processed.
- Parameters:
objectId
- id of an object to be selected
getObjectId
java.lang.String getObjectId()
- Returns:
- the identifier of the object currently selected in this component.
- See Also:
setObjectId(java.lang.String)
Copyright © 1998-2009 TeamDev Ltd. All Rights Reserved.