com.t_arn.lib.util

Class eveUtils

java.lang.Object

com.t_arn.lib.util.eveUtils

public class eveUtils
extends java.lang.Object

This class provides several handy methods for the Eve VM.

Since:

11.01.05 (version 1.1) - 19.02.18

Version:

3.4.2

Author:

Tom Arn, www.t-arn.com

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	stVersion Contains the version of the class.

Constructor Summary

Constructors

Constructor and Description
eveUtils() Constructor of the class.

Method Summary

Modifier and Type	Method and Description
static boolean	displayHtmlFile(java.lang.String filename) Displays a HTML file in a HtmlViewer.
static boolean	displayHtmlFile(java.lang.String filename, int options) Displays a HTML file in a HtmlViewer.
static boolean	displayHtmlFile(java.lang.String filename, int options, boolean bModal) Displays a HTML file in a HtmlViewer.
static int	exec(java.lang.String commandLine, int maxWaitMillis) Runs a command line with quoted executable.
static int	exec(java.lang.String commandLine, long maxRunMillis, int maxWaitMillis, eve.ui.Frame parentFrame) Runs a command line with quoted executable.
static boolean	fileCopy(eve.io.File source, eve.io.File target) Copies a file.
static java.lang.String	getClipboardText() Gets a text string from the clipboard
static java.lang.Integer[]	getIntegerArray(int[] ints) Gets an Integer array from an int array Integer.valueOf is not supported in Eve.
static java.lang.String	getLogonUser() Get the currently logged in username
static java.lang.String	getPlatform() Returns the current platform
static java.io.InputStream	getResourceAsStream(java.lang.Class clazz, java.lang.String filename) Gets an Inputstream to read a resource from the package name of a class.
static java.lang.String	getTimestamp() Gets the current time in the format yyyy-MM-dd HH:mm:ss
static java.lang.String	getVersion() Returns the version of the class.
static boolean	isVmSufficient(java.lang.String minVersion, boolean showMsg) Checks if the running is sufficient for the app's needs
static void	messageForm(java.lang.String title, java.lang.String text, eve.ui.Frame frParent) Calls messageForm (title, text, frParent, 20, 40);
static void	messageForm(java.lang.String title, java.lang.String text, eve.ui.Frame frParent, int rows, int cols) Displays a text in a TextPad of new modal AppForm.
static boolean	restoreWindowRect(java.lang.String stCompany, java.lang.String stProg, eve.ui.Frame f) Restores window position and size from the user registry.
static boolean	restoreWindowSize(java.lang.String stCompany, java.lang.String stProg, eve.ui.Frame f) Restores window size from the user registry.
static boolean	saveWindowRect(java.lang.String stCompany, java.lang.String stProg, eve.ui.Frame f) Saves window position and size to the user registry.
static boolean	setClipboardText(java.lang.String text) Puts a text into the clipboard.
static void	setUseSystemClipboard(boolean useSystem)
static boolean	sleep(int millis) Sleeps for millis milliseconds.
static void	sort(java.lang.Object[] obj, eve.util.Comparer c, boolean descending) Michael Brereton's fix for a bug in ewe.util.Utils.sort v1.49 The original code did not sort a String[][]

Methods inherited from class java.lang.Object

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

Field Detail

stVersion

protected static java.lang.String stVersion

Contains the version of the class. Must be overridden when class is extended.

Constructor Detail

eveUtils

public eveUtils()

Constructor of the class. Since all methods are static, the Constructor is not really needed.

Method Detail

getVersion

public static java.lang.String getVersion()

Returns the version of the class.

Returns:

return the version

displayHtmlFile

public static boolean displayHtmlFile(java.lang.String filename)

Displays a HTML file in a HtmlViewer. Calls displayHtmlFile (filename, DISPLAY_NO_TABS | DISPLAY_NO_TOOL_BUTTONS | DISPLAY_NO_STATUS_BAR, true);

Parameters:

filename - Filename of the HTML file to be displayed.

Returns:

returns true if HTML file could be displayed or false otherwise

displayHtmlFile

public static boolean displayHtmlFile(java.lang.String filename,
                                      int options)

Displays a HTML file in a HtmlViewer. Calls displayHtmlFile (filename, options, true);

Parameters:

filename - Filename of the HTML file to be displayed.

options - DISPLAY_XXX options of HtmlViewer ORed together

Returns:

returns true if HTML file could be displayed or false otherwise

displayHtmlFile

public static boolean displayHtmlFile(java.lang.String filename,
                                      int options,
                                      boolean bModal)

Displays a HTML file in a HtmlViewer. The file can be stored in the normal file system or inside a .eve or .exe file. The title of the HtmlViewer window is taken from the HTML file.

Parameters:

filename - Filename of the HTML file to be displayed.

options - DISPLAY_XXX options of HtmlViewer ORed together

bModal - If set to true, HtmlViewer will be shown in modal window. On Windows Mobile, this parameter is always set to true

Returns:

returns true if HTML file could be displayed or false otherwise

exec

public static int exec(java.lang.String commandLine,
                       int maxWaitMillis)

Runs a command line with quoted executable. Calls eveUtils.exec (commandLine, -1, wait, null)

Parameters:

commandLine - The command line to use, the executable may be placed in quotes.

maxWaitMillis - max. milliseconds the thread waits for the command to end.

Returns:

returns the exit code of the program or -2 on execCommandLine error, -3 if interrupted or -4 on reaching maxRunMillis If maxWaitMillis is 0, returns -1 if process is still running or -2

exec

public static int exec(java.lang.String commandLine,
                       long maxRunMillis,
                       int maxWaitMillis,
                       eve.ui.Frame parentFrame)

Runs a command line with quoted executable. It is always safest to place the executable in quotes (") in case it has spaces in it. This will remove those quotes and place it as a single String as the first command. If there are quotes in any other arguments, those other quotes are preserved. The path of the executable is also corrected to use the correct system directory separators. You can specify how long the executable is allowed to run. After that time, the process is destroyed.

Parameters:

commandLine - The command line to use, the executable may be placed in quotes.

maxRunMillis - max. milliseconds the executable is allowed run. Set to -1 for unlimited.

maxWaitMillis - max. milliseconds the thread waits for the command to end.

parentFrame - The frame of calling object. If not null, this frame will be refreshed while waiting;

Returns:

returns the exit code of the program or -2 on execCommandLine error, -3 if interrupted or -4 on reaching maxRunMillis If maxWaitMillis is 0, returns -1 if process is still running or -2

fileCopy

public static boolean fileCopy(eve.io.File source,
                               eve.io.File target)

Copies a file.

Parameters:

source - full path of the source file

target - full path of the target file

Returns:

returns true on success, false otherwise

getClipboardText

public static java.lang.String getClipboardText()

Gets a text string from the clipboard

Returns:

returns the string from the clipboard or null if there is no text in the clipbord

getIntegerArray

public static java.lang.Integer[] getIntegerArray(int[] ints)

Gets an Integer array from an int array Integer.valueOf is not supported in Eve. Therefore new Integer[] aInt = {1,2} throws an exception So use: aInt = getIntegerArray(new int[] {1,2})

Parameters:

ints - An int array

Returns:

The Integer array

getLogonUser

public static java.lang.String getLogonUser()

Get the currently logged in username

Returns:

The username or null if user cannot be determined

getPlatform

public static java.lang.String getPlatform()

Returns the current platform

Returns:

returns the platform as a String: Win_Mobile, Win32_NT, Linux, Unknown

getResourceAsStream

public static java.io.InputStream getResourceAsStream(java.lang.Class clazz,
                                                      java.lang.String filename)

Gets an Inputstream to read a resource from the package name of a class. If class is null, the filename must contain the full path, without leading /, e.g. com/t_arn/lib/README.TXT

Parameters:

clazz - Optional Class

filename - The name or full path of the resource file

Returns:

The InputStream or null if resource is not found

getTimestamp

public static java.lang.String getTimestamp()

Gets the current time in the format yyyy-MM-dd HH:mm:ss

Returns:

returns current time string

isVmSufficient

public static boolean isVmSufficient(java.lang.String minVersion,
                                     boolean showMsg)

Checks if the running is sufficient for the app's needs

Parameters:

minVersion - minimal version required by app

showMsg - If true shows a message when VM is insufficient

Returns:

returns true if ok, false otherwise

messageForm

public static void messageForm(java.lang.String title,
                               java.lang.String text,
                               eve.ui.Frame frParent)

Calls messageForm (title, text, frParent, 20, 40);

Parameters:

title - The title of the form

text - The text to display

frParent - The (optional) parent frame

messageForm

public static void messageForm(java.lang.String title,
                               java.lang.String text,
                               eve.ui.Frame frParent,
                               int rows,
                               int cols)

Displays a text in a TextPad of new modal AppForm.

Parameters:

title - Title of the Form

text - Text to be displayed

frParent - parent frame, can be null

rows - number of rows

cols - number of columns

restoreWindowRect

public static boolean restoreWindowRect(java.lang.String stCompany,
                                        java.lang.String stProg,
                                        eve.ui.Frame f)

Restores window position and size from the user registry. When not completely inside the screen, centers the window.

Parameters:

stCompany - your (company) name

stProg - the program name

f - the program frame

Returns:

returns true on success, false otherwise. On mobile devices always returns true without doing anything.

restoreWindowSize

public static boolean restoreWindowSize(java.lang.String stCompany,
                                        java.lang.String stProg,
                                        eve.ui.Frame f)

Restores window size from the user registry.

Parameters:

stCompany - your (company) name

stProg - the program name

f - the program frame

Returns:

returns true on success, false otherwise. On mobile devices always returns true without doing anything.

saveWindowRect

public static boolean saveWindowRect(java.lang.String stCompany,
                                     java.lang.String stProg,
                                     eve.ui.Frame f)

Saves window position and size to the user registry.

Parameters:

stCompany - your (company) name

stProg - the program name

f - the program frame

Returns:

returns true on success, false otherwise. On mobile devices always returns true without doing anything.

setClipboardText

public static boolean setClipboardText(java.lang.String text)

Puts a text into the clipboard.

Parameters:

text - The text to put

Returns:

returns true on success, false otherwise

setUseSystemClipboard

public static void setUseSystemClipboard(boolean useSystem)

sleep

public static boolean sleep(int millis)

Sleeps for millis milliseconds. The calling method must run in an mThread.

Parameters:

millis - milliseconds to sleep

Returns:

returns true if interrupted, false otherwise

sort

public static void sort(java.lang.Object[] obj,
                        eve.util.Comparer c,
                        boolean descending)

Michael Brereton's fix for a bug in ewe.util.Utils.sort v1.49 The original code did not sort a String[][]

Parameters:

obj - The Object to sort

c - The Comparer to be used

descending - true to sort descending, false to sort ascending