Widget IFrame

Le widget IFrame est un widget spécial qui peut être utilisé pour intégrer une autre application. Ce widget crée un iframe HTML.

Le widget IFrame prend en charge les attributs suivants:
  • frameId -Chaîne. Identificateur de l'iframe.
  • frameSrc -Chaîne. Attribut src pour iframe qui correspond à l' URL de la page à charger.
    Remarque: Certains sites Web, par exemple, google ou yahoo, s'empêchent d'être intégrés dans un iFrame contenu dans une application différente. Par conséquent, veillez à ce que les sites Web nécessaires n'imposent pas de telles restrictions.
  • applyCSRF -Booléen. Indique si le jeton CSRF doit faire partie de l' URL pour iframe. La valeur par défaut est true.
  • qryParamsList -Tableau. Contient un tableau de paramètres de requête qui doivent faire partie de l' URL pour iframe. Chaque paramètre de requête est un objet JSON et contient les attributs suivants:
    • name -Chaîne. Nom du paramètre.
    • value -Chaîne. Valeur du paramètre.
  • frameClass -Chaîne. Utilisez la classe CSS pour le style iframe. La valeur par défaut est scIFrame.
  • frameScrolling -Chaîne. Définit l'attribut de défilement pour iframe. Pour activer le défilement dans iframe, définissez la valeur de cet attribut sur yes. Par défaut, la valeur est définie sur no. La valeur auto est également disponible.
  • frameborder -Nombre. Indique si une bordure doit être affichée pour iframe. Les valeurs admises sont 0 et 1. La valeur par défaut est 0.

Vous pouvez ajouter un widget IFrame dans votre application de l'une des manières suivantes:

  • Déclaratif-Créez un élément HTML dans le fichier <Screen>.html comme indiqué dans l'exemple de code suivant.
    <div data-dojo-type="sc/plat/dojo/widgets/IFrame" data-dojo-props=" uId: 'customiframe', frameId: 'sampleId', frameSrc: '<provide your application URL here>',
 applyCSRF:true,frameScrolling: 'yes' ">
</div>
  • A l'aide d'un programme-Utilisez l'utilitaire sc.plat.dojo.utils.WidgetUtils.createIframeWidget JavaScript . Pour plus d'informations sur la méthode de widget createIframeWidget , voir la documentation JavaScript .
    • Arguments
      • Screen -Instance d'écran dans laquelle le widget doit être créé.
      • uId -ID uId du nouveau widget à créer. Si vous indiquez la valeur null, l'ID uId généré automatiquement est renvoyé.
      • configObj -Objet JSON qui contient tous les attributs tels que frameId, frameSrc, applyCSRF, etc. requis pour créer un IFrame. Le code suivant explique la structure de l'objet JSON:
        var iframeUId = _scWidgetUtils.createIframeWidget(this, null, {"IFrame": {frameId: 'pqr',frameSrc: 
'<provide your application URL here>', applyCSRF: true, frameScrolling: 'yes' }	});
      • Valeur de retour-L'ID uId du widget nouvellement créé est renvoyé, qui est identique à widgetUId.

    Pour placer le widget créé à l'écran, utilisez la méthode de widget placeAt fournie par Dojo.

Mettre à jour l'application chargée dans le widget IFrame

Utilisez le widget IFrame que vous avez créé pour charger une application distincte ou recharger une application existante avec des paramètres différents à l'aide de l'utilitaire sc.plat.dojo.utils.WidgetUtils.setIFrameSrc JavaScript .

Arguments :
  • screenInstance -Instance d'écran dans laquelle le widget IFrame est présent.
  • iframeUId -ID uId du widget IFrame.
  • src -Adresse URL de l'application à charger.
  • qryParamsList -Facultatif. Contient un tableau de paramètres de requête qui doivent faire partie de l' URL pour iframe. Chaque paramètre de requête est un objet JSON et contient les attributs suivants:
    • name -Chaîne. Nom du paramètre.
    • value -Chaîne. Valeur du paramètre.