Joget DX Beta Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Page tree
Skip to end of metadata
Go to start of metadata

AssignmentManager

  • URL:/jw/js/json/util.js
  • 自动包含在所有用户视图页面中。
  • 用于处理登录用户的分配。

completeAssignment(baseUrl, activityId, redirect)

描述

用特定流程实例ID和活动实例ID完成分配

参数

    • baseUrl - Joget Workflow的基本URL,例如 'http://localhost/jw'
    • activityId - 要完成的分配的活动实例标识
    • redirect - 分配完成后重定向到的URL(可选)

示例代码  

 AssignmentManager.completeAssignment('http://localhost/jw', '1_1_activity', 'http://localhost/completed.jsp');

completeAssignmentWithVariable(baseUrl, activityId, variableData, redirect)

描述

使用特定流程实例标识和活动实例标识完成分配,并带有用于设置工作流程变量的选项

参数

    • baseUrl - Joget Workflow的基本URL,例如   'http://localhost/jw'
    • activityId - 要完成的分配的活动实例标识
    • variableData - 要设置的变量。所有变量名都必须以“var_”作为前缀
    • redirect - 分配完成后重定向到的URL(可选)

示例代码  

AssignmentManager.completeAssignmentWithVariable('http://localhost/jw', '1_1_activity', 'var_status=new&var_id=123', 'http://localhost/completed.jsp');

getCurrentUsername(baseUrl, callback)

描述

获取Joget Workflow中当前登录的用户名

参数

    • baseUrl - Joget Workflow的基本URL,例如 'http://localhost/jw'
    • callback -  成功调用后的回调函数

示例代码  

var callback = {
    success : function(response){
        //response.username
        if(response.username != "roleAnonymous"){
            console.log("Username is " + response.username);
        }else{
            console.log("User is anonymous");
        }
    }
};
AssignmentManager.getCurrentUsername('http://localhost/jw', callback);

login(baseUrl, username, password, callback)

描述

获取Joget Workflow中当前登录的用户名(正常登录)

参数

    • baseUrl - Joget Workflow的基本URL,例如 'http://localhost/jw'
    • username - 用户名
    • password - 密码
    • callback - 成功调用后的回调函数

示例代码  

var callback = {
    success : function(response){
        //response.username && response.isAdmin
        if(response.username != "roleAnonymous"){
            console.log("username (" + response.username + ") is " + ((response.isAdmin !== undefined && response.isAdmin === "true")?"admin":"not an admin"));
        }else{
            console.log("Fail to login user!");
        }
    }
};
AssignmentManager.login('http://localhost/jw', 'admin', 'admin', callback);

loginWithHash(baseUrl, username, hash, callback)

描述

获取Joget Workflow中当前登录的用户名 (使用Hash 密码)

参数

示例代码  

var callback = {
    success : function(response){
        //response.username && response.isAdmin
        if(response.username != "roleAnonymous"){
            console.log("username (" + response.username + ") is " + ((response.isAdmin !== undefined && response.isAdmin === "true")?"admin":"not an admin"));
        }else{
            console.log("Fail to login user!");
        }
    }
};
AssignmentManager.loginWithHash('http://localhost/jw', 'admin', '14ACD782DCFEB2BCDE2B271CCD559477', callback);

logout(baseUrl)

描述

登出

参数

示例代码  

AssignmentManager.logout('http://localhost/jw');

withdrawAssignment(baseUrl, activityId)

描述

撤销具有特定活动实例ID的分配

已弃用  自v3接受和撤销分配的概念被删除。 

参数

    • baseUrl - Joget Workflow的基本URL,例如 'http://localhost/jw'
    • activityId - 要撤销的分配的活动实例ID

示例代码  

AssignmentManager.withdrawAssignment('http://localhost/jw', '1_1_activity');

ConnectionManager

  • URL : /jw/js/json/util.js
  • 自动包含在所有用户视图页面中。
  • AJAX方便的调用方法

ajaxJsonp(url, callback, params)

描述

用JSONP启动Ajax调用

参数

    • url - 启动Ajax调用的URL
    • callback - 成功调用后的回调函数(可选)
    • params - 调用参数(可选)

示例代码 

var callback = {
    success : function(response){
        //do something
    }
};
ConnectionManager.ajaxJsonp('http://localhost/test', callback, 'id=4&name=test');

get(url, callback, params, xss)

描述

启动Ajax GET 到特定的URL

参数

    • url - URL for GET action
    • callback - 成功调用后的回调函数(可选)
    • params - 调用参数(可选)
    • xss - 当URL是跨域时使用(可选)

示例代码 

var callback = {
    success : function(response){
        //do something
    }
};
ConnectionManager.get('http://localhost/test', callback, 'id=6&name=test', false);

post(url, callback, params)

描述

启动Ajax POST到特定的URL

参数

    • url - URL for GET action
    • callback - 成功调用后的回调函数(可选)
    • params - 调用参数(可选)

示例代码 

var callback = {
    success : function(response){
        //do something
    }
};
ConnectionManager.post('http://localhost/test', callback, 'id=6&name=test');

FormUtil

  • URL : /jw/js/json/formUtil.js
  • 自动包含在使用表单的页面中
  • 方便与表单域交互的方法

getField(fieldId)

描述

用于获取表单字段的字段对象

参数

    • fieldId - id of a form field

示例代码 

var field = FormUtil.getField("field1");
$(field).val("test"); //set value

getFieldsAsUrlQueryString(fields)

描述

用于生成字段值作为url查询参数字符串

参数

    • fields - 一个数组包含带有“field”,“param”和“defaultValue”属性的对象。
      - field : 表单字段的ID 
      - param : 要使用的参数名称
      - defaultValue : 当字段返回空值时使用的值(可选)

示例代码 

var fields = [
    {"field":"field1", "param":"p_field1"},
    {"field":"field2", "param":"p_field2"},
    {"field":"field3", "param":"p_field3", "defaultValue":"default value"},
];
 
var queryString = FormUtil.getFieldsAsUrlQueryString(fields);
console.log(queryString); //p_field1=Field1%20value&p_field2=Field2%20value;Field2%20second%20value&p_field3=default%20value

getGridCells(cellFieldId)

描述

用于获取grid字段每一行的单元格对象

参数

    • cellFieldId - 网格字段ID和由点“.”分隔的单元格ID。例如: gridId.cellId.

示例代码 

var cells = FormUtil.getGridCells("gridId.field1");
$(cells).each(function(){
    //do something
});

getGridCellValues(cellFieldId)

描述

用于获取Grid字段每一行的单元格值并将其返回到数组中。

参数

    • cellFieldId - 网格字段ID和由点“.”分隔的单元格ID。例如: gridId.cellId.

示例代码 

var values = FormUtil.getGridCellValues("gridId.field1");
for (var i = 0; i < values.length; i++) {
    console.log(values[i]); //i equals to row number start from 0
}

getValue(fieldId)

描述

用于获取表单字段的值。 

参数

    • fieldId - 表单字段id

示例代码 

var value = FormUtil.getValue("field1");

getValues(fieldId)

描述

用于获取表单域的值。值将返回一个数组。

参数

    • fieldId -表单字段id

示例代码 

var values = FormUtil.getValues("field1");
for (var i = 0; i < values.length; i++) {
    console.log(values[i]); 
}

JPopup

  • URL : /jw/js/json/ui_ext.js
  • 自动包含在所有用户视图页面中
  • 方便的方法来创建/显示/隐藏弹出对话框来显示页面

create(id, title, width, height)

描述

用于创建一个弹出对话框元素。

参数

    • id - 弹出对话框的唯一标识符
    • title - 在弹出对话框顶部显示的标题(可选)
    • width - 弹出对话框的宽度(可选)
    • height - 弹出对话框的高度(可选) 

示例代码 

JPopup.create("testPopup", "Test Popup Dialog");

hide(id)

用于隐藏创建并显示的弹出对话框元素。

参数

    • id - 弹出对话框的唯一标识符

示例代码 

JPopup.hide("testPopup");

show(id, url, params, title, width, height, action)

描述

用于创建一个弹出对话框元素。

参数

    • id - 弹出对话框的唯一标识符
    • url - 在弹出对话框中显示的页面的URL
    • params - 要传递参数及其值的JSON对象(可选) 
    • title - 在弹出对话框顶部显示的标题(可选)
    • width - 弹出对话框的宽度(可选)
    • height - 弹出对话框的高度(可选) 
    • action - 获取/发布。默认为发布(可选) 

示例代码 

var params = {
    id : "1",
    name : "test"
};
 
JPopup.show("testPopup", "http://www.joget.org", params);

UI

  • URL : /jw/js/json/ui.js
  • 自动包含在所有用户视图页面中
  • 方便的方法来检索用户界面的值

adjustPopUpDialog(dialogbox)

描述

系统用来将弹出对话框对准屏幕中心。

参数

    • dialogbox - 弹出的对话框对象

示例代码 

UI.adjustPopUpDialog(JPopup.dialogboxes["testPopup"]);

escapeHTML(content)

描述

用于在值中转义HTML语法

参数

    • content - 内容是 escapes

示例代码 

var content = "<p>test content</p>";
var escapedContent = UI.escapeHTML(content);
console.log(escapedContent); // &lt;p&gt;test content&lt;/p&gt;

getPopUpHeight(height)

描述

系统用于计算当前屏幕大小的弹出对话框的高度以支持移动设备

参数

    • height - 弹出对话框的最大高度。默认为“90%”。

示例代码 

var height = UI.getPopUpHeight("500px");

getPopUpWidth(width)

描述

系统用于计算当前屏幕大小的弹出对话框的宽度以支持移动设备。

参数

    • width - 弹出对话框的最大宽度。默认为“90%”。

示例代码 

var width = UI.getPopUpWidth("800px");

userviewThemeParams()

描述

系统使用它来获取包含当前userview主题的meta元素的查询参数字符串。

示例代码 

var url = "http://localhost/jw/form/embed?" + UI.userviewThemeParams();

UrlUtil

  • URL : /jw/js/json/util.js
  • 自动包含在所有用户视图页面中。
  • 方便的方法来处理URL

constructUrlQueryString(params)

描述

用于基于参数对象生成查询字符串

参数

    • params - 一个对象包含所有参数作为属性名称及其在数组中的值

示例代码 

var params = {
    "name" : ["joget"],
    "email" : ["info@joget.org", "test@joget.org"]
};
var queryString = UrlUtil.constructUrlQueryString(params);
console.log(queryString); // name=joget&email=info%40joget%2Eorg&email=test%40joget%2Eorg

encodeUrlParam(url)

描述

用于在URL中 编码URL参数

参数

    • url - 要编码参数的URL。注意:它使用“&”和“=”作为分隔符。

示例代码 

var url = "http://localhost/jw/test?name=joget&email=info@jogte.org&email=test@joget.org";
 
var encodedUrl = UrlUtil.encodeUrlParam(url);
console.log(encodedUrl); // http://localhost/jw/test?name=joget&email=info%40joget%2Eorg&email=test%40joget%2Eorg

getUrlParams(url)

描述

用于获取包含所有参数的对象作为属性名称及其在URL中的值 

参数

    • url - 要解析的URL以检索数组中的所有参数及其值。

示例代码 

var url = "http://localhost/jw/test?name=joget&email=info@jogte.org&email=test@joget.org";
 
var params = UrlUtil.getUrlParams(url);
console.log(params); // {"name" : ["joget"], "email" : ["info@joget.org", "test@joget.org"]}

mergeRequestQueryString(queryString1, queryString2)

描述

用于将2个URL查询参数字符串合并到一个查询字符串中。

参数

    • queryString1 - 首先查询参数字符串
    • queryString2 - 第二个查询参数字符串。如果两个查询字符串中都存在参数,则第二个查询字符串中的值将覆盖第一个查询字符串中的值。

示例代码 

var q1 = "name=joget&email=info@jogte.org&email=test@joget.org";
var q2 = "name=joget team&phone=012345678";
 
var queryString = UrlUtil.mergeRequestQueryString(q1, q2);
console.log(queryString); // name=joget%20team&email=info%40joget%2Eorg&email=test%40joget%2Eorg&phone=012345678

 

 

 

  • No labels