public interface AttachedObjectTarget
Within the declaration of a composite component, an AttachedObjectTarget allows the
composite component author to expose the semantics of an inner component to the page author without
exposing the rendering or implementation details of the inner component. See
ViewDeclarationLanguage.getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource) for the context in which implementations of this interface are
used.
The implementation must ensure that this instance is thread safe and may be shared among different component trees.
Subinterfaces are provided for the common behavioral interfaces: Behavior,
ValueHolder, EditableValueHolder and
ActionSource2. The default VDL implementation must provide a corresponding Facelets
tag handler for each of the subinterfaces of this interface.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ATTACHED_OBJECT_TARGETS_KEY
The key in the value set of the composite component |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getName()
Returns the name by which this attached object target is exposed to the page author. |
java.util.List<UIComponent> |
getTargets(UIComponent topLevelComponent)
Returns the |
static final java.lang.String ATTACHED_OBJECT_TARGETS_KEY
The key in the value set of the composite component BeanDescriptor, the value for which is a
List<AttachedObjectTarget>.
java.util.List<UIComponent> getTargets(UIComponent topLevelComponent)
Returns the List<UIComponent> that this AttachedObjectTarget exposes. Each
attached object exposed by the composite component author may point at multiple
UIComponent instances within the composite component. This method is used by the
ViewDeclarationLanguage.retargetAttachedObjects(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.util.List<jakarta.faces.view.AttachedObjectHandler>) method to take the appropriate action on
the attached object.
topLevelComponent - the top level component for this composite component.java.lang.String getName()
Returns the name by which this attached object target is exposed to the page author.