helma Overview

Boolean


			    
			       authenticate(<String> username,<String> password)

Authenticates a user against a standard Unix password file.

Skin


			    
			       createSkin(<String> skin)

Creates a Skin object from the passed String.

void


			    
			       defineLibraryScope(<String> namespace)

Declares a custom global namespace that will not be garbage collected.

Object


			    
			       deserialize(<String> filename)

Deserialize a JavaScript object that was previously serialized to a file.

String


			    
			       encode(<String> text)

Encodes a string for HTML output and inserts linebreak tags.

String


			    
			       encodeForm(<String> text)

Encodes a string for HTML output, leaving linebreaks untouched.

String


			    
			       encodeXml(<String> text)

Encodes a string for XML output.

String


			    
			       format(<String> text)

Encodes a string for HTML output, leaving existing markup tags untouched.

String


			    
			       formatParagraphs(<String> text)

Encodes a string for HTML output, inserting paragraph tags.

DatabaseObject


			    
			       getDBConnection(<String> datasource)

Connects to a relational database, and returns a DatabaseObject representing that connection.

HTMLDocumentImpl


			    
			       getHtmlDocument(<String> source)

Parses an HTML string to an XML DOM tree.

String


			    
			       getProperty(<String> property,<String> defaultvalue)

Looks up a property that was set in app.properties or server.properties Returns any property defined in [AppDir]/app.properties, resp.

MimePart


			    
			       getURL(<String> url,<String> etagOrDate)

Retrieves a file/document from the passed URL as a MimePart Object, and therefore functions as a minimalist version of a HttpClient.

XmlDocument


			    
			       getXmlDocument(<String> source)

Parses an XML string to an XML DOM tree.

void


			    
			       onCodeUpdate()

If defined, the onCodeUpdate() function is called whenever the code is recompiled.

void


			    
			       onLogout()

If defined, the onLogout() function is called when a user is logged out.

void


			    
			       onRequest()

If defined, the onRequest() function is called before each page request is handled.

void


			    
			       onResponse()

If defined, the onResponse() function is called after each page request is handled but before the response is returned.

void


			    
			       onStart()

If defined, the onStart() function is called when the application is started.

void


			    
			       onStop()

If defined, the onStop() function is called when the application is stopped.

void


			    
			       renderSkin(<String> skin,<Object> params)

Renders the passed SkinObject or a global skin matching the passed name to the response buffer.

String


			    
			       renderSkinAsString(<String> skin,<Object> params)

Returns the result of the rendered SkinObject or a rendered global skin matching the passed name.

void


			    
			       seal(<Object> obj)

Seals an object, and prevents any further modifications of that object.

void


			    
			       serialize(<Object> obj,<String> filename)

Serialize a JavaScript object to a file.

String


			    
			       stripTags(<String> markup)

Removes any markup tags contained in the passed string, and returns the modified string.

Object


			    
			       toJava(<Object> obj)

Converts a Javascript String, Date, etc to its Java counterpart.

Map


			    
			       unwrapJavaMap(<Object> obj)

Unwrap a map previously wrapped using wrapJavaMap().

Object


			    
			       wrapJavaMap(<Packages.java.util.Map> obj)

Wrap a java.util.Map so that it looks and behaves like a native JS object.

void


			    
			       write(<String> text)

Writes a string to java.lang.System.out, i.e.

void


			    
			       writeln(<String> text)

Writes a string together with a line break to java.lang.System.out, i.e.

Method Summary
`Boolean`	`authenticate(<String> username,<String> password)` Authenticates a user against a standard Unix password file.
`Skin`	`createSkin(<String> skin)` Creates a Skin object from the passed String.
`void`	`defineLibraryScope(<String> namespace)` Declares a custom global namespace that will not be garbage collected.
`Object`	`deserialize(<String> filename)` Deserialize a JavaScript object that was previously serialized to a file.
`String`	`encode(<String> text)` Encodes a string for HTML output and inserts linebreak tags.
`String`	`encodeForm(<String> text)` Encodes a string for HTML output, leaving linebreaks untouched.
`String`	`encodeXml(<String> text)` Encodes a string for XML output.
`String`	`format(<String> text)` Encodes a string for HTML output, leaving existing markup tags untouched.
`String`	`formatParagraphs(<String> text)` Encodes a string for HTML output, inserting paragraph tags.
`DatabaseObject`	`getDBConnection(<String> datasource)` Connects to a relational database, and returns a DatabaseObject representing that connection.
`HTMLDocumentImpl`	`getHtmlDocument(<String> source)` Parses an HTML string to an XML DOM tree.
`String`	`getProperty(<String> property,<String> defaultvalue)` Looks up a property that was set in app.properties or server.properties Returns any property defined in [AppDir]/app.properties, resp.
`MimePart`	`getURL(<String> url,<String> etagOrDate)` Retrieves a file/document from the passed URL as a MimePart Object, and therefore functions as a minimalist version of a HttpClient.
`XmlDocument`	`getXmlDocument(<String> source)` Parses an XML string to an XML DOM tree.
`void`	`onCodeUpdate()` If defined, the onCodeUpdate() function is called whenever the code is recompiled.
`void`	`onLogout()` If defined, the onLogout() function is called when a user is logged out.
`void`	`onRequest()` If defined, the onRequest() function is called before each page request is handled.
`void`	`onResponse()` If defined, the onResponse() function is called after each page request is handled but before the response is returned.
`void`	`onStart()` If defined, the onStart() function is called when the application is started.
`void`	`onStop()` If defined, the onStop() function is called when the application is stopped.
`void`	`renderSkin(<String> skin,<Object> params)` Renders the passed SkinObject or a global skin matching the passed name to the response buffer.
`String`	`renderSkinAsString(<String> skin,<Object> params)` Returns the result of the rendered SkinObject or a rendered global skin matching the passed name.
`void`	`seal(<Object> obj)` Seals an object, and prevents any further modifications of that object.
`void`	`serialize(<Object> obj,<String> filename)` Serialize a JavaScript object to a file.
`String`	`stripTags(<String> markup)` Removes any markup tags contained in the passed string, and returns the modified string.
`Object`	`toJava(<Object> obj)` Converts a Javascript String, Date, etc to its Java counterpart.
`Map`	`unwrapJavaMap(<Object> obj)` Unwrap a map previously wrapped using wrapJavaMap().
`Object`	`wrapJavaMap(<Packages.java.util.Map> obj)` Wrap a java.util.Map so that it looks and behaves like a native JS object.
`void`	`write(<String> text)` Writes a string to java.lang.System.out, i.e.
`void`	`writeln(<String> text)` Writes a string together with a line break to java.lang.System.out, i.e.

global.js

Summary