FR 5. Méthodes du composant

New AJUI_BreadCrumb ( { template_param } ) -> instance

Cette méthode retourne une variable objet (breadcrump) qui représente une instance d’AJUI_BreadCrumb. Elle contient l’ensemble des propriétés et leurs valeurs par défaut ainsi que les formules (fonctions membres) pour les manipuler.

Il est possible de lui passer en paramètre un objet (template_param) afin d’importer un template existant (fichier JSON). Propriétés attendues de l'objet (template_param) passé en paramètre :

• templateName : Correspond au nom du fichier JSON à importer (template). Si le fichier n’est pas trouvé, la méthode retournera une nouvelle instance d’AJUI_Breadcrumb.
• templatePath (optionnel) : Vous pouvez préciser un chemin pour récupérer le fichier sinon, le composant cherchera dans le dossier par défaut se trouvant dans les ressources de la base hôte (…/Ressources/AJUI_BreadCrumb_Templates/). Vous pouvez utiliser "#" pour désigner le dossier de ressources de 4D dans votre chemin.

C_OBJECT($template_obj;$bc)

$templateName:="MybreadcrumbTemplate.json"
$templatePath:=Get 4D folder (Current resources folder)
$templatePath:=$templatePath+"my_Templates_Folder"+folder separator

$template_obj:=New object ()
$template_obj.templateName:=$templateName
$template_obj.templatePath:=$templatePath
$bc:=New AJUI_BreadCrumb ($template_obj)

AJUI_Breadcrumb ( { template_param } ) -> classe

Cette méthode remplace New AJUI_BreadCrumb à partir de la V18R3, elle permet de retourner la classe Breadcrumb. Les fonctions de la classe sont identiques aux formules.

Il est possible de lui passer en paramètre un objet (template_param) afin d’importer un template existant (fichier JSON). Propriétés attendues de l'objet (template_param) passé en paramètre :

• templateName : Correspond au nom du fichier JSON à importer (template). Si le fichier n’est pas trouvé, la méthode retournera une nouvelle instance d’AJUI_Breadcrumb.
• templatePath (optionnel) : Vous pouvez préciser un chemin pour récupérer le fichier sinon, le composant cherchera dans le dossier par défaut se trouvant dans les ressources de la base hôte (…/Ressources/AJUI_BreadCrumb_Templates/). Vous pouvez utiliser "#" pour désigner le dossier de ressources de 4D dans votre chemin.

C_OBJECT($template_obj;$bc)

$templateName:="MybreadcrumbTemplate.json"
$templatePath:=Get 4D folder (Current resources folder)
$templatePath:=$templatePath+"my_Templates_Folder"+folder separator

$template_obj:=New object ()
$template_obj.templateName:=$templateName
$template_obj.templatePath:=$templatePath
$bc:=AJUI_Breadcrumb.new() ($template_obj)

AJUI_BC_info -> version

Cette méthode retourne une chaîne de caractère représentant le numéro de version du composant.

AJUI_BC_BC_loadTemplates ( { folder_path} ) -> templates_col

Méthode utilitaire permettant de récupérer dans une collection (templates_col), l’ensemble des fichiers JSON situé dans un dossier. Vous pouvez passer en paramètre le chemin du dossier contenant les templates. Si ce n’est pas le cas, la méthode cherchera dans chemin par défaut (…/Ressources/AJUI_BreadCrumb_Templates/).