new IndexWorkspace()
Constructeur de la classe.
Doit être appeler par le php.
Extends
Members
-
package _container :boolean
-
Gestion du redimentionnement
-
package _listener :MelEventManager
-
- Overrides:
-
package rc_data :Object
-
- Overrides:
Methods
-
package _container_resize()
-
Met la bonne taille aux div qui contiennent les espaces.
-
package _event_button_pressed(mode, e)
-
Appeller par les boutons de changement de mode de visualisation.
Parameters:
Name Type Description modemodule:Workspace/Index~EVisuMode Nouveau mode de visualisation eEvent Evènement -
package _event_search_reset()
-
Appeller par le bouton de réinitialisation de la recherche. Vide la recherche puis focus celle-ci.
-
async, package _get_count_max(searchValue) → {Promise:.<number:>}
-
Récupère le nombre de page max pour le scroll container
Parameters:
Name Type Description searchValuestring Valeur de la recherche -
async, package _init_buttons_data() → {Promise:.<void:>}
-
Initialise les boutons
-
package _mine_search(mainTabs, searchValue)
-
Recherche dans les espaces de l'utilisateur
Parameters:
Name Type Description mainTabsTabsElement Element principal searchValuestring Valeur de la recherche -
package _on_resize()
-
Appeller lorsque la fenêtre est redimensionnée
-
protected _p_$disable($item) → {external:jQuery}
-
Désactive un élément et le retourne
Parameters:
Name Type Description $itemexternal:jQuery Elément à désactiver Returns:
external:jQuery -
protected _p_$enable($item) → {external:jQuery}
-
Active un élément et le retourne
Parameters:
Name Type Description $itemexternal:jQuery Elément à désactiver Returns:
external:jQuery -
async, package _public_search(searchValue) → {Promise:.<void:>}
-
Recherche dans les espaces publiques
Parameters:
Name Type Description searchValuestring Valeur de la recherche -
async, package _public_search_data(searchValue, pageopt) → {Promise:.<string:>}
-
Récupère les données, par page, d'un résultat de recherche.
Parameters:
Name Type Attributes Default Description searchValuestring Valeur de la recherche pagenumber <optional>
1 Page que l'on souhaite charger Throws:
-
Si l'appèle au serveur crash
- Type
- Error
-
-
package _reorder()
-
Réordonne les cards.
/!\Uniquement pour les espaces de l'utilisateur. -
async, package _search() → {Promise:.<void:>}
-
Est appeller par la recherche
-
package _search_busy()
-
Désactive la recherche et le bouton de réinitialisement de la recherche
-
package _search_not_busy()
-
Active la recherche et le bouton de réinitialisement de la recherche
-
package _set_blocks_listeners()
-
Assigne le listener lié au changement de favoris aux bnum-workspace-block-item
-
package _set_listeners()
-
Assigne les listeners
-
protected add_event_listener(key, callback, param2)
-
Ajoute un écouteur qui pourra être appelé plus tard.
Parameters:
Name Type Description keystring Clé qui permettra d'appeller l'écouteur callbackfunction Fonction qui sera appelée param2Object Si on doit récupérer rcmail sur frame principale ou non Properties
Name Type Attributes Description callback_keystring <nullable>
Clé du callback conditionboolean Si on doit éxécuter ou non le listener - Overrides:
-
async, protected change_frame(frame, param1) → {Promise:.<void:>}
-
Change de page
Parameters:
- Overrides:
- Deprecated:
- Utilisez plutôt switch_frame
-
protected cookie_get(key) → {module:Cookies.Cookie}
-
Récupère un cookie
Parameters:
Name Type Description keystring Indentifiant de la donnée Returns:
module:Cookies.Cookie- Overrides:
-
protected cookie_remove(key) → {module:Cookies.Cookie}
-
Supprime un cookie
Parameters:
Name Type Description keystring Indentifiant du cookie à supprimer Returns:
module:Cookies.Cookie - Cookie supprimer- Overrides:
-
protected cookie_set(key, name, expire) → {module:Cookies.Cookie}
-
Insert un cookie
Parameters:
Name Type Default Description keystring Clé qui permet d'identifier la données mise en cookie namestring Donnée à mettre en cookie expireDate | false false Date d'expiration, false pour aucune Returns:
module:Cookies.Cookie - Cookie créer- Overrides:
-
protected copy_to_clipboard(elementToCopy, optionsopt)
-
Copie un texte dans le press(papier)
Parameters:
Name Type Attributes Default Description elementToCopystring Texte à mettre dans le presse papier optionsObject <optional>
{} Properties
Name Type Attributes Default Description textstring <optional>
<nullable>
null Texte à afficher lorsque la copie a été effectuée - Overrides:
-
async create_promise(callback, …args) → {module:BnumPromise~BnumPromise:.<T:>}
-
(async) Créer une promesse "Mel" qui contient des fonctionnalités en plus
Parameters:
Name Type Attributes Description callbackargsany <repeatable>
Arguments du callback Returns:
module:BnumPromise~BnumPromise:.<T:>- Overrides:
-
protected generate_loader(id, absoluteCenterednon-null) → {mel_html}
-
Génère un loader du bnum
Parameters:
Name Type Default Description idstring id du loader absoluteCenteredboolean true Centrer verticalement et horizontalement ? Returns:
mel_html- Overrides:
-
protected get_custom_rules() → {Mel_CSS_Style_Sheet}
-
Récupère un objet Mel_CSS_Style_Sheet pour ajouter du css custom
Returns:
Mel_CSS_Style_Sheet- Overrides:
-
protected get_env(key) → nullable {any}
-
Récupère une variable d'environnement de roundcube
Parameters:
Name Type Description keystring Nom de la variable Returns:
any- Overrides:
-
protected get_skin() → {Mel_Elastic}
-
Récupère l'objet UI de la skin elastic
Returns:
Mel_Elastic- Overrides:
-
protected gettext(key_text, pluginnon-null) → {string}
-
Récupère une clé sous forme de texte.
Parameters:
Name Type Description key_textstring Clé pluginstring Plugin d'où provient le texte traduit Returns:
string- Overrides:
-
protected have_frame(frame) → {boolean}
-
Vérifie si une frame est déjà chargée ou non
Parameters:
Name Type Description framestring Nom de la frame Returns:
boolean- Overrides:
-
protected http_call(options) → {module:BnumPromise~BnumPromise:.<Y:>}
-
Effectue un appel ajax avec les options spécifiées.
Parameters:
Name Type Attributes Default Description optionsObject Les options pour l'appel HTTP. Properties
Name Type Description urlstring L'URL à appeler. options.paramsObject <optional>
null Les paramètres à envoyer dans la requête. options.typestring | BnumPromise.Ajax.EAjaxMethod <optional>
BnumPromise.Ajax.EAjaxMethod.post Le type de requête HTTP à effectuer. Returns:
module:BnumPromise~BnumPromise:.<Y:>- Overrides:
-
protected http_internal_call(options) → {module:BnumPromise~BnumPromise:.<Y:>}
-
Effectue un appel ajax vers les serveurs de l'application
Parameters:
Name Type Attributes Default Description optionsObject Les options pour l'appel HTTP. Properties
Name Type Description taskstring Tache actionstring Action options.paramsObject <optional>
null Les paramètres à envoyer dans la requête. options.typestring | BnumPromise.Ajax.EAjaxMethod <optional>
BnumPromise.Ajax.EAjaxMethod.post Le type de requête HTTP à effectuer. Returns:
module:BnumPromise~BnumPromise:.<Y:>- Overrides:
-
protected http_internal_get(options) → {module:BnumPromise~BnumPromise:.<Y:>}
-
Effectue un appel ajax GET vers les serveurs de l'application
Parameters:
Name Type Attributes Default Description optionsObject Les options pour l'appel HTTP. Properties
Name Type Description taskstring Tache actionstring Action options.paramsObject <optional>
null Les paramètres à envoyer dans la requête. Returns:
module:BnumPromise~BnumPromise:.<Y:>- Overrides:
-
protected http_internal_post(options) → {module:BnumPromise~BnumPromise:.<Y:>}
-
Effectue un appel ajax POST vers les serveurs de l'application
Parameters:
Name Type Attributes Default Description optionsObject Les options pour l'appel HTTP. Properties
Name Type Description taskstring Tache actionstring Action options.paramsObject <optional>
null Les paramètres à envoyer dans la requête. Returns:
module:BnumPromise~BnumPromise:.<Y:>- Overrides:
-
protected isNullOrUndefined(itemnullable) → {boolean}
-
Renvoie vrai si la variable vaut `null` ou `undefined`.
Parameters:
Name Type Attributes Description itemany <nullable>
Variable à tester Returns:
boolean- Overrides:
-
protected load(key, default_valuenullable) → nullable {any}
-
Charge des données dans le stockage local
Parameters:
Name Type Attributes Default Description keystring Clé qui permet de retrouver les données default_valueany <nullable>
null Valeur par défaut si la donnée n'éxiste pas Returns:
any- Overrides:
-
abstract main(…args)
-
Parameters:
Name Type Attributes Description argsany <repeatable>
Arguments de la fonction - Overrides:
-
protected on_frame_loaded(callback, options)
-
Action à faire lorsqu'une frame est chargée
Parameters:
Name Type Description callbackfunction Function à éffectuer optionsObject Options de la fonction Properties
Name Type Attributes Description framestring <nullable>
any pour toute n'importe quelle frame, sinon mettre le nom de la frame conditionfunction <nullable>
Condition custom pour charger la frame - Overrides:
-
protected on_frame_refresh(callback, frame, param2)
-
Ajoute une action à faire lorsqu'une frame est mise à jours
Parameters:
Name Type Attributes Description callbackfunction Callback a=à appelé au refresh framestring Nom de la frame param2Object options.callback_keystring <nullable>
clé qui permet de supprimer/remettre la fonction au refresh d'une frame - Overrides:
-
protected on_refresh(callback, options)
-
Ajoute une action à faire lors du refresh du bnum
Parameters:
Name Type Description callbackfunction Fonction à appeller optionsObject Options de la fonction Properties
Name Type Attributes Description callback_keystring <nullable>
clé qui permet de supprimer/remettre la fonction au refresh d'une frame - Overrides:
-
protected rcmail(top) → {rcube_webmail}
-
Récupère "rcmail" | les fonctions utiles à roundcube
Parameters:
Name Type Default Description topboolean false Si on doit récupérer rcmail sur frame principale ou non Returns:
rcube_webmail- Overrides:
-
protected save(key, contents) → {MelObject}
-
Sauvegarde des données dans le stockage local
Parameters:
Name Type Description keystring Clé qui permettra de retrouver les données sauvegarder contents* Données qui seront sauvegarder Returns:
MelObject - Chaînage- Overrides:
-
protected select(selector) → {external:jQuery}
-
Séléctionne un document dom au format jquery
Parameters:
Name Type Description selectorstring Selecteur au format jquery Returns:
external:jQuery- Overrides:
-
protected select_frame(frame) → {external:jQuery}
-
Selectionne une frame
Parameters:
Name Type Description framestring Nom de la frame Returns:
external:jQuery- Overrides:
-
generator, protected select_frame_except(…frames) → {Generator:.<Node:>}
-
Selectionne toutes les frames qui ne sont pas parmis les frames définie en arguments
Parameters:
Name Type Attributes Description framesstring <repeatable>
Frames à écarter - Overrides:
-
protected send_notification(notification)
-
Envoie une notification BNUM
Parameters:
Name Type Description notification* - Overrides:
-
async sleep(ms) → {BnumPromise:.<void:>}
-
(async) Attend x millisecondes
Parameters:
Name Type Description msnumber Temps en millisecondes - Overrides:
-
async switch_frame(task, options) → {Promise}
-
Change de frame
Parameters:
Name Type Description taskstring Nom de la tâche optionsObject Properties
Name Type Attributes Default Description changepageboolean <optional>
true Si l'on change de page ou si la frame reste caché pendant le chargement. argsObject:.<string:, *:> <optional>
<nullable>
null Options du changement de frame. Si la frame est déjà ouverte, force le changement d'url. Returns:
Promise- Overrides:
-
protected trigger_event(key, args) → {MelEventManager}
-
Trigger un écouteur
Parameters:
Name Type Description keystring Clé qui appelera tout les écouteurs lié à cette clé argsany Arguments qui sera donnée aux écouteurs Returns:
MelEventManager- Overrides:
-
protected unload(key)
-
Décharge une donnée dans le stockage local
Parameters:
Name Type Description keystring clé dans le stockage - Overrides:
-
protected url(task, param1, Autresnullable) → {string}
-
Récupère une url à partir d'une tâche et d'une action
Parameters:
Name Type Attributes Description taskstring Nom de la tâche param1Object action => Nom de l'action ('index' si non renseigné), params => Autres paramètres Properties
Name Type Description actionstring => Nom de l'action (index si non renseigné) AutresObject:.<string:, string:> <nullable>
paramètres Returns:
string- Overrides:
-
async wait_something(callback, optionsopt)
-
(async) Attend qu'une condtion soit valide
Parameters:
Name Type Attributes Default Description callbackoptionsObject <optional>
{} Properties
Name Type Attributes Default Description timeoutnumber <optional>
5 Au bout de combien de secondes la boucle s'arrête Returns:
- Overrides: