/**
* @projectDescription Projekt do zarządania akcjami
*
* @copyright 2007 Robert (nospor) Nodzewski
* @author Robert Nodzewski (nospor at gmail dot com)
* @license http://opensource.org/licenses/lgpl-license.php GNU Lesser General Public License
* @version 1.1
*/
/**
* Klasa do zarządzania okienkami akcji. Wszystkie jej metody powinny być wywoływane statycznie
*
* @example ActionsManager.nazwametody(); //dobrze
* var am = new ActionsManager();am.nazwametody();//źle
*
* @classDescription Klasa do zarządzania okienkami akcji
* @id ActionsManager
*/
function ActionsManager(){};
/**
* Inicjalizuje nowy obiekt akcji
*
* @param {Map} params Obiekt parametrów.
* @optionsFor params
* @option {String} guid (required) identyfikator obiektu. Na podstawie guid będą rozpoznawane okna. Jeśli utworzymy kilka okien o tym samym guid, będą one dzielić tego samego diva. Jeśli damy różne guid, każdka okcja utworzy własnego oddzielnego diva.
* Dla tego samego guid będzie można określić, czy pozwalamy by w trakcie trwania jednej akcji, mogła uruchomić się kolejna (parametr: allowRunRunning)
* @option {String} link (required) link pod jaki wysyłać żądanie
* @option {Boolean} closeLastOpened (optional:false) czy zamkykać ostatnio otwarte okno
* @option {Boolean} closeAfterSuccess (optional:false) czy zamykać okno gdy akcja się powiedzie. Dotyczy tylko wyników zwracanych jako xml
* @option {String} className (optional:'actionsManager') klasa głównego diva okna
* @option {String} title (optional:pusty) tytuł w nagłówku
* @option {String} titleRunning (optional:null) tytuł w nagłówku podczas trwania akcji. Jeśli podamy null, tytuł główny nie ulegnie zmianie.
* @option {Boolean} refresh (optional:true) czy ponownie wykonać akcję jeśli już istnieje
* @option {Boolean} toggle (optional:false) gdy klikamy na akcje i jest juz ona otwarta, to zamyka ją
* @option {Boolean} allowRunRunning (optional:false) czy pozwalać na uruchamianie trwających już akcji w obrębie tego samego guid
* @option {String} messagesAddingType (optional:'last') - w jakis sposób dodawać nowe wiadomości: first - na początku wiadomości, last - na końcu wiadomości
* @option {Map} params (optional:null) parametry akcji jakie mają być dodatkowo wysłane ajaxem, np: {'param1' : 'wartosc1', 'param2':'wartosc2'}
* @option {jQuery} attachParams - formularz, z którego załadować parametry (obiekt jQuery) (domyślnie null) (tylko dla jQuery)
* @option {String} method (optional:'post') metoda wysłania żądania
* @option {Boolean} clear (optional:true) czy czyścić zawartość okienka
* @option {String} type (optional:'xml') typ pobieranych danych: html, xml,inne. Można podać własne typy, należy wówczas dla
* każdego typu zdefiniować metodę AjaxAction.prototype.writeTYPE = function(obj){...}, gdzie "TYPE" to pisane z dużej litery
* określony przez was "type", a "obj" to obiekt, jaki zwraca ajax po wykonaniu akcji.
* @option {Function} beforeSetup (optional:null) callback (funkcja) jaka ma się wykonać przed inicjalizacją. Funkcja jako parametr dostaje "params". Jeśli funkcja zwróci false, nie dojdzie do inicjalizacji obiektu
* @option {Function} afterSetup (optional:null) callback (funkcja) jaka ma się wykonać po inicjalizacji. Funkcja jako parametr dostaje stworzony obiekt
* @option {Function} beforeRun (optional:null) callback (funkcja) jaka ma się wykonać przed uruchomieniem akci. Funkcja jako parametry dostaje obiekt akcji oraz parametry jego wywołania. Jeśli funkcja zwróci false, nie dojdzie do uruchomienia akcji
* @option {Function} afterRun (optional:null) callback (funkcja) jaka ma się wykonać po uruchomieniu akcji. Funkcja jako parametry dostaje obiekt ajaxa, obiekt akcji, parametry wywołania akcji oraz informację czy żądanie przebiegło pomyślnie
*
* @see AjaxAction
* @example
* function runAction(objLink){
* var obj = ActionsManager.setup({
* guid : 'basic',
* link : 'example.php?ex=basic', //link do akcji
* title : 'Przykładowa akcja', //główny tytuł okna
* titleRunning : 'Przykładowa akcja w toku...' //tytuł okna podczas trwania akcji
* });
* //Pobranie pozycji linka. Zmienna objLink jest obiektem DOM naszego wciśniętego linka
* var lPos = Mixed.getPosition(objLink);
* //ustawienie okienka pod linkiem
* obj.element.style.left = lPos.x + 'px';
* obj.element.style.top = lPos.y + 20 + 'px';
* }
* @desc Pierwszy banalny przykład. Odpalenie akcji, która coś tam robi. Ustawiamy okienko pod linkiem akcji.
* @html
* Kliknij tu by rozpocząć przykładową akcję
* @htmlex
* Kliknij tu by rozpocząć przykładową akcję
*
*
*
* @example function runPreviewAction(id, objLink){
* //id - id podglądu (może to być np. id rekordu)
* var obj = ActionsManager.setup({
* guid : 'preview'+id, //dzięki unikalnemu guid, pogląd dla danego rekordu będzie odbywał się w innym oknie
* link : 'linkdoakcji',
* closeLastOpened : true, //zamykamy ostatnio otwarte okno, byśmy naraz widzieli tylko jeden podgląd
* refresh : false, //jeśli dany podgląd już raz sie wykonał, ponowme otwarcie jego okna nie odświerzy go
* //(dla danego rekordu będzie tylko jedno żądanie na serwer)
* title : 'Podgląd',
* titleRunning : 'Pobieranie danych...',
* type : 'html', //spodziewamy się danych zwrotnych jako html
* params : {id : id} //wraz z żądaniem na serwer, wysyłamy id rekordu
* });
* //Pobranie pozycji linka. Zmienna objLink jest obiektem DOM naszego wciśniętego linka
* var lPos = Mixed.getPosition(objLink); //korzystamy z klasy Mixed
* //ustawienie okienka obok linku. obj jest obiektem naszego okna
* obj.element.style.left = lPos.x + 120 + 'px';
* obj.element.style.top = lPos.y + 'px';
* }
* @desc Typowa akcja podglądu. Może być wywoływana np. przy naciśnięciu liknu podglądu na gridzie
* @html Podgląd 1
* Podgląd 2
* Podgląd 3
* @htmlex
* Podgląd 1
* Podgląd 2
* Podgląd 3
*
*
* @example
* function runSharedAction(id, objLink){
* obj = ActionsManager.setup({
* guid : 'actionshared', //wszystkie akcje w tym samym oknie poprzez nadanie tego samego guid
* link : 'linkdoakcji',
* move : true, //dajemy możliwość przesuwania okienka
* resize : {minWidth: 200,minHeight:60}, //pozwalamy na zmiane rozmiarów okna i określamy minimalne rozmiary
* title : 'Akcja', //tytuł akcji
* titleRunning : 'Trwanie akcji...',
* allowRunRunning : false, //nie powalamy, by wykonywało się kilka akcji naraz
* params : {id : id} //przekazujemy razem z żądaniem id akcji (rekordu)
* });
* //Pobranie pozycji linka. Zmienna objLink jest obiektem DOM naszego wciśniętego linka
* lPos = Mixed.getPosition(objLink);
* //ustawienie okienka pod linkami
* obj.element.style.left = lPos.x + 'px';
* obj.element.style.top = lPos.y + 20 + 'px';
* }
* @desc Kilka akcji wykonywać się będzie w tym samym oknie. Nie pozwalamy by w trakcie trwania jednej akcji,
* wykonywała się druga. Jeśli uruchomicie jedną akcję, szybko kliknijcie na inną, zanim ta pierwsza się skończy.
* @html
* Akcja 1
* Akcja 2
* Akcja 3
* @htmlex
* Akcja 1
* Akcja 2
* Akcja 3
*
*
*
* @example
* function runRemoveAction(id, objLink){
* obj = ActionsManager.setup({
* guid : 'actionremove', //wszystkie akcje w tym samym oknie
* link : 'link do akcji',
* move : true,
* resize : {minWidth: 200,minHeight:60},
* center : true, //okno ustawimy w centrum
* title : 'Akcja usuwania',
* titleRunning : 'Usuwam...',
* closeAfterSuccess:true,//zamknij okno gdy akcja się powiedzie
* allowRunRunning : true, //powalamy, by wykonywało się kilka akcji naraz
* params : {id : id}, //przekazujemy razem z żądaniem id akcji (rekordu),
* objLink : objLink //przekazujemy nasz parametr (objekt linku), który później wykorzystamy
* });
* }
* @desc Kilka akcji usuwania wykonywać się będzie w tym samym oknie.
* Tym razem pozwalamy na uruchomienie jednoczesne kilku akcji. Dodatkowo, po pomyślnym zakończeniu akcji,
* usuniemy link, który wciśnięto by uruchomić akcję. Akcja 1 i 3 zakończą się pomyślnie (zostanie wówczas zamknięte okno),
* natomiast akcja 2 kończyć będzie się błędem. Po odświerzeniu strony linki znowu się pojawią,
* gdyż nie usuwam ich na stałe.
* @html
* Akcja 1
* Akcja 2
* Akcja 3
* @htmlex
* Akcja 1
* Akcja 2
* Akcja 3
*
*
* @memberOf ActionsManager
* @id setup
* @return {AjaxAction} Obiekt akcji
*/
ActionsManager.setup = function(params){
function pd(name, def) { if (typeof params[name] == "undefined") { params[name] = def; }; };
pd("closeLastOpened", false);
pd("closeAfterSuccess", false);
pd("className", 'actionsManager');
pd("title", '');
pd("titleRunning", null);
pd("params", null);
pd("attachParams", null);
pd("method", 'post');
pd("refresh", true);
pd("toggle", false);
pd("clear", true);
pd("allowRunRunning", false);
pd("type", 'xml');
pd("messagesAddingType", 'last');
if (!ActionsManager.beforeSetup(params)) return null;
if (typeof params.beforeSetup != 'undefined' && !params.beforeSetup(params)) return null;
if (typeof ActionsManager.objects[params.guid] == "undefined" || !ActionsManager.objects[params.guid]){
ActionsManager.objects[params.guid] = new AjaxAction(params);
ActionsManager.create(ActionsManager.objects[params.guid]);
ActionsManager.objects[params.guid].afterSetup();
if (typeof params.afterSetup != 'undefined') params.afterSetup(ActionsManager.objects[params.guid]);
ActionsManager.run(ActionsManager.objects[params.guid],params);
} else {
if (params.refresh){
canRun = ActionsManager.canRun(params);
if (canRun != true){
ActionsManager.objects[params.guid].afterSetup();
if (typeof params.afterSetup != 'undefined') params.afterSetup(ActionsManager.objects[params.guid]);
ActionsManager.runningErrorInfo(params, canRun);
}
else {
if (params.clear)
ActionsManager.objects[params.guid].clear();
ActionsManager.objects[params.guid].params = params;
ActionsManager.objects[params.guid].afterSetup();
if (typeof params.afterSetup != 'undefined') params.afterSetup(ActionsManager.objects[params.guid]);
ActionsManager.run(ActionsManager.objects[params.guid], params);
};
} else {
ActionsManager.objects[params.guid].afterSetup();
if (typeof params.afterSetup != 'undefined') params.afterSetup(ActionsManager.objects[params.guid]);
}
};
return ActionsManager.objects[params.guid];
};
/**
* Wgrywa pluginy
*
* @param {String} plugins Lista pluginów oddzielonych przecinkiem, np: dynamic,position
*/
ActionsManager.loadPlugins = function(plugins){
if (!plugins) return false;
var plugins = plugins.split(','),plugin,script;
var shead = document.getElementsByTagName("head")[0];
var pLength = plugins.length;
for(ilp=0;ilp0)
return Mixed.getText(text.item(0));
return null;
};
/**
* @classDescription Klasa akcji
* @param {object} params Obiekt z parametrami
* @constructor
*/
function AjaxAction(params){
this.params = params;
this.position = {};
this.objects = {};
this.running = false;
this.countRunning = 0;
};
/**
* Metoda wywoływana po inicjalizacji obiektu
*/
AjaxAction.prototype.afterSetup = function(){
if (this.params.toggle && this.element.style.display == 'block'){
ActionsManager.hide(this);
return true;
}
this.setZIndex();
ActionsManager.show(this);
ActionsManager.lastOpened = this;
};
/**
* Metoda wywoływana przed uruchomieniem akcji.
*
* @return {Boolean} jeśli zostanie zwrócony false, akcja się nie wykona
*/
AjaxAction.prototype.beforeRun = function(){
return true;
};
/**
* Metoda wywoływana po odebraniu wyniku akcji
*
* @param {Object} ajaxObj Obiekt wyniku
* @param {Object} params Parametry obiektu. Duplikowany jest ten parametr, gdyż może zdarzyć się sytuacja, gdzie this.params!=params
* @param {Boolean} resultOk czy pobrano poprawnie
*/
AjaxAction.prototype.afterRun = function(ajaxObj,params, resultOk){
if (resultOk)
this.write(ajaxObj, params);
this.countRunning--;
if (this.countRunning == 0){
this.showHideWait(false);
if (params.titleRunning != null)
this.setTitle(params.title);
if ((params.closeAfterSuccess || typeof params.closeAfterSuccess == 'number') && resultOk && this.getResult(ajaxObj) == '0'){
if (typeof params.closeAfterSuccess == 'number'){
setTimeout("ActionsManager.hide('"+params.guid+"')",params.closeAfterSuccess);
} else {
ActionsManager.hide(this);
}
}
};
this.running = false;
if (typeof params.afterRun != 'undefined') params.afterRun(ajaxObj, this, params, resultOk);
};
/**
* Ustawia tytuł okienka
*
* @param {String} title Tytuł do ustawienia
*/
AjaxAction.prototype.setTitle = function(title){
if (title == null) return true;
var tn = document.createTextNode(title);
if (this.objects.header.firstChild != this.objects.wait)
this.objects.header.replaceChild(tn, this.objects.header.firstChild);
else
this.objects.header.insertBefore(tn, this.objects.wait);
};
/**
* Ustawia dla danego obiektu zindex o jeden większy od ostatnio zmienianego
*/
AjaxAction.prototype.setZIndex = function(){
if (typeof ActionsManager.zindex == "undefined")
ActionsManager.zindex = 1000;
ActionsManager.zindex++;
this.element.style.zIndex = ActionsManager.zindex;
};
/**
* Pokazuje/ukrywa diva z ikoną czekania
*
* @param {Boolean} show Czy pokazać
*/
AjaxAction.prototype.showHideWait = function(show){
this.objects.wait.style.display = show ? 'block' : 'none';
};
/**
* Pobiera wynik akcji
*
* @param {Object} obj Obiekt ajaxa
* @param {Object} params Parametry obiektu. Duplikowany jest ten parametr, gdyż może zdarzyć się sytuacja, gdzie this.params!=params
* @return {Boolean}
*/
AjaxAction.prototype.write = function(obj, params){
eval('this.write'+this.params.type.toUpperCase()+'(obj, params);');
};
/**
* Pobiera wynik akcji jako XML
*
* @param {Object} obj Obiekt ajaxa
* @param {Object} params Parametry obiektu. Duplikowany jest ten parametr, gdyż może zdarzyć się sytuacja, gdzie this.params!=params
* @return {Boolean}
*/
AjaxAction.prototype.writeXML = function(obj, params){
var root = Mixed.getRoot(obj, 'actionsmanager');
if (!root) return false;
this.writeMessages(root, 'error', this.objects.errors);
this.writeMessages(root, 'message', this.objects.messages);
var content = root.getElementsByTagName('content');
if (content && content.length>0){
content = Mixed.getText(content.item(0));
if (content)
this.objects.content.innerHTML += content;
};
return true;
};
/**
* Pobiera wynik akcji jako HTML
*
* @param {Object} obj Obiekt ajaxa
* @param {Object} params Parametry obiektu. Duplikowany jest ten parametr, gdyż może zdarzyć się sytuacja, gdzie this.params!=params
* @return {Boolean}
*/
AjaxAction.prototype.writeHTML = function(obj, params){
if (!obj || !obj.responseText) return false;
this.objects.content.innerHTML += obj.responseText;
return true;
};
/**
* Pobiera rezultat akcji z roota.
* Należy wywoływać tylko wtedy, gdy spodziewamy się wyniku w postaci xml
*
* @param {Object} ajaxObj Obiekt jaki zwraca ajax
* @return {String, null}
* - 0 - akcja zakończona sukcesem
* - innystring - akcja zakończona niepowodzeniem. Może to być numer błędu lub komunikat błędu
* - null - zapewne niepoprawny xml
*/
AjaxAction.prototype.getResult = function(ajaxObj){
var grroot = Mixed.getRoot(ajaxObj, 'actionsmanager');
if (!grroot) return null;
return grroot.getAttribute('result');
};
/**
* Pobierze z xmla wiadomości/błędy
* @param {DOM} root Nasz root
* @param {String} type Typ wiadomośći (error, message)
* @param {DOM} divMessage Obiekt diva, do którego wpisać wiadomośći
*/
AjaxAction.prototype.writeMessages = function(root, type, divMessage){
var messages = root.getElementsByTagName(type);
if (messages && messages.length>0){
var messagesLength = messages.length, _msg;
if (!divMessage.firstChild)
Mixed.createElement('ul',divMessage);
for (i=0;i