package Frames~FrameManager()

Classe principale qui gère la gestion des frames. Contient une liste de fenêtres.

Members

readonly $layout_frames :external:jQuery

Raccourcis vers layout-frames

package _attaches :Object:.<string:, function()>

Liste des attaches. Les attaches sont des actions supplémentaires qui peuvent "parasiter" des actions du changement de frame.

package _manual_multi_frame_enabled :string

Si le mutliframe gérer par l'utilisateur est actif ou non

package _modes :Object:.<string:, function()>

Liste des modes de fenêtrage

package _selected_window :module:Frames~Window

Fenêtre en cours

package _windows :module:BaseStorage~BaseStorage:.<module:Frames~Window:>

Liste des fenêtres

readonly currentTask :string

Tâche en cours

static, readonly Helper :module:Frames~FrameManagerWrapperHelper

Methods

generator Symbol.iterator()

package _generate_menu($element) → {any}

Génère le menu multifenêtre
Parameters:
Name Type Description
$element external:jQuery
Returns:
any

add_buttons_actions()

Ajoute les actions sur les boutons de navigation principale

add_mode(name, callback) → {module:Frames~FrameManager}

Ajoute un mode.
Parameters:
Name Type Description
name string Nom du mode
callback function Callback du mode
Returns:
module:Frames~FrameManager - Chaînage

add_tag(tag)

Ajout un tag aux layout-frames. Les tags ont le format `data-tag-${tag}`.
Parameters:
Name Type Description
tag string

attach(action, callback) → {module:Frames~Window}

Attache une action
Parameters:
Name Type Description
action string Nom de l'action
callback function
Returns:
module:Frames~Window - Chaînage

button_action(e)

Parameters:
Name Type Description
e Event

call_attach(action, …args) → {*}

Appèle une action
Parameters:
Name Type Attributes Description
action string Action à appeller
args any <repeatable>
Returns:
*

close_except_selected() → {module:Frames~Window}

Supprime toute les fenêtres sauf celle qui est séléctionnée
Returns:
module:Frames~Window - Chaînage

close_windows_to_remove_on_change() → {module:Frames~Window}

Supprime toute les fenêtres aux changement de frame
Returns:
module:Frames~Window - Chaînage

create_window(uid, $parentopt, nullable) → {Object}

Créer une fenêtre
Parameters:
Name Type Attributes Default Description
uid string | number Id de la fenêtre
$parent external:jQuery <optional>
<nullable>
null Element parent
Returns:
Object

current_frame() → {module:Frames~FrameData}

Récupère la frame courante

delete_window(id) → {module:Frames~FrameManager}

Supprime une fenâtre
Parameters:
Name Type Description
id number id de la fenêtre à supprimer
Returns:
module:Frames~FrameManager - Chaînage

detach(action) → {module:Frames~Window}

Supprime une action
Parameters:
Name Type Description
action string Action à supprimer
Returns:
module:Frames~Window - Chaînage

disable_manual_multiframe() → {module:Frames~Window}

Désactive le fait qu'un utilisateur puisse lancer plusieurs fenêtres
Returns:
module:Frames~Window - Chaînage

enable_manual_multiframe() → {module:Frames~Window}

Active le fait qu'un utilisateur puisse lancer plusieurs fenêtres
Returns:
module:Frames~Window - Chaînage

get_frame(tasknullable) → {external:jQuery}

Récupère la frame courante
Parameters:
Name Type Attributes Default Description
task string <nullable>
null
Returns:
external:jQuery

get_window() → {module:Frames~Window}

Récupère la fenêtre courante

has_frame(task) → {boolean}

Vérifie si une frame de la fenêtre séléctionnée éxiste
Parameters:
Name Type Description
task string
Returns:
boolean

has_multiples_windows() → {boolean}

Vérifie si il y a plusieurs fenêtres
Returns:
boolean

hide_except_selected() → {module:Frames~Window}

Cache toute les fenêtres sauf celle qui est séléctionnée
Returns:
module:Frames~Window - Chaînage

manual_multi_frame_enabled() → {boolean}

Vérifie le fait qu'un utilisateur puisse lancer plusieurs fenêtres
Returns:
boolean

async open_another_window(task, argsopt, nullable) → {Promise:.<void:>}

Ouvre une nouvelle fenêtre
Parameters:
Name Type Attributes Default Description
task string
args Object:.<string:, string:> <optional>
<nullable>
null
Returns:
Promise:.<void:>

remove_tag(tag)

Supprime un tag aux layout-frames
Parameters:
Name Type Description
tag string

select_window(id) → {module:Frames~FrameManager}

Sélectionne une fenêtre
Parameters:
Name Type Description
id number Id de la fenêtre
Returns:
module:Frames~FrameManager - Chaînage

start_custom_multi_frame() → {module:Frames~Window}

Démarre un multi-fenêtre custom. CAD que la barre au dessus de la fenêtre ne va pas s'afficher.
Returns:
module:Frames~Window - Chaînage

start_mode(name, …args) → {any}

Démarre un mode
Parameters:
Name Type Attributes Description
name string Nom du mode
args any <repeatable>
Returns:
any

stop_custom_multi_frame() → {module:Frames~Window}

Arrête un multi-fenêtre custom.
Returns:
module:Frames~Window - Chaînage

async switch_frame(task, param1opt) → {Promise}

Change de frame. Soit une fenêtre précise soit celle en cours. Liste des attaches : - switch_frame (task:string, changepage:boolean, args:?Object, actions:string[], wind:?number) => ?string Liste des triggers : - switch_frame ({task:string, changepage:boolean, args:?Object, actions:string[], wind:?number}) => ?boolean - switch_frame.after ({task:string, changepage:boolean, args:?Object, actions:string[], wind:?number}) => void
Parameters:
Name Type Attributes Default Description
task string Tâche à afficher
param1 Object <optional>
{}
Properties
Name Type Attributes Default Description
changepage boolean <optional>
true Si on charge la frame en arrière plan ou non
args Object:.<string:, string:> <optional>
<nullable>
null Arguments - sauf la tâche - de la l'url à ajouter à la source de la frame
actions Array:.<string:> <optional>
[] Mot clé pouvant être utiliser dans les différents callbacks
wind number <optional>
<nullable>
null Id de la fenêtre à changer. Si null, celle en cours.
Returns:
Promise

unselect_all() → {module:Frames~FrameManager}

Désélectionne toute les fenêtres
Returns:
module:Frames~FrameManager - Chaînage