META-INF.jsf_core.tld Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces-api Show documentation
Show all versions of jakarta.faces-api Show documentation
Jakarta Faces defines an MVC framework for building user interfaces for web applications,
including UI components, state management, event handing, input validation, page navigation, and
support for internationalization and accessibility.
]]> attribute must be escaped. This flag is set to "true" by default.The core JavaServer Faces custom actions that are independent of any particular RenderKit. 2.1 f http://java.sun.com/jsf/core This tag library validator verifies certain semantic restrictions on the use of JavaServer Faces component actions, including the requirement that component tags nested inside a JSTL conditional tag must have a value specified for the "id" attribute. com.sun.faces.taglib.jsf_core.CoreValidator com.sun.faces.config.ConfigureListener Register an ActionListener instance on the UIComponent associated with the closest parent UIComponent custom action.]]> actionListener com.sun.faces.taglib.jsf_core.ActionListenerTag empty Fully qualified Java class name of an ActionListener to be created and registered. type false java.lang.String Value binding expression that evaluates to an object that implements javax.faces.event.ActionListener. binding false javax.faces.event.ActionListener Add an attribute to the UIComponent associated with the closest parent UIComponent custom action. attribute com.sun.faces.taglib.jsf_core.AttributeTag empty The name of the component attribute to be set. name java.lang.String The value of the component attribute to be set. value java.lang.Object Register a DateTimeConverter instance on the UIComponent associated with the closest parent UIComponent custom action. convertDateTime com.sun.faces.taglib.jsf_core.ConvertDateTimeTag empty Predefined formatting style which determines how the date component of a date string is to be formatted and parsed. Applied only if type is "date" or "both". Valid values are "default", "short", "medium", "long", and "full". Default value is "default". dateStyle java.lang.String Locale whose predefined styles for dates and times are used during formatting or parsing. If not specified, the Locale returned by FacesContext.getViewRoot().getLocale() will be used. Value must be either a VB expression that evaluates to a java.util.Locale instance, or a String that is valid to pass as the first argument to the constructor java.util.Locale(String language, String country). The empty string is passed as the second argument. locale false java.lang.Object Custom formatting pattern which determines how the date/time string should be formatted and parsed. pattern java.lang.String Predefined formatting style which determines how the time component of a date string is to be formatted and parsed. Applied only if type is "time" or "both". Valid values are "default", "short", "medium", "long", and "full". Default value is "default". timeStyle java.lang.String Time zone in which to interpret any time information in the date String. Value must be either a VB expression that evaluates to a java.util.TimeZone instance, or a String that is a timezone ID as described in the javadocs for java.util.TimeZone.getTimeZone(). timeZone java.lang.Object Specifies what contents the string value will be formatted to include, or parsed expecting. Valid values are "date", "time", and "both". Default value is "date". type java.lang.String A ValueExpression that evaluates to an instance of javax.faces.convert.DateTimeConverter. binding javax.faces.convert.DateTimeConverter Register a NumberConverter instance on the UIComponent associated with the closest parent UIComponent custom action. convertNumber com.sun.faces.taglib.jsf_core.ConvertNumberTag empty ISO 4217 currency code, applied only when formatting currencies. currencyCode java.lang.String Currency symbol, applied only when formatting currencies. currencySymbol java.lang.String Flag specifying whether formatted output will contain grouping separators. Expressions must evaluate to a boolean. Default value is true. groupingUsed java.lang.Boolean Flag specifying whether only the integer part of the value will be formatted and parsed. Expressions must evaluate to a boolean. Default value is false. integerOnly java.lang.Boolean Locale whose predefined styles for numbers are used during formatting and parsing. If not specified, the Locale returned by FacesContext.getViewRoot().getLocale() will be used. Expressions must evaluate to a java.util.Locale or a String that is valid to pass as the first argument to the constructor java.util.Locale(String language, String country). The empty string is passed as the second argument. ]]> locale java.lang.Object Maximum number of digits that will be formatted in the fractional portion of the output. Expressions must evaluate to an int. maxFractionDigits java.lang.Integer Maximum number of digits that will be formatted in the integer portion of the output. Expressions must evaluate to an int. maxIntegerDigits java.lang.Integer Minimum number of digits that will be formatted in the fractional portion of the output. Expressions must evaluate to an int. minFractionDigits java.lang.Integer Minimum number of digits that will be formatted in the integer portion of the output. Expressions must evaluate to an int. minIntegerDigits java.lang.Integer Custom formatting pattern which determins how the number string should be formatted and parsed. pattern java.lang.String Specifies how the number string will be formatted and parsed. Valid values are "number", "currency", and "percent". Default value is "number". type java.lang.String A ValueExpression that evaluates to an instance of javax.faces.convert.NumberConverter. binding javax.faces.convert.NumberConverter Register a named Converter instance on the UIComponent associated with the closest parent UIComponent custom action. converter com.sun.faces.taglib.jsf_core.ConverterTag empty Converter identifier of the Converter instance to be created and registered. converterId java.lang.String A ValueExpression that evaluates to an object that implements javax.faces.convert.Converter. binding javax.faces.convert.Converter Register a named facet on the UIComponent associated with the closest parent UIComponent custom action. ]]> facet javax.faces.webapp.FacetTag JSP Name of the facet to be created. name true false java.lang.String Load a resource bundle localized for the Locale of the current view, and expose it as a java.util.Map in the request attributes of the current request under the key specified by the value of the "var" attribute of this tag. The Map must behave such that if a get() call is made for a key that does not exist in the Map, the literal string ???KEY??? is returned from the Map, where KEY is the key being looked up in the Map, instead of a MissingResourceException being thrown. If the ResourceBundle does not exist, a JspException must be thrown. loadBundle com.sun.faces.taglib.jsf_core.LoadBundleTag empty Base name of the resource bundle to be loaded. basename java.lang.String Name of a request scope attribute under which the resource bundle will be exposed as a Map. var true false Add a child UIParameter component to the UIComponent associated with the closed parent UIComponent custom action. param com.sun.faces.taglib.jsf_core.ParameterTag JSP ValueExpression to a backing bean property bound to the component instance for the UIComponent created by this custom action. binding javax.faces.component.UIComponent Component identifier of the UIParameter component to be created. id false true Name of the parameter to be created. name java.lang.String Value of the parameter to be set. value Used inside of the metada facet of a view, this tag causes a UIViewParameter to be attached as metadata for the current view. Because UIViewParameterextendsUIInputall of the attributes and nested child content for anyUIInputtags are valid on this tag as well. ]]>viewParam com.sun.faces.taglib.jsf_core.ParameterTag JSP converter false javax.faces.convert.Converter converterMessage false java.lang.String id false true required false boolean requiredMessage false java.lang.String validator false void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object) validatorMessage false java.lang.String value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEventparameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed". ]]>valueChangeListener false void valueChange(javax.faces.event.ValueChangeEvent) maxlength false int The ValueExpression linking this component to a property in a backing bean binding false javax.faces.component.UIComponent Register a PhaseListener instance on the UIViewRoot in which this tag is nested. phaseListener com.sun.faces.taglib.jsf_core.PhaseListenerTag empty Fully qualified Java class name of an PhaseListener to be created and registered. type false java.lang.String Value binding expression that evaluates to an object that implements javax.faces.event.PhaseListener. binding false javax.faces.event.PhaseListener Add a child UISelectItem component to the UIComponent associated with the closed parent UIComponent custom action. ]]> selectItem com.sun.faces.taglib.jsf_core.SelectItemTag empty Value binding expression to a backing bean property bound to the component instance for the UIComponent created by this custom action. binding javax.faces.component.UIComponent Component identifier of the UISelectItem component to be created. id false true Description of this option, for use in development tools. itemDescription java.lang.String Flag indicating whether the option created by this component is disabled. Expressions must evaluate to a boolean. Default value is false. itemDisabled java.lang.Boolean Label to be displayed to the user for this option. itemLabel java.lang.String Flag indicating that characters that are sensitive in the value of the itemLabel escape java.lang.String Value to be returned to the server if this option is selected by the user. itemValue Value binding expression pointing at a SelectItem instance containing the information for this option. value javax.faces.model.SelectItem Flag indicating whether the option created by this component represents the special "no selection" option. Expressions must evaluate to a boolean. Default value is false. ]]> noSelectionOption java.lang.Boolean Add a child UISelectItems component to the UIComponent associated with the closest parent UIComponent custom action. When iterating over the select items,
toString()must be called on the string rendered attribute values.Version 2 of the specification introduces several new attributes, described below. These are: var, itemValue, itemLabel, itemDescription, itemDisabled, and itemLabelEscaped.
]]>selectItems com.sun.faces.taglib.jsf_core.SelectItemsTag empty Value binding expression to a backing bean property bound to the component instance for the UIComponent created by this custom action. binding javax.faces.component.UIComponent Component identifier of the UISelectItems component to be created. id false true Value expression pointing at any Collectionor array. The member elements may be instances ofSelectItemor any Java Object. In the case where the member elements are plain Java Objects, several additional attributes must be used by the page author to correctly identify the data to the enclosingUISelectOneorUISelectManycomponent, as shown in the following example.
In the preceding example, the
]]>valueattribute on line 1 points to aCollection<HobbitBean>.HobbitBeanis just a regular Java Object (POJO) that conforms to JavaBeans naming conventions for its properties. Thevalueattribute on line 2 points to aList<HobbitBean>, though it could just as well point to aCollection, array, orjavax.faces.model.DataModel. The attributes on lines 3 through 9, inclusive, leverage the fact that the value is a collection of POJOs.value java.lang.Object Expose the value from the valueattribute under this request scoped key so that it may be referred to in EL for the value of other attributes. ]]>var false false java.lang.String This attribute lets you refer to a property of the current member of the collection referenced by the "value" attribute, using the value of the "var" attribute as the base. For example, #{n.id}. ]]> itemValue java.lang.Object evaluates to a String that will serve as the label to be shown for the item. ]]> itemLabel java.lang.String evaluates to a String that will serve as the description to be shown for the item. ]]> itemDescription java.lang.String evaluates to a boolean that will determine if the item value is selectable or not. ]]> itemDisabled java.lang.Boolean evaluates to a boolean that will determine if the rendered markup for the item receives normal JSF HTML escaping or not. ]]> itemLabelEscaped java.lang.Boolean Is either an EL expression pointing to the element in the value collection whose value should be marked as a “no selection” item, or a literal string that exactly matches the value of the item in the collection that must be marked as the “no selection” item. If the user selects such an item and the field is marked as required, then it will not pass validation. ]]> noSelectionOption java.lang.Boolean Register an ActionListener instance on the UIComponent associated with the closest parent UIComponent custom action. This actionListener will cause the value given by the "value" attribute to be set into the ValueExpression given by the "target" attribute. The implementation of this tag creates a special
ActionListenerinstance and registers it on theActionSourceassociated with our most immediate surrounding instance of a tag whose implementation class is a subclass ofUIComponentTag. This tag creates no output to the page currently being created.The
ActionListenerinstance created and installed by this tag has the following behavior and contract.]]>
- Only create and register the
ActionListenerinstance the first time the component for this tag is created- The "target" and "value" tag attributes are ValueExpression instances and are stored unevaluated as instance variables of the listener.
- When the listener executes, perform the following:
Call getValue() on the "value" ValueExpression.
If value of the "value" expression is null, call setValue() on the "target" ValueExpression with the null value.
If the value of the "value" expression is not null, call getType() on the "value" and "target" ValueExpressions to determine their property types.
Coerce the value of the "value" expression to the "target" expression value type following the Expression Language coercion rules. Call setValue() on the "target" ValueExpression with the resulting value.
If either coercion or the execution of setValue() fails throw an AbortProcessingException.
setPropertyActionListener com.sun.faces.taglib.jsf_core.SetPropertyActionListenerTag empty ValueExpression to be stored as the value of the target attribute. value true ValueExpression that is the destination of the value attribute. target true Container action for all JavaServer Faces core and custom component actions used on a nested page via "jsp:include" or any custom action that dynamically includes another page from the same web application, such as JSTL's "c:import". subview com.sun.faces.taglib.jsf_core.SubviewTag JSP Value binding expression to a backing bean property bound to the component instance for the UIComponent created by this custom action. binding javax.faces.component.UIComponent Component identifier of the UINamingContainer component to be created. id true true Flag indicating whether this component (and its children) should be rendered. Expressions must evaluate to a boolean. rendered java.lang.Boolean Register a DoubleRangeValidator instance on the UIComponent associated with the closest parent UIComponent custom action. validateDoubleRange com.sun.faces.taglib.jsf_core.ValidateDoubleRangeTag JSP Maximum value allowed for this component. maximum java.lang.Double Minimum value allowed for this component. minimum java.lang.Double A ValueExpression that evaluates to an instance of DoubleRangeValidator. binding javax.faces.validator.DoubleRangeValidator Register a LengthValidator instance on the UIComponent associated with the closest parent UIComponent custom action. validateLength com.sun.faces.taglib.jsf_core.ValidateLengthTag JSP Maximum length allowed for this component. maximum java.lang.Integer Minimum length allowed for this component. minimum java.lang.Integer A ValueExpression that evaluates to an instance of LenghtValidator. binding javax.faces.validator.LengthValidator Register a LongRangeValidator instance on the UIComponent associated with the closest parent UIComponent custom action. validateLongRange com.sun.faces.taglib.jsf_core.ValidateLongRangeTag JSP Maximum value allowed for this component. maximum java.lang.Long Minimum value allowed for this component. minimum java.lang.Long A ValueExpression that evaluates to an instance of LongRangeValidator. binding javax.faces.validator.LongRangeValidator A validator that uses the pattern attribute to validate the wrapping component. The entire pattern is matched against the String value of the component. If it matches, it's valid. ]]> validateRegex com.sun.faces.taglib.jsf_core.RegexValidatorTag empty A regular expression pattern. Remember that, like in all Java strings, backslash must be escaped with another backslash. pattern true java.lang.String A ValueExpression that evaluates to an instance of RegexpValidator. binding javax.faces.validator.RegexValidator Register a named Validator instance on the UIComponent associated with the closest parent UIComponent custom action. validator com.sun.faces.taglib.jsf_core.ValidatorTag empty Validator identifier of the Validator to be created and registered. validatorId java.lang.String A ValueExpression that evaluates to an object that implements the javax.faces.validator.Validator interface. binding javax.faces.validator.Validator Register an ValueChangeListener instance on the UIComponent associated with the closest parent UIComponent custom action. valueChangeListener com.sun.faces.taglib.jsf_core.ValueChangeListenerTag empty Fully qualified Java class name of a ValueChangeListener to be created and registered. type java.lang.String Value binding expression that evaluates to an object that implements javax.faces.event.ValueChangeListener. binding false javax.faces.event.ValueChangeListener Create and register a child UIOutput component associated with the closest parent UIComponent custom action, which renders nested body content. verbatim com.sun.faces.taglib.jsf_core.VerbatimTag JSP Flag indicating that generated markup must be escaped in a manner that is appropriate for the markup language to be rendered. Expressions must evaluate to a boolean. Default value is false. escape java.lang.Boolean rendered false java.lang.Boolean Container for all JavaServer Faces core and custom component actions used on a page. view com.sun.faces.taglib.jsf_core.ViewTag JSP Locale to use for localizing this page. Expressions must evaluate to a java.util.Locale or to a String that is converted to a Locale. locale java.lang.Object Identifier for the RenderKit to use for rendering this page. renderKitId false java.lang.String MethodBinding pointing to a method that takes a javax.faces.event.PhaseEvent and returns void. This method will be called before every phase except for restore view. beforePhase false void beforePhase(javax.faces.event.PhaseEvent) MethodBinding pointing to a method that takes a javax.faces.event.PhaseEvent and returns void. This method will be called after every phase except for restore view on an initial request. afterPhase false void afterPhase(javax.faces.event.PhaseEvent)