TILES
<  Home  |  Présentation  |  Installation  |  TagLib  |  Exemples |  Webographie et liensContacts  >

PLAN

TagLib - général

Voici maintenant l'ensemble des balises fournies par Tiles. Je vais commencé par décrire les balises générales puis donner tous les parametres utilisables avec chacune d'entre elles.

Nom de la balise
Description
add Ajoute un élément à une liste.
definition Crée un définition Tiles.
get récupére le contenu d'un attribut dans un context précis.
getAsString Récupère la valeur d'un attribut du tile/component/template.
importAttribute Importe un attribut d'un Tile dans un context donné.
initComponentDefinitions Initialise le moteur de Tiles.
insert Insère un composant Tiles.
put Ajoute un attribut dans un context donné.
putList Déclare une liste qui va être placée dans un attribut donné..
useAttribute Utilise un attribut dans une page.


La balise insert

Cette balise est responsable de l'insertion d'un contenu dans une page ou un attribut.


Nom de l'attribut Description
attribute Le nom d'un attribut du tile/composant à insérer. La valeur de cet attribut est passé à l'attribut   name.
beanName

Le nom du bean utilisé comme valeur.

Le bean est retiré du context spécifié, si il y en a un. Autrement la méthode pageContext.findAttribute() est utilisée. Si l'attribut beanProperty est spécifé, alors la valeur est une des propriétés du bean.

Si le bean (ou la valeur contenu dans une des propriétes du bean) est une instance de la classe Attribute (ou d'une classe l'héritant par exemple Direct, Instance, etc.) , l'insertion est faite en fonction du type de la classe. Autrement la méthode toString() est utilisée et la valeur string retournée est passé a l'attribut name.

beanProperty Le nom de la propriété du bean.
beanScope Spécifie le context dans lequel le bean peut être trouvé. le contexte peut être n'importe quel  JSP, composant, ou template.
component Une string représentant l'URI d'un tile ou d'un template.
controllerUrl

L'URL d'un controlleur appelé immédiatement avant l'insertion de la page. Cette URL est généralement utilisée pour spécifier une action struts. Le controlleur est habituellement concut pour préparer les données qui vont être affichées dans le tile.

Un et un seul controllerUrl ou controllerClass doit être utilisé.

controllerClass

L'URL d'un controlleur appelé immédiatement avant l'insertion de la page. Cette URL est généralement utilisée pour spécifier une action struts. Le controlleur est habituellement concut pour préparer les données qui vont être affichées dans le tile.

La classe doit étendre une des classes suivantes pour être valide : org.apache.struts.tiles.Controller, org.apache.struts.tiles.ControllerSupport, ou org.apache.struts.action.Action.

definition Le nom de la définition a insérer. Les définitions sont définies dans un fichier de définition centralisés.
flush true ou false. si true, la page courante est rafraichis avant l'insertion du tile.
ignore Si cet attribut est mis a true et que l'attribut spécifié par l'attribut name n'existe pas alors insert n'effectuera aucune action, si cet attribut etait false alors une runtime exception aurai été jetée.
name Le nom de l'entité a insérer
page Une string qui représente l'URI d'un tile ou un template.
role Permet de spécifier si l'utilisateur est autorisé et affiche le contenu de la balise en consequence.
template Une string qui représente l'URI d'un tile ou un template.


La balise définition

cette balise permet la déclaration d'une définition de composant.

Attribute name Description
extends mot clé permettant d'associer un parent a la définition
id Le nom utilisé pour cette définition.
page URL du composant a insérer
role Le "role" a vérifier avnt l'insertion de la definition. Si le "role" n'est pas défini pour l'utilisateur la définition n'est pas inséré.
scope Définit la porté de la définition par défaut : la page sur laquel elle est insérée.
template URL du tile/component/template (a JSP page).


La balise put

cette balise permet d'ajout un composant à un context.

Attribute name Description
beanName

Le nom du bean utilisé comme valeur.

Le bean est retiré du context spécifié, si il y en a un. Autrement la méthode pageContext.findAttribute() est utilisée. Si l'attribut beanProperty est spécifé, alors la valeur est une des propriétés du bean.

Si le bean (ou la valeur contenu dans une des propriétes du bean) est une instance de la classe Attribute (ou d'une classe l'héritant par exemple Direct, Instance, etc.) , l'insertion est faite en fonction du type de la classe. Autrement la méthode toString() est utilisée et la valeur string retournée est passé a l'attribut name.

beanProperty Le nom de la propriété du bean.
beanScope Spécifie le context dans lequel le bean peut être trouvé. le contexte peut être n'importe quel  JSP, composant, ou template.
content Le contenu a insérer dans le tile. Cet attribut est identique a l'attribut value. Il a été ajouté juste pour la compatibilité avec la balise JSP.
direct Comment est géré le contenu :
"true" -> directement affiché, le contenu est une String.
"false" -> inséré dans la page, le contenu est une page.
name Le nom d'un attribut.
role Permet de spécifier si l'utilisateur est autorisé et affiche le contenu en consequence.
type Le type de contenu : "string", "page", "template", ou "definition".
value La valeur a insérer.

La balise putlist

Cette balise permet de créer une liste d'attribut.

Attribute name Description
name Le nom de la List. Cet attribut est requis.

La balise add

cette balise permet d'ajouter un attribut a un composant (une liste d'attribut par exemple).

Attribute name Description
beanName

Le nom du bean utilisé comme valeur.

Le bean est retiré du context spécifié, si il y en a un. Autrement la méthode pageContext.findAttribute() est utilisée. Si l'attribut beanProperty est spécifé, alors la valeur est une des propriétés du bean.

Si le bean (ou la valeur contenu dans une des propriétes du bean) est une instance de la classe Attribute (ou d'une classe l'héritant par exemple Direct, Instance, etc.) , l'insertion est faite en fonction du type de la classe. Autrement la méthode toString() est utilisée et la valeur string retournée est passé a l'attribut name.
beanProperty Le nom de la propriété du bean.
beanScope Spécifie le context dans lequel le bean peut être trouvé. le contexte peut être n'importe quel  JSP, composant, ou template.
code>content Le contenu a insérer dans le tile. Cet attribut est identique a l'attribut value. Il a été ajouté juste pour la compatibilité avec la balise JSP.
direct Comment est géré le contenu :
"true" -> directement affiché.
"false" -> inséré dans la page, par défaut.
role Permet de spécifier si l'utilisateur est autorisé et affiche le contenu en consequence.
type Le type de contenu : "string", "page", "template", ou "definition". Si aucun contenu n'est spécifé alors la valeur de type est "untyped".
value La valeur a insérer.

La balise get

cette balise permet de retirer un contenu d'un tiles.

Attribute name Description
flush true ou false. si true, la page courante est rafraichis avant l'insertion du tile.
ignore Si cet attribut est mis a true et que l'attribut spécifié par l'attribut name n'existe pas alors insert n'effectuera aucune action, si cet attribut etait false alors une runtime exception aurait été jetée.
name Le nom du contenu a retirer du tile.
role Permet de spécifier si l'utilisateur est autorisé et affiche le contenu de la balise en consequence.

La balise getAsString

cette balise permet de retirer un contenu d'un tiles sous la forme d'une string (chaine de caractères).

Attribute name Description
ignore Si cet attribut est mis a true et que l'attribut spécifié par l'attribut name n'existe pas alors insert n'effectuera aucune action, si cet attribut etait false alors une runtime exception aurai été jetée.
name Le nom de l'attribut.
role Permet de spécifier si l'utilisateur est autorisé et affiche le contenu de la balise en consequence.

La balise useAttribut

Cette balise permet d'utiliser un attribut du contexte courant.

Attribute name Description
classname La classe de la variable.
id Le nom de la variable.
ignore Si cet attribut est mis a true et que l'attribut spécifié par l'attribut name n'existe pas alors insert n'effectuera aucune action, si cet attribut etait false alors une runtime exception aurait été jetée.
name Le nom du tile.
scope Le contexte de l'attribut déclaré.

La balise importAttribut

Cette balise permet d'importer un attribut depuis un contexte a celui courant.

Attribute name Description
ignore Si cet attribut est mis a true et que l'attribut spécifié par l'attribut name n'existe pas alors insert n'effectuera aucune action, si cet attribut etait false alors une runtime exception aurai été jetée.
name Le nom de l'attribut a importer. Si le champ n'est pas spécifié, tous les attributs sont importés.
scope Le contexte de l'attribut a importer.

La balise initComponentDefinition

Cette balise permet de déclarer un fichier de définition.

Attribute name Description
classname Si spécifié, l'attribut classname de la fabrique qui crée et initialise.
file Le nom de fichier de la définition.