Command Set: browser

Syntax

browser{.error|.eval|.get|.name|.param|.set|.show|.status|.version}

Description

Performs various functions in the browser in which Fire is running.

This command is only available when Fire is deployed within a web browser, see deployment.

Parameters

• .error
  If an error occurs in the browser, this is a string containing the error text.

• .eval(<javascript_expression>)
  Returns the string result from evaluating the entered Javascript expression.

• .get(<name>)
  Get the value of a named system property in the browser's Java VM. The returned value is a string.

• .name()
  Returns the installed browser name as a string value.

• .param(<name>)
  Get the value of an applet parameter from the applet in which Fire is running. The return value is a string.
  Note: this does not set Javascript variables, use .eval for that.

• .set(<name>,<value>)
  Set the value of a named system property in the browser's Java VM. Both parameters are strings.

• .show(<url> {,<target>})
  Displays the entered url. Both parameters are string expressions. Optionally, <target> may be used as follows:

_blank	Opens the new document in a new browser window.
_frame_name	Puts the new document in a frame other than the frame on which the link is located.
_parent	Nests a frameset inside another frameset.
_self	Puts the new document in the same window and frame as the current document.
_top	Loads the new document in the top most frame; that is, the new document fill the entire page.

• .status(<string>)
  Displays text in the status area at the foot of the browser window.

• .version()
  Returns the installed browser version as a string value.

Switches

None

Notes

browser is not a command, but in fact a global structure identifier created by Fire at startup. The above properties and methods are members and functions of ~global.browser.

When any of these functions are executed, Fire waits for a response from the browser before continuing. For this reason do not invoke any Javascript functions which require action by Fire because the action will not be executed and Fire will time out awaiting response from the original function call.

Examples

Displays a page, in this case, in a new browser window.

browser.show("http://www.xmarc.com","_blank")

Retrieves the URL of the current page.

string url=browser.eval("window.location.href")

Opens a new browser window.

browser.eval('window.open ("http://www.xmarc.com","myWin","")')

Displays a string in the browser’s status bar.

browser.status("Status in browser’s status bar")

Retrieves the browser’s name and version.

string name=browser.name()
string version=browser.version()

Sets the value of a named system property, in this case realm, as a space-separated combination of user name and password.

string user="edgar"
string pwd="hsy78ns"
browser.set("realm",user & pwd)

Gets the value of a named system property, in this case realm.

string auth=browser.get("realm")

Gets the value of an applet parameter, in this case APPSESSION.

string sess=browser.param("APPSESSION")

See Also