-
- All Known Subinterfaces:
- ActionSource2AttachedObjectTarget, BehaviorHolderAttachedObjectTarget, EditableValueHolderAttachedObjectTarget, ValueHolderAttachedObjectTarget
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. SeeViewDeclarationLanguage.getComponentMetadata(javax.faces.context.FacesContext, javax.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
andActionSource2
. The default VDL implementation must provide a corresponding Facelets tag handler for each of the subinterfaces of this interface.- Since:
- 2.0
-
-
Field Summary
Fields Modifier and Type Field and Description static String
ATTACHED_OBJECT_TARGETS_KEY
The key in the value set of the composite component
BeanDescriptor
, the value for which is aList<AttachedObjectTarget>
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description String
getName()
Returns the name by which this attached object target is exposed to the page author.
List<UIComponent>
getTargets(UIComponent topLevelComponent)
Returns the
List<UIComponent>
that thisAttachedObjectTarget
exposes.
-
-
-
Field Detail
-
ATTACHED_OBJECT_TARGETS_KEY
static final String ATTACHED_OBJECT_TARGETS_KEY
The key in the value set of the composite component
BeanDescriptor
, the value for which is aList<AttachedObjectTarget>
.- See Also:
- Constant Field Values
-
-
Method Detail
-
getTargets
List<UIComponent> getTargets(UIComponent topLevelComponent)
Returns the
List<UIComponent>
that thisAttachedObjectTarget
exposes. Each attached object exposed by the composite component author may point at multipleUIComponent
instances within the composite component. This method is used by theViewDeclarationLanguage.retargetAttachedObjects(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.util.List<javax.faces.view.AttachedObjectHandler>)
method to take the appropriate action on the attached object.
-
getName
String getName()
Returns the name by which this attached object target is exposed to the page author.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/faces/view/AttachedObjectTarget.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.