====== Pxxo_Widget_Window ======

Ce widget permet de créer une fenêtre volante qui peut encapsuler du contenu externe (via une iframe). 

  * [[http://apps.pxxo.net/showcase/|Exemple d'utilisation en ligne]]
  * [[fr:install|Installer]]

^ Code | <code php>
$params = array();
$params['url'] = 'http://google.fr';
$params['oid'] = 'tata';
$params['visible'] = true;
$params['button'] = 'close';
$w = new Pxxo_Widget_Window($params);
</code> |
^ Rendu | <pxxo widget="Pxxo_Widget_Window">	 
	    <params>	 
	        <url>http://google.fr</url>	 
	        <oid>tata</oid>	 
	        <visible>true</visible>	 
	        <button>close</button>	 
	    </params> 	 
</pxxo> |







===== Paramètres =====

^ Nom ^ Type ^ Valeur par défaut ^ Description ^
| ''url'' |  String  |  null  | URL du contenu à encapsuler |
| ''width'' |  String  |  400  | Largeur de la fenêtre volante __en pixel__ (ne pas spécifier d'unité) |
| ''height'' |  String  |  300  | Hauteur de la fenêtre volante __en pixel__ par défaut la hauteur s'adapte au contenu (ne pas spécifier d'unité) |
| ''FlyboxTheme'' |  String  |  alphacube  | Thème à utiliser pour décorer le contenu ; valeurs possibles : ''alphacube'' et ''defaut'' | 
| ''label'' |  String  |  null  | Titre de la fenêtre volante |
| ''visible'' |  Boolean  |  true  | Si à true la fenêtre est visible lors de sa création, dans le cas contraire elle est cachée | 
| ''oid'' |  String  |  null  | Si ce paramètre n'est pas renseigner le ClassID du widget sera utilisé. Ce paramètre est utilisé pour un usage interne lié à la dynamique entre le php et le client via du javascript et/ou le protocole AJAX. |
| ''overflowX '' |  String  |  hidden  | comportement en overflow horizontal du contenu ; valeurs possibles : hidden => cache tout ce qui dépasse, scroll => met toujours la barre de scroll horizontale, auto => met si besoin une barre de scroll horizontale |
| ''overflowY '' |  String  |  auto  | comportement en overflow vertical du contenu ; valeurs possibles : hidden => cache tout ce qui dépasse, scroll => met toujours la barre de scroll verticale, auto => met si besoin une barre de scroll verticale |
| ''button'' |  Array  | array('param','minmax','close') | Tableau listant les boutons à afficher dans la barre de titre de la fenêtre volante ; valeurs possibles : 'param', 'minmax', 'close'. |
| ''modalMode'' |  Boolean  |  false  | Si à true, la fenêtre générée sera modale. | 
| ''draggable'' |  Boolean  |  null  | Si à false, la fenêtre restera fixe. Paramètre facultatif. | 
| ''alignMiddle'' |  Boolean  |  null  | Si à true positionne la fenêtre volante de manière centrée par rapport à la zone cliente du navigateur. Dans ce cas les autres éventuelles indications de positionnement seront ignorées. Paramètre facultatif. |

===== Exemples =====

Ci dessous vous trouverez deux exemples d'utilisation. 

__Exemple 1__ : 

Ici on génère sur une page web une fenêtre volante contenant la page de recherche 'Google', cette fenêtre est rendue visible ou cachée par des action sur des liens (on peut bien sûr utiliser d'autres actions et/ou sur d'autres éléments tel que par exemple des images).


//Dans un template quelconque ...//
<code html>
...
<!-- Affiche ou cache la fenêtre -->
<a href="#" onclick="Window_toggle('MonIdentifiant');return false;">[ Toggle Window ]</a><br/>

<!-- Affiche la fenêtre -->
<a href="#" onclick="Window_show('MonIdentifiant');return false;">[ Show Window ]</a><br/>

<!-- Cache la fenêtre -->
<a href="#" onclick="Window_hide('MonIdentifiant');return false;">[ Hide Window ]</a><br/>
...
</code>
//Dans le code php ...//
<code php>
...
require_once 'Pxxo/Widget/Window.php';

$p = array('oid'  => 'MonIdentifiant',
           'url'    => 'http://google.fr',
           'label'  => 'Google Search',
           'button' => array('minmax','close'),
           'visible'=> false,
);
$obj1 = new Pxxo_Widget_Window($p);

$obj1->main();
$obj1->dump();
...
</code>


__Exemple 2__ : 

Ici on génère sur une page web une fenêtre volante qui contiendra soit la page de recherche 'Yahoo', soit 'Google', soit 'Voila', cette fenêtre est rendue visible sur le survol des liens correspondant. La fenêtre se positionnera en fonction du lien survolé. 


//Dans un template quelconque ...//
<code html>
...
<!-- Yahoo -->
<a href="#" id="lien1" onmouseover="Window_setURL('MonIdentifiant','http://yahoo.fr');Window_Tooltip(this.id,'MonIdentifiant',0);return false;">
  [ Yahoo ]  
</a>
<br/><br/>
<!-- Voila -->
<a href="#" id="lien2" onmouseover="Window_setURL('MonIdentifiant','http://voila.fr');Window_Tooltip(this.id,'MonIdentifiant',0);return false;">
  [ Voila ]  
</a>
<br/><br/>
<!-- Google -->
<a href="#" id="lien3" onmouseover="Window_setURL('MonIdentifiant','http://google.fr');Window_Tooltip(this.id,'MonIdentifiant',0);return false;">
  [ Google ]  
</a>
...
</code>
//Dans le code php ...//
<code php>
...
require_once 'Pxxo/Widget/Window.php';

$p = array('oid'  => 'MonIdentifiant',
           'url'    => 'http://yahoo.fr',
           'visible'=> false,
);
$obj1 = new Pxxo_Widget_Window($p);

$obj1->main();
$obj1->dump();
...
</code>










===== Listes des fonctions javascripts à disposition =====

=== Window_toggle(p_oid) ===
Affiche ou cache la fenêtre volante selon son état.
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné  |

=== Window_toggleModal(p_oid) ===
Affiche ou cache la fenêtre volante modale selon son état. Cette fonction est à utilisée à la place de //Window_toggle(...)// pour l'usage de fenêtre modale. 
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné  |

=== Window_show(p_oid) ===
Affiche la fenêtre volante.
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné  |

=== Window_showModal(p_oid) ===
Affiche la fenêtre volante. Cette fonction est à utilisée à la place de //Window_show(...)// pour l'usage de fenêtre modale. 
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné  |

=== Window_hide(p_oid) ===
Cache la fenêtre volante.
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné  |

=== Window_hideModal(p_oid) ===
Cache la fenêtre volante. Cette fonction est à utilisée à la place de //Window_hide(...)// pour l'usage de fenêtre modale. 
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné  |

=== Window_setURL( p_oid, p_url ) ===
Permet de changer l'url vers laquelle le contenu de la flybox pointe.
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné |
| ''p_url'' |  String  | URL vers laquelle le contenu de la flybox doit pointer |

=== Window_getFrameID( p_oid ) ===
Renvoie le nom de l'id de la frame construite à partir de l'oid.
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné |

=== Window_Tooltip(p_idelemsrc, p_oid, p_coef) ===
Affiche la flybox en la positionnant par rapport à un élément et en cas de perte de focus la flybox est cachée.
^ Nom ^ Type ^ Description ^
| ''p_idelemsrc'' |  String  | id de l'élément qui fera office de référence pour le positionnement de la flybox |
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné |
| ''p_coef'' |  Integer  | nombre compris entre -1 et 1 qui permet de décaler la flybox par rapport aux coordonnées du coin supérieur gauche de l'élément p_idelemsrc |

=== Window_setPositionBy(p_idelemsrc, p_oid, p_coef) ===
Permet de changer la position de la flybox sur la page par rapport à un élément spécifié par son id (par exemple un lien).
^ Nom ^ Type ^ Description ^
| ''p_idelemsrc'' |  String  | id de l'élément qui fera office de référence pour le positionnement de la flybox |
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné |
| ''p_coef'' |  Integer  | nombre compris entre -1 et 1 qui permet de décaler la flybox par rapport aux coordonnées du coin supérieur gauche de l'élément p_idelemsrc |

=== Window_over_init( p_oid ) ===
Gestion de la souris : en cas de perte de focus la flybox est cachée.
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné |


=== Window_setTitle( p_oid, p_title ) ===
Change le nom de la fenêtre
^ Nom ^ Type ^ Description ^
| ''p_oid'' |  String  | Correspond à l'oid passé en paramètre du décorateur ou le ClassID si celui-ci n'est pas renseigné |
| ''p_title'' |  String  | Correspond au nouveau nom que l'on souhaite donner à la fenêtre |