com.groiss.wf.html

Class HTMLUtils

java.lang.Object

com.groiss.wf.html.HTMLUtils

public class HTMLUtils
extends Object

Some utility methods for building HTML GUIs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTMLUtils.TooManyResultsException Exception is thrown in case the total count of entries exceeds the configured maximum.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMP_MODE
static String	FORMAT_FIELDS_AS_COMPONENT
static int	SAFE_MODE
static Pattern	SEARCH_TERM_SPLIT_PATTERN
static String	SELECTLIST_LIST Deprecated.
static String	SELECTLIST_TABLE Deprecated.

Constructor Summary

Constructors

Constructor and Description
HTMLUtils()

Method Summary

Modifier and Type	Method and Description
Page	agentSelectList(HttpServletRequest req) Deprecated. use selectUserOrRole(HttpServletRequest)
static void	convertToPDF(XHTMLPage p, OutputStream os, String addr, Locale l) Create a pdf out of the form.
static String	getDisplayValue(DMSForm form, String field) returns the given field's display value this can be: for dates: can be either a CalUtil.showDate(Object) or the CalUtil.showDateTime(Object) representation of the value for selectlist-values: the localized display-value of the selectlist-option for decimal fields: the formatted value using Settings.getDecimalFormatter() with the max. fraction and integer digits set as defined for the field
static Link	getDocumentsLink(ActivityInstance si)
static Link	getDocumentsLink(ActivityInstance si, String comingFrom)
static List<Link>	getFormLinkList(ActivityInstance ai, int mode, String comingFrom, String target, boolean buttonsInToolbar, boolean withToolbar)
static String	getFormLinks(ActivityInstance ai, int mode, String comingFrom, String target)
static Link	getNotesLink(ActivityInstance ai)
static <T extends Persistent> T	getObject(HttpServletRequest req) This method returns a persistent object when the request contains a parameter "object" with a value in the form <classname>:<oid>.
static <T extends Persistent> T	getObject(HttpServletRequest req, String key)
static Persistent	getObject(JSONObject obj)
static Persistent	getObject(String obj) Deprecated. since 8.0; use StoreUtil.getObject(Object) instead
static <T extends Persistent> List<T>	getObjectList(HttpServletRequest req, String key) Get list of objects (from multiple selection list) stored in request under key
static List<Pair<String,String>>	getObjectListForComponent(List<? extends Persistent> l)
static List<Persistent>	getObjects(Class<Persistent> c, Map<String,String> params, boolean isTable)
static Map<String,String>	getParameters(HttpServletRequest req) read the parameters from node and from request
static String	getPreparedStatementCondition(String cond, List<Object> values, String param, String types)
static String	getRunningSteps(ProcessInstance pi, String delim, boolean includeLongRunning) Returns a string containing the active step of the given process with agents and step-name
static Pair<String,List<Object>>	getSearchCondition(Persistent o, String searchAttrs, String searchString) builds a condition for querying the given Persistent uses the global setting for smartSearch
static Pair<String,List<Object>>	getSearchCondition(Persistent o, String searchAttrs, String searchString, boolean smartSearch) builds a condition querying the given Persistent if smartSearch is true, the given searchString will be splitted, and searched in each searchAttr on it's own
static Collection<Pair<String,String>>	getSelectList2(HttpServletRequest req)
static Collection<Pair<String,String>>	getSelectList2(Map<String,String> params)
static Pair<String,String>	getSelectListObject(Map<String,String> params) Used for object selection UI control to retrieve the initial display value for the selected list item.
static Pair<String,String>	getSelectObjectById(long oid, Map<String,String> params)
static String	getSortAttrForSQL(String orderAttr)
static String	getStandardSearchIdOfClass(Class<?> c)
static TableModel	getWorklist(HttpServletRequest req, String id) Return a worklist as table model.
static void	insertSubTable(Element el, DMSForm mainform, short mode) Insert a subform table in an XHTMLPage.
static void	insertSubTable(Element el, DMSForm mainform, short mode, ActivityInstance ai) Insert a subform table in an XHTMLPage.
void	pdf(HttpServletRequest req, HttpServletResponse res)
static Page	refreshForm(HttpServletRequest req)
static Page	refreshWorklist(HttpServletRequest req, Application appl) Deprecated.
Page	roleList(HttpServletRequest request)
Page	selectDocTemplates(HttpServletRequest req)
static Page	selectList(HttpServletRequest req)
static Page	selectList2(HttpServletRequest req) Deprecated.
static Page	selectTable(HttpServletRequest req)
static Page	selectUserOrRole(HttpServletRequest req)
static Page	showEmptyForm(DMSForm f, String buttons, HttpServletRequest req) Deprecated.
static Page	showForm(DMSForm form, List<Component> buttons, String action, FormContext ctx) Show a form.
static Page	showForm(HttpServletRequest req)
static Page	showForm(HttpServletRequest r, ActivityInstance ai, String formid, int mode) Show a process form.
static Page	showForm(HttpServletRequest r, ActivityInstance ai, String formid, int mode, String buttons) Deprecated.
Page	showFormTable(HttpServletRequest req) Show a Form table in its own window or iframe.
static void	showPdfForm(DMSForm form, FormContext ctx, OutputStream os, String addr, Locale l) Create a pdf out of the form.
void	showPdfForm(HttpServletRequest req, HttpServletResponse res) This methods creates a pdf from a form.
Page	showPrintForm(HttpServletRequest req) This method returns a page containing a print version of a form.
static Page	showProcessDetail(HttpServletRequest req) Deprecated. use showProcessDetails(HttpServletRequest)
static Page	showProcessDetails(HttpServletRequest req) Show the process details, designed for opened in a popup window.
static Link	showSubformLink(HttpServletRequest req, String title, String subformid, int width, int height, String tablehandler)
static Link	showSubformLink(HttpServletRequest req, String title, String subformid, int width, int height, String tablehandler, String actions)
static Link	showSubformLink(HttpServletRequest req, String title, String subformid, int width, int height, String tablehandler, String actions, String defaultAction)
static Link	showSubformLink(HttpServletRequest req, String title, String subformid, int width, int height, String tablehandler, String actions, String defaultAction, String page)
static Link	showSubformLink(Persistent obj, String title, String subformid, int width, int height, String tablehandler, String actions, String defaultAction, String page)
static void	showWorklist(HttpServletRequest r, HttpServletResponse res, Application appl, int type, String worklist, String functions) Deprecated.
static JSONObject	toJSON(Persistent obj) Deprecated. use StoreUtil.toJsonAsReference(Persistent) or StoreUtil.toJson(Persistent) instead
Page	userList(HttpServletRequest r)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEARCH_TERM_SPLIT_PATTERN

public static final Pattern SEARCH_TERM_SPLIT_PATTERN

FORMAT_FIELDS_AS_COMPONENT

public static final String FORMAT_FIELDS_AS_COMPONENT

See Also:

Constant Field Values

SELECTLIST_TABLE

@Deprecated
public static final String SELECTLIST_TABLE

Deprecated.

See Also:

Constant Field Values

SELECTLIST_LIST

@Deprecated
public static final String SELECTLIST_LIST

Deprecated.

See Also:

Constant Field Values

SAFE_MODE

public static final int SAFE_MODE

See Also:

Constant Field Values

COMP_MODE

public static final int COMP_MODE

See Also:

Constant Field Values

Constructor Detail

HTMLUtils

public HTMLUtils()

Method Detail

refreshWorklist

@Deprecated
public static Page refreshWorklist(HttpServletRequest req,
                                               Application appl)

Deprecated.

Returns a page that redirects to the current worklist of this application

Parameters:

req - the HTTP request

appl - the application

showWorklist

@Deprecated
public static void showWorklist(HttpServletRequest r,
                                            HttpServletResponse res,
                                            Application appl,
                                            int type,
                                            String worklist,
                                            String functions)
                                     throws Exception

Deprecated.

sends the worklist to the browser.

Parameters:

r - the HTTP request

res - the HTTP response

appl - the application

type - the type: 0..user, 1..role, 2..suspension list

worklist - a worklist implementation (implements com.groiss.wf.html.Worklist)

functions - a space-separated list of function ids

Throws:

Exception

getWorklist

public static TableModel getWorklist(HttpServletRequest req,
                                     String id)

Return a worklist as table model.

Parameters:

req - the HTTP request

id - the id of the worklist, for example standard.wl

Returns:

the worklist as table model

getRunningSteps

public static String getRunningSteps(ProcessInstance pi,
                                     String delim,
                                     boolean includeLongRunning)

Returns a string containing the active step of the given process with agents and step-name

Parameters:

pi - a process instance

delim - a delimiter, for example ", "

includeLongRunning - if true, not only interactive steps are shown but also batch steps, webservice calls, etc.

Returns:

a string containing the active steps

showForm

public static Page showForm(HttpServletRequest req)
                     throws Exception

Throws:

Exception

showForm

public static Page showForm(HttpServletRequest r,
                            ActivityInstance ai,
                            String formid,
                            int mode)
                     throws Exception

Show a process form.

Parameters:

r - the request

ai - the current activity

formid - the id of the form in the process definition

mode - the mode

Throws:

Exception

showForm

public static Page showForm(DMSForm form,
                            List<Component> buttons,
                            String action,
                            FormContext ctx)
                     throws Exception

Show a form.

Parameters:

form - the form object

buttons - a list of components, buttons are shown on the bottom of the form, hidden fields are included in the form.

action - the submit action (Hint: If a XForm is used, the submit action must be defined at the Submit button!)

ctx - the form context

Returns:

a HTMLPage for HTML-forms, else an XHTMLPage

Throws:

Exception

refreshForm

public static Page refreshForm(HttpServletRequest req)
                        throws Exception

Throws:

Exception

showPrintForm

public Page showPrintForm(HttpServletRequest req)
                   throws Exception

This method returns a page containing a print version of a form. It requires that the req contains a parameter 'object' with the classname:oid of the form. The method removes all buttons and adds a header and footer to the page.

Throws:

Exception

showPdfForm

public void showPdfForm(HttpServletRequest req,
                        HttpServletResponse res)
                 throws Exception

This methods creates a pdf from a form. The form is first created in VIEW_TEXT mode (with the permissions of the current activity if parameter task contains its oid). The method only works with XForms and XHTMLForms.

Parameters:

req - parameter object references the form

res - receives the pdf

Throws:

Exception

showPdfForm

public static void showPdfForm(DMSForm form,
                               FormContext ctx,
                               OutputStream os,
                               String addr,
                               Locale l)
                        throws Exception

Create a pdf out of the form.

Parameters:

form - a form object

ctx - the form context (may define visibilities)

os - on this stream the pdf is written

addr - base address if the html contains links to external resources, for example images

l - the locale used for internationalization

Throws:

Exception

convertToPDF

public static void convertToPDF(XHTMLPage p,
                                OutputStream os,
                                String addr,
                                Locale l)
                         throws Exception

Create a pdf out of the form. Note, that some styles are changed before creating the pdf:

• radio buttons and checkboxes are replaced by images
• textarea:height is set to auto (don't set the height in a style attribute, set it in a class), white-space to pre-wrap; a width attribute must be set in the page, preferably by using "@media print" directive.

Parameters:

p - an XHTML Page

os - on this stream the pdf is written

addr - base address if the html contains links to external resources, for example images

l - the locale used for internationalization

Throws:

Exception

pdf

public void pdf(HttpServletRequest req,
                HttpServletResponse res)
         throws Exception

Throws:

Exception

showProcessDetail

@Deprecated
public static Page showProcessDetail(HttpServletRequest req)
                                          throws Exception

Deprecated. use showProcessDetails(HttpServletRequest)

Throws:

Exception

showProcessDetails

public static Page showProcessDetails(HttpServletRequest req)
                               throws Exception

Show the process details, designed for opened in a popup window.

Parameters:

req - the request must contain a parameter "pi" of form classname:oid referencing a process instance object. Optional request parameter "selectedTab" of form "xmlid.nodeid" (e.g. admin.documents) determines the selected tab.

Throws:

Exception

selectList

public static Page selectList(HttpServletRequest req)
                       throws Exception

Throws:

Exception

selectTable

public static Page selectTable(HttpServletRequest req)
                        throws Exception

Throws:

Exception

selectList2

@Deprecated
public static Page selectList2(HttpServletRequest req)
                                    throws Exception

Deprecated.

still used in userrolewizard

Parameters:

req -

Returns:

Throws:

Exception

getSelectListObject

public static Pair<String,String> getSelectListObject(Map<String,String> params)
                                               throws Exception

Used for object selection UI control to retrieve the initial display value for the selected list item.

Parameters:

params - the map of parameters

Returns:

the Pair object with the key and display value for the selected object

Throws:

Exception - in case of an error

getParameters

public static Map<String,String> getParameters(HttpServletRequest req)

read the parameters from node and from request

getSelectList2

public static Collection<Pair<String,String>> getSelectList2(HttpServletRequest req)
                                                      throws Exception

Throws:

Exception

getSortAttrForSQL

public static String getSortAttrForSQL(String orderAttr)

getSelectObjectById

public static Pair<String,String> getSelectObjectById(long oid,
                                                      Map<String,String> params)
                                               throws Exception

Throws:

Exception

getObjects

public static List<Persistent> getObjects(Class<Persistent> c,
                                          Map<String,String> params,
                                          boolean isTable)
                                   throws Exception

Throws:

Exception

getPreparedStatementCondition

public static String getPreparedStatementCondition(String cond,
                                                   List<Object> values,
                                                   String param,
                                                   String types)

getSelectList2

public static Collection<Pair<String,String>> getSelectList2(Map<String,String> params)
                                                      throws Exception

Throws:

Exception

agentSelectList

@Deprecated
public Page agentSelectList(HttpServletRequest req)
                                 throws Exception

Deprecated. use selectUserOrRole(HttpServletRequest)

Throws:

Exception

roleList

public Page roleList(HttpServletRequest request)
              throws Exception

Throws:

Exception

userList

public Page userList(HttpServletRequest r)
              throws Exception

Throws:

Exception

getObject

public static Persistent getObject(JSONObject obj)

toJSON

@Deprecated
public static JSONObject toJSON(Persistent obj)

Deprecated. use StoreUtil.toJsonAsReference(Persistent) or StoreUtil.toJson(Persistent) instead

Parameters:

obj -

Returns:

See Also:

StoreUtil.toJsonAsReference(Persistent)

selectUserOrRole

public static Page selectUserOrRole(HttpServletRequest req)
                             throws Exception

Throws:

Exception

getObject

public static <T extends Persistent> T getObject(HttpServletRequest req)

This method returns a persistent object when the request contains a parameter "object" with a value in the form <classname>:<oid>. The method returns null if no such parameter is present or the object is not in the database. if the oid is 0 it returrns a new instance of the class.

Parameters:

req -

Returns:

a persistent object or null

getObject

public static <T extends Persistent> T getObject(HttpServletRequest req,
                                                 String key)

getObject

@Deprecated
public static Persistent getObject(String obj)

Deprecated. since 8.0; use StoreUtil.getObject(Object) instead

getDocumentsLink

public static Link getDocumentsLink(ActivityInstance si)

Returns:

a link to the document folder

getDocumentsLink

public static Link getDocumentsLink(ActivityInstance si,
                                    String comingFrom)

Parameters:

comingFrom - the url for the back button in the document table

Returns:

a link to the document folder

getNotesLink

public static Link getNotesLink(ActivityInstance ai)

Returns:

a link to the notes of a process

getFormLinks

public static String getFormLinks(ActivityInstance ai,
                                  int mode,
                                  String comingFrom,
                                  String target)

getFormLinkList

public static List<Link> getFormLinkList(ActivityInstance ai,
                                         int mode,
                                         String comingFrom,
                                         String target,
                                         boolean buttonsInToolbar,
                                         boolean withToolbar)

Returns:

links to the forms

showSubformLink

public static Link showSubformLink(HttpServletRequest req,
                                   String title,
                                   String subformid,
                                   int width,
                                   int height,
                                   String tablehandler)

showSubformLink

public static Link showSubformLink(HttpServletRequest req,
                                   String title,
                                   String subformid,
                                   int width,
                                   int height,
                                   String tablehandler,
                                   String actions)

showSubformLink

public static Link showSubformLink(HttpServletRequest req,
                                   String title,
                                   String subformid,
                                   int width,
                                   int height,
                                   String tablehandler,
                                   String actions,
                                   String defaultAction)

showSubformLink

public static Link showSubformLink(HttpServletRequest req,
                                   String title,
                                   String subformid,
                                   int width,
                                   int height,
                                   String tablehandler,
                                   String actions,
                                   String defaultAction,
                                   String page)

showSubformLink

public static Link showSubformLink(Persistent obj,
                                   String title,
                                   String subformid,
                                   int width,
                                   int height,
                                   String tablehandler,
                                   String actions,
                                   String defaultAction,
                                   String page)

insertSubTable

public static void insertSubTable(Element el,
                                  DMSForm mainform,
                                  short mode)
                           throws Exception

Insert a subform table in an XHTMLPage.

Parameters:

el - an jdom-element in a XHMTL page. The element will be modified and the table is added as sub-element.

mainform - the main form

mode - the mode for showing the table, RemoteWfEngine.INVISIBLE, READ_ONLY, READ_WRITE, NO_ADDDEL

Throws:

Exception

insertSubTable

public static void insertSubTable(Element el,
                                  DMSForm mainform,
                                  short mode,
                                  ActivityInstance ai)
                           throws Exception

Insert a subform table in an XHTMLPage.

Parameters:

el - an jdom-element in a XHMTL page. The element will be modified and the table is added as sub-element.

mainform - the main form

mode - the mode for showing the table, RemoteWfEngine.INVISIBLE, READ_ONLY, READ_WRITE, NO_ADDDEL

ai - context activity instance, may be used in subtables table event handler

Throws:

Exception

getObjectList

public static <T extends Persistent> List<T> getObjectList(HttpServletRequest req,
                                                           String key)

Get list of objects (from multiple selection list) stored in request under key

Parameters:

req -

key -

getObjectListForComponent

public static List<Pair<String,String>> getObjectListForComponent(List<? extends Persistent> l)

getDisplayValue

public static String getDisplayValue(DMSForm form,
                                     String field)

returns the given field's display value this can be:

• for dates: can be either a CalUtil.showDate(Object) or the CalUtil.showDateTime(Object) representation of the value
• for selectlist-values: the localized display-value of the selectlist-option
• for decimal fields: the formatted value using Settings.getDecimalFormatter() with the max. fraction and integer digits set as defined for the field

Parameters:

form - the form

field - the field, the text will be returned

Returns:

the fields display value or null if no text was found

showEmptyForm

@Deprecated
public static Page showEmptyForm(DMSForm f,
                                             String buttons,
                                             HttpServletRequest req)
                                      throws Exception

Deprecated.

Throws:

Exception

See Also:

showForm(DMSForm, List, String, FormContext)

showForm

@Deprecated
public static Page showForm(HttpServletRequest r,
                                        ActivityInstance ai,
                                        String formid,
                                        int mode,
                                        String buttons)
                                 throws Exception

Deprecated.

Throws:

Exception

See Also:

or, showForm(HttpServletRequest, ActivityInstance, String, int)

getStandardSearchIdOfClass

public static String getStandardSearchIdOfClass(Class<?> c)

getSearchCondition

public static Pair<String,List<Object>> getSearchCondition(Persistent o,
                                                           String searchAttrs,
                                                           String searchString)

builds a condition for querying the given Persistent uses the global setting for smartSearch

Parameters:

o -

searchAttrs - the attrs, comma separated

searchString - the search-string

Returns:

getSearchCondition

public static Pair<String,List<Object>> getSearchCondition(Persistent o,
                                                           String searchAttrs,
                                                           String searchString,
                                                           boolean smartSearch)

builds a condition querying the given Persistent if smartSearch is true, the given searchString will be splitted, and searched in each searchAttr on it's own

Parameters:

o -

searchAttrs -

searchString -

smartSearch - use smartSearch?

Returns:

selectDocTemplates

public Page selectDocTemplates(HttpServletRequest req)
                        throws Exception

Throws:

Exception

showFormTable

public Page showFormTable(HttpServletRequest req)

Show a Form table in its own window or iframe.

Parameters:

req - parameters: showToolbar: true | false, hideCloseButton: true | false, nodeid: define the node by specifying the id