com.isti.util

Interface ILaunchBrowser

All Superinterfaces:

StringConstants

All Known Implementing Classes:

LaunchBrowser

public interface ILaunchBrowser
extends StringConstants

Interface LaunchBrowser contains methods for launching browsers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_ERROR No error message.
static int	NON_WINDOWS Selection value to indicate non-Windows operating system.

Fields inherited from interface com.isti.util.StringConstants

ALPHA_CAP_CHARS, ALPHA_CHARS, ALPHA_LOW_CHARS, ALPHANUM_CHARS_STRING, ALPHANUMERIC_CHARS, BOOLEAN_FALSE_TEXT, BOOLEAN_TRUE_TEXT, DATE_FORMAT_AMPM_STR, DATE_FORMAT_RFC_822_STR, DATE_FORMAT24_STR, DEFAULT_JAVA_VERSION_STRING, DEFAULT_NULL_STR, DEFAULT_SEP_STR, EFLOAT_CHARS, EMPTY_CHARS, EMPTY_STRING, EMPTY_STRINGS, FLOAT_CHARS, HEX_ALPHA_CAP_CHARS, HEX_ALPHA_LOW_CHARS, HEX_CHARS, HEX_PREFIX, INTEGER_CHARS, INVALID_FILENAME_CHARS, MODIFIER_TEXT_ALT, MODIFIER_TEXT_CTRL, MODIFIER_TEXT_META, MODIFIER_TEXT_META_ALT, MODIFIER_TEXT_META_CTRL, NONE, QUOTE_STRING, SIGNED_EFLOAT_CHARS, SIGNED_FLOAT_CHARS, SIGNED_INT_CHARS, SMTP_ENCRYPTION_OPTIONS, SMTP_SERVER_AUTHENTICATION_NAME, SMTP_SERVER_AUTHENTICATION_TEXT, SPACE_STRING, SSL, SSL_KEY_STORE_PROP_KEY, SSL_KEY_STORE_TYPE_PROP_KEY, SSL_TRUST_STORE_PROP_KEY, SSL_TRUST_STORE_TYPE_PROP_KEY, STARTTLS, TLS, TOD_CHARS, UNKNOWN_STRING, US_ASCII, WHITE_SPACE_CHARS, WILDCARD_ALL_CHAR, WILDCARD_CHARS, WILDCARD_SINGLE_CHAR

Method Summary

Modifier and Type	Method and Description
static java.awt.Desktop	getDesktop() Get the desktop if it is available and it supports the browse command.
java.lang.String	getErrorMessage() Returns message string for last error (or 'No error' if none).
java.lang.String	getLaunchBrowserCommand() Get the launch browser command.
boolean	isEnabled() Returns an indicator of whether or not the launching of browsers is enabled.
boolean	launchBrowser(java.lang.String uri) Displays the given URI in a browser.
void	setEnabled(boolean flgVal) Enables or disables the launching of a browser.
void	setLaunchBrowserCommand(java.lang.String s) Set the launch browser command.
boolean	showURI(java.net.URI uri) Displays the given URI in a browser.
boolean	showURL(java.lang.String uri) Displays the given URI in a browser.

Field Detail

NO_ERROR

static final java.lang.String NO_ERROR

No error message.

See Also:

Constant Field Values

NON_WINDOWS

static final int NON_WINDOWS

Selection value to indicate non-Windows operating system.

See Also:

Constant Field Values

Method Detail

getDesktop

static java.awt.Desktop getDesktop()

Get the desktop if it is available and it supports the browse command.

Returns:

the desktop if it is available and it supports the browse command, otherwise null.

getErrorMessage

java.lang.String getErrorMessage()

Returns message string for last error (or 'No error' if none).

Returns:

message string for last error (or 'No error' if none).

getLaunchBrowserCommand

java.lang.String getLaunchBrowserCommand()

Get the launch browser command.

Returns:

the launch browser command or an empty string if none, not null.

isEnabled

boolean isEnabled()

Returns an indicator of whether or not the launching of browsers is enabled.

Returns:

true if enabled, false if disabled.

launchBrowser

boolean launchBrowser(java.lang.String uri)

Displays the given URI in a browser.

Parameters:

uri - the URI.

Returns:

true if successful; false if error (in which case an error message may be fetched via the 'getErrorMessage()' method).

setEnabled

void setEnabled(boolean flgVal)

Enables or disables the launching of a browser. The default state is 'enabled'.

Parameters:

flgVal - true to enable, false to disable.

setLaunchBrowserCommand

void setLaunchBrowserCommand(java.lang.String s)

Set the launch browser command.

Parameters:

s - the launch browser command or null or empty string if none.

showURI

boolean showURI(java.net.URI uri)

Displays the given URI in a browser.

Parameters:

uri - the URI.

Returns:

true if successful; false if error (in which case an error message may be fetched via the 'getErrorMessage()' method).

showURL

boolean showURL(java.lang.String uri)

Displays the given URI in a browser.

Parameters:

uri - the URI.

Returns:

true if successful; false if error (in which case an error message may be fetched via the 'getErrorMessage()' method).