All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.schema.cdk-template.xsd Maven / Gradle / Ivy

The newest version!





    
        
            RichFaces CDK core tags and attributes.
        
    

    
    
    
    

    
        
            
            
            
        
    

    
        
            
        
    

    
        
            
                
                    

The resourceName of the resource pointed to by this ResourceDependency.

The libraryName in which the resource pointed to by this ResourceDependency resides. If not specified, defaults to the empty string.

The value given for this attribute will be passed as the "target" argument to javax.faces.component.UIViewRoot.addComponentResource(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.String).

If this attribute is specified, javax.faces.component.UIViewRoot.addComponentResource(javax.faces.context.FacesContext, javax.faces.component.UIComponent) must be called instead, as described above.

Enables pass-through rendering of attributes. Allows to define whitespace-separated list of attributes to exclude from pass-through encoding or empty string "" if all attributes should be encoded.

Examples:

  • ]]>
  • ]]>
Attributes already defined on the tag are automatically excluded from pass-through rendering.

If "disabled" attribute of the component is true (i.e. boolean true or "true"), then attributes that have associated behavior events are not encoded.

Enables pass-through rendering of attributes. Allows to define whitespace-separated list of attributes to include. If component attribute name is different from default, the exact name can be added after colon.

Examples:

  • ]]>
  • ]]>
Attributes already defined on the tag are automatically excluded from pass-through rendering.

If "disabled" attribute of the component is true (i.e. boolean true or "true"), then attributes that have associated behavior events are not encoded.

Root template tag containing cc:interface & cc:implementation tags.

Container tag to specify multiple ]]> tags on a single class.

Should be used within cc:interface element.

Fully-qualified name of the generated renderer class.

Should be used within cc:interface element.

Fully-qualified name of the renderer superclass.

Should be used within cc:interface element.

Fully-qualified name of a base class common to all components rendered by this renderer.

Defaults to javax.faces.component.UIComponent.

Should be used within cc:interface element.

ID of the renderkit to include this renderer to. Defaults to 'HTML_BASIC'.

Should be used within cc:interface element.

Family of the component to be rendered by this renderer.

Should be used within cc:interface element.

Renderer type identifier for this renderer.

Should be used within cc:interface element.

Indicating whether generated renderer is responsible for rendering the children of the component it is asked to render.

Should be used within cc:interface element.

Defines fragment of faces configuration file to import attributes from.

Should be used within cc:interface element.

URI of the file to import. Any URI supported by CDK is allowed to be used here. Imported file should have ]]> tag as root element.

Template body marker tag. Should be used only once in template document. Component renderers in JSF define three methods for content rendering, so the following rules are applied for ]]> part of template document:

  • all content declared before ]]> tag is compiled into statements of encodeBegin(...) method
  • all content declared inside ]]> tag is compiled into statements of encodeChildren(...) method. If content of body element is empty, no encodeChildren(...) method will be generated unless 'enforce' attribute set to true.
  • all content declared after ]]> tag is compiled into statements of encodeEnd(...) method
If there are no compiled statements for one of the aforementioned methods, then definition for this method is not created in the generated file.
If template document doesn't declare ]]> tag, then contents of ]]> part is compiled into statements of encodeEnd(...) method.

Examples:

The following code snippet:


									
Component content
... ]]>
produces the following code (unsignificant details are ommitted):


The following code snippet:

									
... ]]>
produces the following code (unsignificant details are ommitted):


If you want to disable default encodeChildren method, use enforce attribute:

                                    
... ]]>
produces the following code (unsignificant details are ommitted):


The following code snippet:

									
Some text
... ]]>
produces the following code (unsignificant details are ommitted):

Arbitrary method invocation statement. Should be used within cc:implementation element.

Note: method return value is ignored.

Method invocation expression. If this attribute is ommitted, body of the tag is used instead.

Examples:

  • ]]>
  • responseWriter.writeAttribute("id", clientId, "id")]]>

Introduces new variable. Variable's scope is limited to the context of the current method, i.e. variables defined before <cdk:body> are not available after it.

Should be used within cc:implementation element.

Usage example:

  • ]]>

Name of the variable, corresponding to Java identifier syntax.

Examples:

  • ]]>
  • ]]>
  • ]]>

EL-expression specifying initial value of the variable. If this attribute is ommitted, body of the tag is used instead.

Examples:

  • ]]>
  • ]]>
  • ]]>
  • #{cc.getClientId(facesContext)}]]>

Variable type name. CDK automatically resolves simple names for primitive types, JSF API classes and objects from java.lang.* or java.util.*. For parametrised types you can use java generics syntax

Examples:

  • ]]>
  • ]]>
  • " ...>]]>
  • ]]>

If type is not defined explicitly, CDK will try to infer variable type from its value.

Defines whether type cast is needed.

Resource dependency tag. Defines dependent resource for the renderer (see documentation for @ResourceDependency annotation for more information).

Support for this tag is not currently implemented.

Part of <composite:interface> section to specify additional Java imports.

Examples:

  • ]]>
  • ]]>
  • ]]>

Base name of the package to be imported.

Space-separated list of names to be imported.

Defines whether the import is static.

Handy tag for JavaScript hash objects creation. NB: default and empty values are not added to the result hash.

Example usage:


                        
                        ...