|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |
Object | +--DefaultElementForm,DefaultXML | +--ComposantRattachement
La classe «ComposantRattachement» est la classe permettant de modéliser le composant qui
permet de choisir des items dans une liste et de les "rattacher" pour les faire apparaître dans une
seconde liste.
Ce composant hérite de « DefaultElementForm »
et « DefaultXml ».
Il est aussi composé de 2 listes « ElementFormSelect »
(éléments détachés et éléments rattachés) et 2 boutons « ElementFormButton
» (rattacher et détacher).
Il s'agit d'un élément multi-values :
<ELEMENT>
<LIBELLE>libelle de Rattachement :</LIBELLE>
<LIBELLE1>libelle 1 :</LIBELLE1>
<LIBELLE2>libelle 2 :</LIBELLE2>
<OPTIONS>
<OPTION>
<LIBELLE>optionRattachement1</LIBELLE>
<VALUE>1</VALUE>
<SELECTED>FALSE</SELECTED>
</OPTION>
<OPTION>
<LIBELLE>optionRattachement2</LIBELLE>
<VALUE>2</VALUE>
<SELECTED>FALSE</SELECTED>
</OPTION>
<OPTION>
<LIBELLE>optionRattachement3(true)</LIBELLE>
<VALUE>3</VALUE>
<SELECTED>TRUE</SELECTED>
</OPTION>
<OPTION>
<LIBELLE>optionRattachement4</LIBELLE>
<VALUE>4</VALUE>
<SELECTED>FALSE</SELECTED>
</OPTION>
<OPTION>
<LIBELLE>optionRattachement5</LIBELLE>
<VALUE>5</VALUE>
<SELECTED>FALSE</SELECTED>
</OPTION>
<OPTION>
<LIBELLE>optionRattachement6</LIBELLE>
<VALUE>6</VALUE>
<SELECTED>FALSE</SELECTED>
</OPTION>
<OPTION>
<LIBELLE>optionRattachement7</LIBELLE>
<VALUE>7</VALUE>
<SELECTED>FALSE</SELECTED>
</OPTION>
<OPTION>
<LIBELLE>optionRattachement8</LIBELLE>
<VALUE>8</VALUE>
<SELECTED>FALSE</SELECTED>
</OPTION>
</OPTIONS>
</ELEMENT>
Sommaire des Attributs | |
<private> String |
activetri
La propriété privée «activetri» indique si le tri des éléments de la liste de droite est ou non activé. |
<private> ElementFormButton |
bouton1
La propriété publique «bouton1» est le bouton «rattacher» de type «ElementFormButton». |
<private> ElementFormButton |
bouton2
La propriété publique «bouton2» est le bouton «détacher» de type «ElementFormButton». |
<private> ElementFormButton |
bouton3
La propriété publique «bouton3» est le bouton «monter» de type «ElementFormButton». |
<private> ElementFormButton |
bouton4
La propriété publique «bouton4» est le bouton «descendre» de type «ElementFormButton». |
<private> String |
libelle
La propriété privée «libelle» est le libellé global du composant. |
<private> String |
libelle1
La propriété privée «libelle1» est le libellé relatif à la liste des items non rattachés (liste de gauche). |
<private> String |
libelle2
La propriété privée «libelle2» est le libellé relatif à la liste des items rattachés (liste de droite). |
<private> String |
multiple
La propriété privée «multiple» indique si les listes sont à sélection multiple, par défaut la sélection multiple est possible. |
<private> String |
opt
L'élément «opt» dans la classe ComposantRattachement n'est pas une propriété, il s'agit des options de type ObjectOption parcourues une à une dans le tableau des options. |
<private> ElementFormSelect |
select1
La propriété publique «select1» est l'élément de type «ElementFormSelect» qui liste les items non rattachés. |
<private> ElementFormSelect |
select2
La propriété publique «select2» est l'élément de type «ElementFormSelect» qui liste les items rattachés. |
Object |
setStatut_parent
|
<private> Object |
setXmlDataMulti_Parent
La propriété privée «setXmlDataMulti_Parent» enrichit la méthode «setXmlDataMulti()» de la classe parent "DefaultXml" |
Object |
size
|
<private> Array_ObjectOption |
tabOptionNoSelected
La propriété privée «tabOptionNoSelected» est le tableau ne contenant que les options non rattachées. |
<private> Array_ObjectOption |
tabOptionSelected
La propriété privée «tabOptionSelected» est le tableau ne contenant que les options rattachées. |
<private> String |
width
La propriété privée «width» est la largeur en pixels de chaque liste, par défaut vaut 300px. |
Attributs hérités de la classeDefaultElementForm |
readonly, disabled, id, value, statut, reference, onChange, check, onblur, formParent, ongletParent, zoneData, urlAide, altAide, lienAide, urlAssist, altAssist, bulleInfo, posBulleInfo, displayStyle, emptyDisplayStyle, onMouseOut, onMouseOver, onMouseMove, onMouseMoveBoutonAide, divBind, onfocus
|
Sommaire des Constructeurs | |
ComposantRattachement
(<String_Obligatoire> id, <XMLObjectSauvegarde_Facultatif> xmlData, <t_ObjectOption_Facultatif> tabOption, <String_Facultatif> libelle, <String_Facultatif> libelle1, <String_Facultatif> libelle2, <int_Facultatif> size, <String_Facultatif> width, <String_Facultatif> multiple, <Boolean_Facultatif> statut, <int_Facultatif> tabindex, <Boolean_Facultatif> activetri)
Crée une instance de la classe ComposantRattachement. |
Sommaire des Méthodes | |
void
|
descendre()
La méthode publique «descendre()» fait descendre d'un cran l'élément sélectionné dans la liste de droite. |
void
|
detacher()
La méthode publique «detacher()» fait passer l'élément sélectionné de la liste de droite vers la liste de gauche. |
DomHtmlElement
|
droite()
La méthode publique «droite()» retourne l'élément HTML associé à l'attribut select2 : liste déroulante droite des items non rattachés. |
string
|
ecrireHiddenHtml()
La méthode publique «ecrireHiddenHtml()» génère les champs cachés associés au composant rattachement. |
string
|
ecrireHtml()
La méthode publique «ecrireHtml()» génère l'ensemble du code HTML relatif au composant rattachement. |
void
|
ecrireListe()
La méthode publique «ecrireListe()» régénère les 2 listes d'options à partir de tabOption. |
Object
|
extend_DefaultElementForm(<String_Facultatif> id, <String_Facultative> value, <ObjectOption_Facultatif> tabOption, <int_Facultatif> statut)
Crée une instance de la classe «DefaultElementForm». |
Object
|
extend_DefaultXml(<XMLObjectSauvegarde_Facultatif> xmlData, <boolean_Facultatif> multi)
Crée une instance de la classe DefaultXml. |
DomHtmlElement
|
gauche()
La méthode publique «gauche()» retourne l'élément HTML associé à l'attribut select1 : liste déroulante gauche des items non rattachés. |
DomHtmlElemet
|
getDomHtmlElement()
La méthode publique «getDomHtmlElement()» retourne un pointeur (issu du DOM HTML) sur l'élément HTML généré. |
Array_ObjectOption
|
getTabOption()
La méthode publique «getTabOption()» retourne le tableau d'options DefaultElementForm#tabOption tabOption mis à jour avec les options rattachées. |
Array_ObjectOption
|
getValues()
La méthode publique «getValues» renvoie le tableau (ObjectOption) des options sélectionnées. |
void
|
monter()
La méthode publique «monter()» fait monter d'un cran l'élément sélectionné dans la liste de droite. |
void
|
rattacher()
La méthode publique «rattacher()» fait passer l'élément sélectionné de la liste de gauche vers la liste de droite. |
void
|
setLargeurListeDroite(<String_Obligatoire> largeur)
Spécifique à la classe ComposantRattachement- La méthode publique «setLargeurColonneDroite» attribue la valeur passée en paramètre à l'attribut «width» de la liste de sélection située à droite du composant rattachement. |
void
|
setLargeurListeGauche(<String_Obligatoire> largeur)
Spécifique à la classe ComposantRattachement- La méthode publique «setLargeurColonneGauche» attribue la valeur passée en paramètre à l'attribut «width» de la liste de sélection située à gauche du composant rattachement. |
void
|
setStatut(<int_Obligatoire> newStatut)
La méthode publique «setStatut(newStatut, update)» initialise l'attribut statut avec une nouvelle valeur, renseigne les attributs readonly et disabled et regénère l'élément HTML associé si le paramètre update est vrai. |
void
|
setTabOption(<t_ObjectOption_Obligatoire> newTabOption)
La méthode publique «setTabOption(newTabOption)» met à jour le tableau d'option tabOption et actualise l'affichage. |
void
|
setTri(<Boolean_Facultatif> tri)
La méthode publique «setTri» permet d'activer le tri des éléments de la liste de droite. |
void
|
setValues(newTabOption)
La méthode publique «setValues» attribue de nouvelles options à l'élément puis regénère l'élément. |
<private> void
|
setXmlDataMulti(xmlData)
La méthode publique «setXmlData(xmlData)» associe de nouvelles données xml au composant Rattachement. |
Détail des Attributs |
<private> String activetri
<private> ElementFormButton bouton1
<private> ElementFormButton bouton2
<private> ElementFormButton bouton3
<private> ElementFormButton bouton4
<private> String libelle
<private> String libelle1
<private> String libelle2
<private> String multiple
<private> String opt
<private> ElementFormSelect select1
<private> ElementFormSelect select2
Object setStatut_parent
<private> Object setXmlDataMulti_Parent
Object size
<private> Array_ObjectOption tabOptionNoSelected
<private> Array_ObjectOption tabOptionSelected
<private> String width
Détail des Constructeurs |
ComposantRattachement(<String_Obligatoire> id, <XMLObjectSauvegarde_Facultatif> xmlData, <t_ObjectOption_Facultatif> tabOption, <String_Facultatif> libelle, <String_Facultatif> libelle1, <String_Facultatif> libelle2, <int_Facultatif> size, <String_Facultatif> width, <String_Facultatif> multiple, <Boolean_Facultatif> statut, <int_Facultatif> tabindex, <Boolean_Facultatif> activetri)
id - String_Obligatoire
: Id du composant.
xmlData - XMLObjectSauvegarde_Facultatif
: Données XML de type XMLObjectSauvegarde, que l'on souhaite associer à l'élément de formulaire pour renseigner les 2 listes d'options.
tabOption - t_ObjectOption_Facultatif
: Tableau contenant les options («ObjectOption») à faire figurer dans les listes, si xmlData n'est pas utilisé comme source.
libelle - String_Facultatif
: Libellé global du composant.
libelle1 - String_Facultatif
: Libellé de la liste des options non rattachées.
libelle2 - String_Facultatif
: Libellé de la liste des options rattachées.
size - int_Facultatif
: Hauteur en nombre de ligne des listes, par défaut vaut le nombre max d'options.
width - String_Facultatif
: Largeur en pixels de chaque liste, par défaut vaut 300px.
multiple - String_Facultatif
: Indique si les listes sont à sélection multiple, par défaut la sélection multiple est possible. Une valeur différente de la chaîne de caractère «multiple» interdit la sélection multiple.
statut - Boolean_Facultatif
: Statut de l'élément, «enable» par défaut.
tabindex - int_Facultatif
: Attribut html «tabindex».
activetri - Boolean_Facultatif
: Indique si l'on désire activer le tri sur les éléments de droites.
Détail des Méthodes |
void descendre()
Aucun -
void detacher()
Aucun -
DomHtmlElement droite()
newTabOpt - t_ObjectOption_Obligatoire
: Les nouvelles options et sélections de l'élément.
string ecrireHiddenHtml()
Aucun -
string ecrireHtml()
Aucun -
void ecrireListe()
Aucun -
Object extend_DefaultElementForm(<String_Facultatif> id, <String_Facultative> value, <ObjectOption_Facultatif> tabOption, <int_Facultatif> statut)
id - String_Facultatif
: «id» de l'élément. C'est l'identifiant de l'élément et aussi l'id de l'élément HTML correspondant.
value - String_Facultative
: «value» de l'élément. Utilisé pour un l'élément mono-value, il s'agit de la chaîne de caractère représentant la valeur de l'élément, correspond généralement à l'attribut HTML «value» du champ de formulaire.
tabOption - ObjectOption_Facultatif
: «tabOption» de l'élément. Utilisé pour un élément multi-values, il s'agit du tableau d'options (ObjectOption) nécessaire pour valoriser l'élément.
statut - int_Facultatif
: «statut» de l'élément pour DefaultElementForm, qui définit le type d'affichage de l'élément (ENABLED : normal, READONLY : non modifiable, DISABLED : grisé).
Object extend_DefaultXml(<XMLObjectSauvegarde_Facultatif> xmlData, <boolean_Facultatif> multi)
xmlData - XMLObjectSauvegarde_Facultatif
«xmlData» : représente les données XML associé à l'élément de formulaire.
multi - boolean_Facultatif
Booléen : indique s'il s'agit d'un élément mono (false) ou multi-values (true), voir attribut multi.
DomHtmlElement gauche()
newTabOpt - t_ObjectOption_Obligatoire
: Les nouvelles options et sélections de l'élément.
DomHtmlElemet getDomHtmlElement()
Aucun -
Array_ObjectOption getTabOption()
Aucun -
Array_ObjectOption getValues()
Aucun -
void monter()
Aucun -
void rattacher()
Aucun -
void setLargeurListeDroite(<String_Obligatoire> largeur)
largeur - String_Obligatoire
: largeur de la liste de droite.
void setLargeurListeGauche(<String_Obligatoire> largeur)
largeur - String_Obligatoire
: largeur de la liste de gauche.
void setStatut(<int_Obligatoire> newStatut)
newStatut - int_Obligatoire
Nouveau statut à appliquer à l'élément.
update - boolean_Facultatif
Booléen qui indique si le champ est à mettre à jour ou non.
void setTabOption(<t_ObjectOption_Obligatoire> newTabOption)
newTabOption - t_ObjectOption_Obligatoire
Nouveau tableau d'option
void setTri(<Boolean_Facultatif> tri)
tri - Boolean_Facultatif
: Indique si l'on désire activer le tri sur les éléments de droites.
void setValues(newTabOption)
newTabOpt - t_ObjectOption_Obligatoire
: les nouvelles options et sélections de l'élément.
<private> void setXmlDataMulti(xmlData)
newXmlData - XMLObjectSauvegarde_Obligatoire
L'attribut «xmlData» à renseigner pour ComposantRattachement.
|
Framework JavaScript ACube V2.10.0 | ||||||||
CLASSE PRECEDENTE CLASSE SUIVANTE | CADRES SANS CADRES | ||||||||
SOMMAIRE: ATTR | CONSTR | METH | DETAIL: ATTR | CONSTR | METH |