|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.view.facelets.FaceletCompositionContext
public abstract class FaceletCompositionContext
Field Summary | |
---|---|
protected static String |
FACELET_COMPOSITION_CONTEXT_KEY
|
Constructor Summary | |
---|---|
protected |
FaceletCompositionContext()
|
Method Summary | |
---|---|
abstract void |
addAttachedObjectHandler(UIComponent compositeComponentParent,
AttachedObjectHandler handler)
Add to the composite component parent this handler, so it will be processed later when ViewDeclarationLanguage.retargetAttachedObjects is called. |
abstract void |
addMethodExpressionTargeted(UIComponent targetedComponent,
String attributeName,
Object backingValue)
Add a method expression as targeted for the provided composite component |
abstract void |
clearMethodExpressionAttribute(UIComponent compositeComponentParent,
String attributeName)
Clear the MethodExpression attribute to call vdl.retargetMethodExpression again |
abstract boolean |
containsEnclosingValidatorId(String id)
|
void |
endComponentUniqueIdSection()
Ends the current unique id section, so the previous counter will be used to generate unique ids to components. |
abstract void |
finalizeForDeletion(UIComponent component)
Used in conjunction with markForDeletion where any UIComponent marked will be removed. |
String |
generateUniqueComponentId()
Generate a unique id for component instances. |
String |
generateUniqueId()
Generate a unique id that will be used later to derive a unique id per tag by FaceletContext.generateUniqueId(). |
abstract List<AttachedObjectHandler> |
getAttachedObjectHandlers(UIComponent compositeComponentParent)
Retrieve the list of object handlers attached to a composite component parent. |
abstract UIComponent |
getCompositeComponentFromStack()
Return the composite component being applied on the current facelet. |
static FaceletCompositionContext |
getCurrentInstance()
|
static FaceletCompositionContext |
getCurrentInstance(FaceletContext ctx)
|
static FaceletCompositionContext |
getCurrentInstance(FacesContext ctx)
|
ELExpressionCacheMode |
getELExpressionCacheMode()
Indicates if a EL Expression can be or not cached by facelets vdl. |
abstract Iterator<String> |
getEnclosingValidatorIds()
Deprecated. |
abstract Iterator<Map.Entry<String,EditableValueHolderAttachedObjectHandler>> |
getEnclosingValidatorIdsAndHandlers()
Gets all validationIds with its associated EditableValueHolderAttachedObjectHandler from the stack. |
abstract Iterator<String> |
getExcludedValidatorIds()
Deprecated. |
abstract FaceletFactory |
getFaceletFactory()
|
abstract String |
getFirstValidationGroupFromStack()
Deprecated. |
abstract UniqueIdVendor |
getUniqueIdVendorFromStack()
Return the latest UniqueIdVendor created from stack. |
void |
init(FacesContext facesContext)
|
abstract boolean |
isMarkInitialState()
Check if this build should be marked as initial state. |
abstract boolean |
isMarkInitialStateAndIsRefreshTransientBuildOnPSS()
|
abstract boolean |
isMethodExpressionAttributeApplied(UIComponent compositeComponentParent,
String attributeName)
Check if the MethodExpression attribute has been applied using vdl.retargetMethodExpression |
abstract boolean |
isRefreshingTransientBuild()
Check if this build is being refreshed, adding transient components and adding/removing components under c:if or c:forEach or not. |
abstract boolean |
isRefreshTransientBuildOnPSS()
Check if the current view will be refreshed with partial state saving. |
abstract boolean |
isUsingPSSOnThisView()
Check if we are using partial state saving on this view |
boolean |
isWrapTagExceptionsAsContextAware()
|
abstract void |
markForDeletion(UIComponent component)
Marks all direct children and Facets with an attribute for deletion. |
abstract void |
markMethodExpressionAttribute(UIComponent compositeComponentParent,
String attributeName)
Mark the MethodExpression attribute as applied using vdl.retargetMethodExpression |
abstract void |
popCompositeComponentToStack()
|
abstract void |
popEnclosingValidatorIdToStack()
Removes top of stack. |
abstract void |
popExcludedValidatorIdToStack()
Deprecated. |
abstract void |
popUniqueIdVendorToStack()
|
abstract void |
popValidationGroupsToStack()
Deprecated. |
abstract void |
pushCompositeComponentToStack(UIComponent parent)
|
abstract void |
pushEnclosingValidatorIdToStack(String validatorId)
Deprecated. |
abstract void |
pushEnclosingValidatorIdToStack(String validatorId,
EditableValueHolderAttachedObjectHandler attachedObjectHandler)
Pushes validatorId to the stack of all enclosing validatorIds. |
abstract void |
pushExcludedValidatorIdToStack(String validatorId)
Deprecated. |
abstract void |
pushUniqueIdVendorToStack(UniqueIdVendor parent)
|
abstract void |
pushValidationGroupsToStack(String validationGroups)
Deprecated. |
void |
release(FacesContext facesContext)
Releases the MyFaceletContext object. |
abstract void |
removeAttachedObjectHandlers(UIComponent compositeComponentParent)
Remove from the composite component parent the list of attached handlers. |
abstract Object |
removeMethodExpressionTargeted(UIComponent targetedComponent,
String attributeName)
Remove a method expression as targeted for the provided composite component |
String |
startComponentUniqueIdSection()
Start a new unique id section, which means a new counter is used to generate unique ids to components |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String FACELET_COMPOSITION_CONTEXT_KEY
Constructor Detail |
---|
protected FaceletCompositionContext()
Method Detail |
---|
public static FaceletCompositionContext getCurrentInstance()
public static FaceletCompositionContext getCurrentInstance(FaceletContext ctx)
public static FaceletCompositionContext getCurrentInstance(FacesContext ctx)
public void init(FacesContext facesContext)
public void release(FacesContext facesContext)
public abstract FaceletFactory getFaceletFactory()
public abstract UIComponent getCompositeComponentFromStack()
public abstract void pushCompositeComponentToStack(UIComponent parent)
parent
- public abstract void popCompositeComponentToStack()
public abstract UniqueIdVendor getUniqueIdVendorFromStack()
public abstract void pushUniqueIdVendorToStack(UniqueIdVendor parent)
parent
- public abstract void popUniqueIdVendorToStack()
@Deprecated public abstract String getFirstValidationGroupFromStack()
@Deprecated public abstract void popValidationGroupsToStack()
@Deprecated public abstract void pushValidationGroupsToStack(String validationGroups)
validationGroups
- @Deprecated public abstract Iterator<String> getExcludedValidatorIds()
@Deprecated public abstract void popExcludedValidatorIdToStack()
@Deprecated public abstract void pushExcludedValidatorIdToStack(String validatorId)
validatorId
- @Deprecated public abstract Iterator<String> getEnclosingValidatorIds()
public abstract void popEnclosingValidatorIdToStack()
@Deprecated public abstract void pushEnclosingValidatorIdToStack(String validatorId)
validatorId
- public abstract void pushEnclosingValidatorIdToStack(String validatorId, EditableValueHolderAttachedObjectHandler attachedObjectHandler)
validatorId
- attachedObjectHandler
- public abstract Iterator<Map.Entry<String,EditableValueHolderAttachedObjectHandler>> getEnclosingValidatorIdsAndHandlers()
public abstract boolean containsEnclosingValidatorId(String id)
id
-
public abstract boolean isRefreshingTransientBuild()
public abstract boolean isMarkInitialState()
public abstract boolean isRefreshTransientBuildOnPSS()
public abstract boolean isUsingPSSOnThisView()
public abstract boolean isMarkInitialStateAndIsRefreshTransientBuildOnPSS()
public abstract void addAttachedObjectHandler(UIComponent compositeComponentParent, AttachedObjectHandler handler)
compositeComponentParent
- handler
- public abstract void removeAttachedObjectHandlers(UIComponent compositeComponentParent)
compositeComponentParent
- public abstract List<AttachedObjectHandler> getAttachedObjectHandlers(UIComponent compositeComponentParent)
compositeComponentParent
- public abstract void markForDeletion(UIComponent component)
component
- UIComponent to mark#finalizeForDeletion(FaceletCompositionContext, UIComponent)
public abstract void finalizeForDeletion(UIComponent component)
component
- UIComponent to finalizepublic abstract void addMethodExpressionTargeted(UIComponent targetedComponent, String attributeName, Object backingValue)
compositeComponentParent
- attributeName
- backingValue
- A value that could be useful to revert its effects.public abstract boolean isMethodExpressionAttributeApplied(UIComponent compositeComponentParent, String attributeName)
compositeComponentParent
- attributeName
-
public abstract void markMethodExpressionAttribute(UIComponent compositeComponentParent, String attributeName)
compositeComponentParent
- attributeName
- public abstract void clearMethodExpressionAttribute(UIComponent compositeComponentParent, String attributeName)
compositeComponentParent
- attributeName
- public abstract Object removeMethodExpressionTargeted(UIComponent targetedComponent, String attributeName)
compositeComponentParent
- attributeName
-
public ELExpressionCacheMode getELExpressionCacheMode()
public boolean isWrapTagExceptionsAsContextAware()
public String startComponentUniqueIdSection()
public String generateUniqueId()
public String generateUniqueComponentId()
public void endComponentUniqueIdSection()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |