Class Util
java.lang.Object
com.logicaldoc.gui.common.client.util.Util
General utilities container for the GUI
- Since:
- 8.8.3
- Author:
- Marco Meschieri - LogicalDOC
-
Method Summary
Modifier and TypeMethodDescriptionstatic String
Generates HTML code for reproducing audio filesstatic String
static String
static String
avatarUrl
(long userId) static String
static String
static String
avatarWithText
(Long userId, String text) static String
avatarWithText
(String userIdOrName, String text) static String
convertToMap
(List<GUIParameter> parameters) static void
Copies a text into the client's clipboardstatic String
static String
Detect KEY specification from the requeststatic String
Detect locale specification from the requeststatic String
Detect tenant specification from the requeststatic String
displayURL
(Long docId, Long folderId) static void
static String
downloadAttachmentURL
(long docId, String fileVersion, String attachmentFileName) static String
downloadPdfURL
(long docId, String fileVersion) static void
downloadTicket
(String ticketId) static String
downloadTicketURL
(String ticketId) static String
downloadURL
(long docId) static String
downloadURL
(long docId, String fileVersion) static String
downloadURL
(long docId, String fileVersion, boolean open) static String
downloadURL
(long docId, String fileVersion, String suffix, boolean open) static String
encodeUTF8
(String rawString) static String
escapeHTML
(String originalText) Converts some HTML specific cahrd into it's entitystatic String
fileNameIcon
(String iconName, int size) static String
formatDateShortISO
(Date date) static String
formatDouble
(Double number) static String
static String
formatLong
(Long number) static String
formatPercentage
(double value, int fixed) Format number percentage.static String
formatSize
(double size) Format file size in Bytes, KBytes, MBytes or GBytes.static String
formatSizeBytes
(double size) Format file size in bytesstatic String
formatSizeCompact
(double size) Format file size in Bytes, KB, MB, GB.static String
formatSizeKB
(double size) Format file size in KB.static String
formatSizeKB
(Object value) static String
formatSizeW7
(double size) Format file size in Windows 7 Style.static String
formatSizeW7
(Object value) Format file size in Windows 7 Style.static String
getBaseName
(String fileName) static String
Get browser languagestatic String
getExtension
(String fileName) static String
getJavascriptVariable
(String jsVar) static String
static String
getLoginUrl
(String tenant) static String
getParameter
(String name) static String
getParameterValue
(List<GUIParameter> params, String name) static String
getTagsHTML
(List<String> tags) Formats a set of tags into an HTML gridstatic String
static String
Detects the user agent(browser's family)static String
getValue
(String name, List<GUIParameter> parameters) static String
iconWithFilename
(String iconName, String fileName) static String
imageBase64Src
(String imageBase64) Manipulates the given Base64 image specification into a Src to be uses in a <img> tagstatic String
Generates HTML image code.static String
static String
Generates HTML image code with style.static String
static String
static void
Declares the javascript function used to ask confirmation on window closestatic boolean
isAllowedForUpload
(String filename) Checks if the passed filename can be uploaded or not on the basis of what configured in 'upload.disallow'static boolean
isAudioFile
(String fileName) static boolean
static boolean
isDICOMFile
(String fileName) static boolean
isEmailFile
(String fileName) static boolean
isImageFile
(String fileName) static boolean
isMediaFile
(String fileName) static boolean
isOfficeFile
(String fileName) static boolean
isOfficeFileType
(String type) static boolean
isSpreadsheetFile
(String fileName) static boolean
isTextFile
(String fileName) static boolean
isValidEmail
(String email) static boolean
isWebContentFile
(String fileName) static String
static void
openBulkCheckout
(List<Long> unlockedIds) static void
openEditWithOffice
(long docId) static void
openScan()
static String
static void
static void
redirectToLoginUrl
(String tenant) Redirects to the configured login page (the url specified in the j_loginurl javascript variablestatic void
static void
redirectToRoot
(String moduleName) static void
redirectToSuccessUrl
(String locale) Redirects to the configured page after a successful login (the url specified in the j_successurl javascript variablestatic void
removeChildren
(com.smartgwt.client.widgets.layout.Layout container) static void
setupDensity
(GUIInfo info) static String
static String
textWithAvatar
(Long userId, String text) static String
thumbnailImgageHTML
(long docId, String fileVersion, Integer width, Integer height) static String
thumbnailUrl
(long docId, String fileVersion) static String
tileImageHTML
(long docId, String fileVersion, Integer width, Integer height) static String
static long[]
toPrimitives
(Long[] objects) static String
static void
Removes the javascript function used to ask confirmation on window closestatic String
Generates HTML code for reproducing video filesstatic void
waitForUpAndRunning
(String tenant, String locale) static String
webEditorUrl
(int height) static String
webEditorUrl
(long docId, String fileName, int height) static String
static String
webstartURL
(String appName, Map<String, String> params)
-
Method Details
-
imageHTML
Generates HTML image code with style.- Parameters:
imageName
- the name of the icon imagealt
- the image altstyle
- CSS style specification- Returns:
- the resultant HTML
-
imageHTML
-
downloadAttachmentURL
-
downloadURL
-
downloadURL
-
downloadURL
-
downloadPdfURL
-
downloadURL
-
download
-
downloadTicketURL
-
downloadTicket
-
displayURL
-
webEditorUrl
-
webEditorUrl
-
webstartURL
-
videoHTML
Generates HTML code for reproducing video files- Parameters:
mediaUrl
- URL of the media file to reproducewidth
- width specificationheight
- height specification- Returns:
- the HTML content
-
audioHTML
Generates HTML code for reproducing audio files- Parameters:
mediaUrl
- URL of the media file to reproduce- Returns:
- the HTML content
-
thumbnailUrl
-
thumbnailImgageHTML
-
tileUrl
-
tileImageHTML
-
imageUrl
-
fileNameIcon
-
iconWithFilename
-
avatarWithText
-
avatarWithText
-
textWithAvatar
-
avatarImg
-
avatarImg
-
avatarUrl
-
avatarUrl
-
avatarUrl
-
licenseUrl
-
websocketUrl
-
strip
-
toString
-
contextPath
-
currentSkin
-
imagePrefix
-
imageHTML
Generates HTML image code.- Parameters:
imageName
- the image name- Returns:
- the resultant HTML
-
isCommunity
public static boolean isCommunity() -
isOfficeFileType
-
isOfficeFile
-
isSpreadsheetFile
-
isDICOMFile
-
isTextFile
-
isImageFile
-
isWebContentFile
-
isMediaFile
-
isAudioFile
-
isEmailFile
-
copyText
Copies a text into the client's clipboard- Parameters:
text
- the content to put into the clipboards
-
formatSize
Format file size in Bytes, KBytes, MBytes or GBytes.- Parameters:
size
- The file size in bytes.- Returns:
- The formated file size.
-
formatSizeCompact
Format file size in Bytes, KB, MB, GB.- Parameters:
size
- The file size in bytes.- Returns:
- The formated file size.
-
formatLong
-
formatInt
-
formatDouble
-
formatSizeKB
-
formatSizeKB
Format file size in KB.- Parameters:
size
- The file size in bytes.- Returns:
- The formated file size.
-
formatSizeW7
Format file size in Windows 7 Style.- Parameters:
value
- The file size in bytes(can be Float, Long, Integer or String)- Returns:
- The formated file size
-
formatSizeW7
Format file size in Windows 7 Style.- Parameters:
size
- The file size in bytes.- Returns:
- The formated file size.
-
formatSizeBytes
Format file size in bytes- Parameters:
size
- The file size in bytes- Returns:
- the formatted size
-
formatPercentage
Format number percentage.- Parameters:
value
- The value to be formatted.fixed
- The number of decimal places.- Returns:
- The formated value.
-
getBrowserLanguage
Get browser language- Returns:
- The language in ISO 639 format.
-
getUserAgent
Detects the user agent(browser's family)- Returns:
- 'opera', 'safari', 'ie6', 'ie7', 'gecko', or 'unknown'
-
isValidEmail
-
redirect
-
padLeft
-
uninstallCloseWindowAlert
public static void uninstallCloseWindowAlert()Removes the javascript function used to ask confirmation on window close -
installCloseWindowAlert
public static void installCloseWindowAlert()Declares the javascript function used to ask confirmation on window close -
openEditWithOffice
public static void openEditWithOffice(long docId) -
openScan
public static void openScan() -
openBulkCheckout
-
isAllowedForUpload
Checks if the passed filename can be uploaded or not on the basis of what configured in 'upload.disallow'- Parameters:
filename
- the file name- Returns:
- if the extension is allowed
-
detectTenant
Detect tenant specification from the request- Returns:
- the current tenant's name
-
getTenantInRequest
-
getLocaleInRequest
-
detectLocale
Detect locale specification from the request- Returns:
- the locale specification
-
detectKey
Detect KEY specification from the request- Returns:
- the secret KEY
-
getParameter
-
getParameters
-
redirectToRoot
public static void redirectToRoot() -
redirectToRoot
-
redirectToSuccessUrl
Redirects to the configured page after a successful login (the url specified in the j_successurl javascript variable- Parameters:
locale
- language specification
-
redirectToLoginUrl
Redirects to the configured login page (the url specified in the j_loginurl javascript variable- Parameters:
tenant
- name of the tenant
-
getLoginUrl
-
getValue
-
toPrimitives
-
getBaseName
-
getExtension
-
setupDensity
-
convertToMap
-
waitForUpAndRunning
-
escapeHTML
Converts some HTML specific cahrd into it's entity- Parameters:
originalText
- the original string to filter- Returns:
- the escaped string
-
imageBase64Src
Manipulates the given Base64 image specification into a Src to be uses in a <img> tag- Parameters:
imageBase64
- the Base64 representation of an image- Returns:
- The Src
-
getTagsHTML
Formats a set of tags into an HTML grid- Parameters:
tags
- the tags to format- Returns:
- the HTML content
-
formatDateShortISO
-
encodeUTF8
-
getParameterValue
-
removeChildren
public static void removeChildren(com.smartgwt.client.widgets.layout.Layout container) -
getJavascriptVariable
-