Top Description Constructors Methods
jakarta.faces.view.facelets

public abstract Class MetaRule

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.faces.facelets.tag.BeanPropertyTagRule, com.sun.faces.facelets.tag.MethodRule, com.sun.faces.facelets.tag.faces.ActionSourceRule, com.sun.faces.facelets.tag.faces.ComponentRule, com.sun.faces.facelets.tag.faces.CompositeComponentTagHandler.CompositeComponentRule, com.sun.faces.facelets.tag.faces.EditableValueHolderRule, com.sun.faces.facelets.tag.faces.RenderPropertyRule, com.sun.faces.facelets.tag.faces.ValueHolderRule

The root class of the abstraction that dictates how attributes on a markup element in a Facelets VDL page are wired to the Jakarta Faces API object instance associated with that element. The single method on this interface, applyRule, returns an encapsulation of the behavior that actually does the work of handling the attribute and its value. There are implementations of specific concrete subclasses of this class for all the basic kinds of elements that appear in Facelets VDL pages: components, non-components, and attached objects.

For example, consider this markup: 

<h:inputText value="#{user.userid}"
valueChangeListener="#{user.newUserId}" />

Two MetaRule instances are involved in this example.

  1. The first has an applyRule() method that returns a Metadata instance that, when its applyMetada() method is called, dictates how the "value" attribute is processed: calling jakarta.faces.component.UIComponent#setValueExpression on the UIComponent instance associated with the <h:inputText> element.

  2. The second has an applyRule() method that returns a Metadata instance that, when its applyMetadata() method is called, dictates how the "valueChangeListener" attribute is processed: calling jakarta.faces.component.EditableValueHolder#addValueChangeListener.

Since
2.0

Constructor Summary

AccessConstructor and Description
public
MetaRule()

Method Summary

Modifier and TypeMethod and Description
public abstract Metadata

Returns:

the Metadata.
applyRule(String
the name for this rule. This will generally be the name of a tag attribute in the VDL.
name, TagAttribute
the name/value pair for this attribute on this particular instance of an element in the page.
attribute, MetadataTarget
the MetadataTarged that can be used to discern what kind of action to encapsulate within the abstraction to be returned.
meta)

Return an abstraction that takes appropriate action given the kind of rule represented by the argument name, in the context of this particular concrete subclass of MetaRule.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

MetaRuleback to summary
public MetaRule()

Method Detail

applyRuleback to summary
public abstract Metadata applyRule(String name, TagAttribute attribute, MetadataTarget meta)

Return an abstraction that takes appropriate action given the kind of rule represented by the argument name, in the context of this particular concrete subclass of MetaRule. The abstraction must encapsulate the value from the argument attribute.

Parameters
name:String

the name for this rule. This will generally be the name of a tag attribute in the VDL.

attribute:TagAttribute

the name/value pair for this attribute on this particular instance of an element in the page.

meta:MetadataTarget

the MetadataTarged that can be used to discern what kind of action to encapsulate within the abstraction to be returned.

Returns:Metadata

the Metadata.

Since
2.0