[ [val, display], [val, display], .. ][ {value:val, display:display}, .. ][ display, display, .. ] In this case,
+ * the index position of the string will be the value.language
+ * is a valid ISO Language Code (eg. "de"), COUNTRY a valid ISO
+ * Country Code (eg. "AT"), and variant an identifier for the variant to use.
+ * @returns The locale for the given id
+ * @type java.util.Locale
+ */
+jala.I18n.prototype.getLocale = function(localeId) {
+ if (localeId) {
+ if (localeId.indexOf("_") > -1) {
+ var arr = localeId.split("_");
+ if (arr.length == 3) {
+ return new java.util.Locale(arr[0], arr[1], arr[2]);
+ } else {
+ return new java.util.Locale(arr[0], arr[1]);
+ }
+ } else {
+ return new java.util.Locale(localeId);
+ }
+ }
+ return java.util.Locale.getDefault();
+}
+
+/**
+ * Tries to "translate" the given message key into a localized
+ * message.
+ * @param {String} key The message to translate (required)
+ * @param {String} plural The plural form of the message to translate
+ * @param {Number} amount A number to determine whether to use the
+ * singular or plural form of the message
+ * @returns The localized message or the appropriate key if no
+ * localized message was found
+ * @type String
+ */
+jala.I18n.prototype.translate = function(singularKey, pluralKey, amount) {
+ var translation = null;
+ if (singularKey) {
+ // use the getter method for retrieving the locale
+ var locale = this.getLocaleGetter()();
+ var catalog, key;
+ if ((catalog = jala.i18n.getCatalog(locale))) {
+ if (arguments.length == 3 && amount != 1) { // is plural
+ key = pluralKey;
+ } else {
+ key = singularKey;
+ }
+ if (!(translation = catalog[key])) {
+ translation = key;
+ app.logger.debug("jala.i18n.translate(): Can't find message '" +
+ key + "' for locale '" + locale + "'");
+ }
+ } else {
+ app.logger.debug("jala.i18n.translate(): Can't find message catalog for locale '" + locale + "'");
+ if (!pluralKey || amount == 1) {
+ translation = singularKey;
+ } else {
+ translation = pluralKey;
+ }
+ }
+ }
+ return translation;
+};
+
+/**
+ * Helper method to get the message catalog
+ * corresponding to the actual locale.
+ * @params {java.util.Locale} locale
+ * @returns The message catalog.
+ */
+jala.I18n.prototype.getCatalog = function(locale) {
+ if (!jala.I18n.catalogs) {
+ jala.I18n.catalogs = {};
+ }
+
+ var catalog = jala.I18n.catalogs[locale];
+
+ if (catalog) return catalog;
+
+ var messages = this.getMessages();
+
+ if (locale && messages) {
+ catalog = messages[locale.toLanguageTag()];
+ jala.I18n.catalogs[locale] = catalog;
+ }
+
+ return catalog;
+};
+
+/**
+ * Converts the message passed as argument into an instance
+ * of java.text.MessageFormat, and formats it using the
+ * replacement values passed.
+ * @param {String} message The message to format
+ * @param {Array} values An optional array containing replacement values
+ * @returns The formatted message or, if the formatting fails, the
+ * message passed as argument.
+ * @type String
+ * @see http://java.sun.com/j2se/1.5.0/docs/api/java/text/MessageFormat.html
+ */
+jala.I18n.prototype.formatMessage = function(message, values) {
+ if (message) {
+ var args = null;
+ if (values != null && values.length > 0) {
+ args = java.lang.reflect.Array.newInstance(java.lang.Object, values.length);
+ var arg;
+ for (var i=0;inumber must
+ * match the number of the additional argument (starting with zero).
+ * @param {String} singularKey The singular message to localize
+ * @param {String} pluralKey The plural form of the message to localize
+ * @param {Number} amount The amount which is used to determine
+ * whether the singular or plural form of the message should be returned.
+ * @returns The translated message
+ * @type String
+ * @see #translate
+ * @see #formatMessage
+ */
+jala.I18n.prototype.ngettext = function(singularKey, pluralKey, amount /** [value 0][, value 1][, ...] */) {
+ return this.formatMessage(this.translate(singularKey, pluralKey, amount || 0),
+ Array.prototype.splice.call(arguments, 2));
+};
+
+/**
+ * A simple proxy method which is used to mark a message string
+ * for the i18n parser as to be translated.
+ * @param {String} key The message that should be seen by the
+ * i18n parser as to be translated.
+ * @returns The message in unmodified form
+ * @type String
+ */
+jala.I18n.prototype.markgettext = function(key) {
+ return key;
+};
+
+/**
+ * Returns a translated message. The following macro attributes
+ * are accepted:
+ * " + this.getJavaObject().toString() + ""; +}; + + +/** @ignore */ +jala.Mp3.Id3v2.toString = function() { + return "[jala.Mp3.Id3v2]"; +}; + +/** @ignore */ +jala.Mp3.Id3v2.prototype.toString = jala.Mp3.Id3v2.toString; + + +// FIXME: report bug in JavaMusicTag: +// if you delete a v2 tag and call save() JMT calls the delete method of an ID3v2_4 tag. +// this way a 2_2 or 2_3 tag in the file isn't found and not deleted. +// Mp3.save() has a workaround for this. + diff --git a/modules/jala/code/PodcastWriter.js b/modules/jala/code/PodcastWriter.js new file mode 100644 index 00000000..906215b5 --- /dev/null +++ b/modules/jala/code/PodcastWriter.js @@ -0,0 +1,129 @@ +// +// Jala Project [http://opensvn.csie.org/traccgi/jala] +// +// Copyright 2004 ORF Online und Teletext GmbH +// +// Licensed under the Apache License, Version 2.0 (the ``License''); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ``AS IS'' BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// $Revision$ +// $LastChangedBy$ +// $LastChangedDate$ +// $HeadURL$ +// + + +/** + * @fileoverview Fields and methods of the jala.PodcastWriter class. + */ + + +// Define the global namespace for Jala modules +if (!global.jala) { + global.jala = {}; +} + + +/** + * Jala dependencies + */ +app.addRepository(getProperty("jala.dir", "modules/jala") + + "/code/Rss20Writer.js"); + +/** + * @class Class to create, modify and render standard-compliant + * RSS 2.0 feeds including support for Apple's Podcast specification. + * @constructor + * @extends jala.Rss20Writer + * @param {String} header Optional XML header. + */ +jala.PodcastWriter = function(header) { + jala.Rss20Writer.apply(this, arguments); + + var CATEGORY = { + name: "itunes:category", + attributes: { + name: "text" + } + }; + + var OWNER = { + name: "itunes:owner", + value: [{ + name: "itunes:name" + }, { + name: "itunes:email" + }] + }; + + this.addNamespace("itunes", "http://www.itunes.com/dtds/podcast-1.0.dtd"); + + this.extendChannel([{ + name: "itunes:author" + }, { + name: "itunes:subtitle" + }, { + name: "itunes:summary" + }, { + name: "itunes:new-feed-url" + }, { + name: "itunes:image", + attributes: [{ + name: "href" + }] + }, { + name: "itunes:link", + attributes: [{ + name: "rel" + }, { + name: "type" + }, { + name: "href" + }] + }]); + + this.getChannel().setValue(this.createElement(OWNER)); + + this.extendItem([{ + name: "itunes:duration" + }, { + name: "itunes:subtitle" + }]); + + /** + * Add an iTunes Podcast category. + * @param {String} name The category's name. + * @param {String} subName The (optional) sub-category's name. + * @param {jala.XmlWriter.XmlElement} parent Optional parent + * element to add the category to. + */ + this.addItunesCategory = function(name, subName, parent) { + if (!parent) + parent = this.getChannel(); + var cat = this.createElement(CATEGORY); + cat.populate({attributes: {text: name}}); + if (subName) { + var subCat = this.createElement(CATEGORY); + subCat.populate({attributes: {text: subName}}); + cat.addValue(subCat); + } + parent.addValue(cat); + return; + }; + + return this; +}; + + +/** A typical XML header as default. + @type String @final */ +jala.PodcastWriter.XMLHEADER = ''; diff --git a/modules/jala/code/RemoteContent.js b/modules/jala/code/RemoteContent.js new file mode 100644 index 00000000..6106413d --- /dev/null +++ b/modules/jala/code/RemoteContent.js @@ -0,0 +1,307 @@ +// +// Jala Project [http://opensvn.csie.org/traccgi/jala] +// +// Copyright 2004 ORF Online und Teletext GmbH +// +// Licensed under the Apache License, Version 2.0 (the ``License''); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ``AS IS'' BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// $Revision$ +// $LastChangedBy$ +// $LastChangedDate$ +// $HeadURL$ +// + +/** + * @fileoverview Fields and methods of the jala.RemoteContent class. + */ + +// HelmaLib dependencies +app.addRepository("modules/core/String.js"); +app.addRepository("modules/core/Object.js"); +app.addRepository("modules/core/Date.js"); +app.addRepository("modules/helma/Http.js"); + +// Define the global namespace for Jala modules +if (!global.jala) { + global.jala = {}; +} + +/** + * Construct a new remote content handler. + * @class API to define, fetch and update content + * from a remote site. + * @param {String} url The URL string of the remote site. + * @param {Integer} method The method to retrieve the remote content. + * @param {File} storage The cache directory. + * @returns A new remote content handler. + * @extends helma.Http + * @constructor + */ +jala.RemoteContent = function(url, method, storage) { + if (typeof PropertyMgr == "undefined") + var PropertyMgr = {}; + + var NULLSTR = ""; + var key = url.md5(); + var fname = key + jala.RemoteContent.SUFFIX; + var cache; + method = (method != null ? method.toLowerCase() : null); + + // depending on the method argument the instance + // becomes extent of the appropriate remote client + switch (method) { + case jala.RemoteContent.XMLRPC: + break; + default: + helma.Http.call(this); + break; + } + + if (!storage) { + storage = jala.RemoteContent.CACHEDIR; + if (!storage.exists() || !storage.isDirectory()) + storage.mkdir(storage.getAbsolutePath()); + } + + var getCache = function() { + switch (storage.constructor) { + case HopObject: + cache = storage; + break; + + case PropertyMgr: + cache = storage.getAll(); + break; + + default: + var f = new File(storage, fname); + cache = f.exists() ? Xml.read(f) : new HopObject(); + } + return cache; + }; + + var setCache = function() { + cache.url = url; + cache.method = method; + if (!cache.interval) { + cache.interval = Date.ONEHOUR; + } + cache.lastUpdate = new Date(); + cache = cache.clone(new HopObject()); + + switch (storage.constructor) { + case HopObject: + for (var i in cache) + storage[i] = cache[i]; + break; + + case PropertyMgr: + storage.setAll(cache); + break; + + default: + var f = new File(storage, fname); + Xml.write(cache, f); + } + return; + }; + + cache = getCache(); + + /** + * Set the interval the remote content's + * cache is bound to be updated. + * @param {Number} interval The interval value in milliseconds. + */ + this.setInterval = function(interval) { + cache.interval = parseInt(interval, 10); + return; + }; + + /** + * Get an arbitrary property of the remote content. + * @param {String} key The name of the property. + * @returns The value of the property. + */ + this.get = function(key) { + return cache[key]; + } + + /** + * Get all available property names. + * @returns The list of property names. + * @type Array + */ + this.getKeys = function() { + var keys = []; + for (var i in cache) { + keys.push(i); + } + return keys.sort(); + }; + + /** + * Tests whether the remote content needs to be updated. + * @returns True if the remote content needs to be updated. + * @type Boolean + */ + this.needsUpdate = function() { + if (!cache.lastUpdate) { + return true; + } else { + var max = new Date() - cache.interval; + if (max - cache.lastUpdate > 0) { + return true; + } + } + return false; + }; + + /** + * Get the updated and cached remote content. + * @returns The content as retrieved from the remote site. + * @type String + */ + this.update = function() { + app.debug("[jala.RemoteContent] Retrieving " + url); + var result; + switch (method) { + case jala.RemoteContent.XMLRPC: + break; + default: + result = this.getUrl(url, cache.lastModified || cache.eTag); + if (result.code != 200 && cache.content) { + // preserve the content received before + result.content = cache.content; + } + result.interval = cache.interval; + cache = result; + } + setCache(); + return cache.content; + }; + + /** + * Flushes (empties) the cached remote content. + */ + this.clear = function() { + switch (storage.constructor) { + case HopObject: + for (var i in storage) + delete storage[i]; + break; + + case PropertyMgr: + storage.reset(); + break; + + default: + var f = new File(storage, fname); + f.remove(); + } + return; + }; + + /** + * Get a string representation of the remote content. + * @returns The remote content as string. + * @type String + */ + this.toString = function() { + return cache.content || NULLSTR; + }; + + /** + * Get the value of the remote content. + * @returns The remote content including response header data. + * @type Object + */ + this.valueOf = function() { + return cache; + }; + + return this; +}; + +/** + * A constant representing the HTTP retrieval method. + * @type int + * @final + */ +jala.RemoteContent.HTTP = 1; + +/** + * A constant representing the XML-RPC retrieval method. + * @type int + * @final + */ +jala.RemoteContent.XMLRPC = 2; + +/** + * The default name of the cache directory. + * @type String + * @final + */ +jala.RemoteContent.SUFFIX = ".cache"; + +/** + * The default cache directory. + * @type File + * @final + */ +jala.RemoteContent.CACHEDIR = new File(app.dir, jala.RemoteContent.SUFFIX); + +/** + * Remove all remote content from a file-based cache. + * @param {File} cache An optional target directory. + */ +jala.RemoteContent.flush = function(cache) { + jala.RemoteContent.forEach(function(rc) { + rc.clear(); + return; + }); + return; +}; + +/** + * Apply a custom method on all remote content in a file-based cache. + * @param {Function} callback The callback method to be executed + * for each remote content file. + * @param {File} cache An optional target directory. + */ +jala.RemoteContent.forEach = function(callback, cache) { + if (!cache) + cache = jala.RemoteContent.CACHEDIR; + var f, rc; + var files = cache.list(); + for (var i in files) { + f = new File(cache, files[i]); + if (!files[i].endsWith(jala.RemoteContent.SUFFIX)) + continue; + rc = new jala.RemoteContent(Xml.read(f).url); + if (callback && callback.constructor == Function) + callback(rc); + } + return; +}; + +/** + * Apply a custom method on all remote content in a file-based cache. + * @param {Function} callback The callback method to be executed + * for each remote content file. + * @param {File} cache An optional target directory. + * @deprecated Use {@link #forEach} instead. + */ +jala.RemoteContent.exec = function() { + jala.RemoteContent.forEach.apply(this, arguments); +}; diff --git a/modules/jala/code/Rss20Writer.js b/modules/jala/code/Rss20Writer.js new file mode 100644 index 00000000..6edc0137 --- /dev/null +++ b/modules/jala/code/Rss20Writer.js @@ -0,0 +1,334 @@ +// +// Jala Project [http://opensvn.csie.org/traccgi/jala] +// +// Copyright 2004 ORF Online und Teletext GmbH +// +// Licensed under the Apache License, Version 2.0 (the ``License''); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ``AS IS'' BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// $Revision$ +// $LastChangedBy$ +// $LastChangedDate$ +// $HeadURL$ +// + + +/** + * @fileoverview Fields and methods of the jala.Rss20Writer class. + */ + + +// Define the global namespace for Jala modules +if (!global.jala) { + global.jala = {}; +} + + +/** + * Jala dependencies + */ +app.addRepository(getProperty("jala.dir", "modules/jala") + + "/code/XmlWriter.js"); + +/** + * @class Class to create, modify and render standard-compliant + * RSS 2.0 feeds. + * @constructor + * @extends jala.XmlWriter + * @param {String} header Optional XML header. + */ +jala.Rss20Writer = function(header) { + // defines the prototype of this constructor + jala.XmlWriter.apply(this, arguments); + + // this should do the same but alas, helma throws + // an error the very first time it is executed: + //arguments.callee.prototype = new jala.XmlWriterInterface(); + + var DATEFMT = "EEE, dd MMM yyyy HH:mm:ss Z"; + + var CATEGORY = { + name: "category", + amount: Infinity, + attributes: { + name: "domain", + } + }; + + var ITEM = { + name: "item", + amount: Infinity, + value: [{ + name: "title", + required: true + }, { + name: "link", + }, { + name: "description", + }, { + name: "author", + }, { + name: "comments", + }, { + name: "enclosure", + attributes: [{ + name: "url", + required: true + }, { + name: "length", + required: true + }, { + name: "type", + required: true + }] + }, { + name: "guid", + attributes: [{ + name: "isPermaLink", + type: Boolean + }] + }, { + name: "pubDate", + type: Date, + format: DATEFMT + }, { + name: "source", + attributes: [{ + name: "url", + required: true + }] + }] + }; + + var CHANNEL = { + name: "channel", + value: [{ + name: "title", + required: true + }, { + name: "link", + required: true + }, { + name: "description", + required: true + }, { + name: "language", + }, { + name: "copyright", + }, { + name: "managingEditor", + }, { + name: "webMaster", + }, { + name: "pubDate", + type: Date, + format: DATEFMT + }, { + name: "lastBuildDate", + type: Date, + format: DATEFMT + }, { + name: "generator", + }, { + name: "docs", + }, { + name: "cloud", + attributes: [{ + name: "domain", + }, { + name: "port", + type: Number, + format: "#" + }, { + name: "path", + }, { + name: "registerProcedure", + }, { + name: "protocol", + }] + }, { + name: "ttl", + type: Number, + format: "#" + }, { + name: "rating", + }, { + name: "skipHours", + }, { + name: "skipDays", + }] + }; + + var IMAGE = { + name: "image", + value: [{ + name: "url", + required: true + }, { + name: "title", + required: true + }, { + name: "link", + required: true + }, { + name: "width", + type: Number, + format: "#" + }, { + name: "height", + type: Number, + format: "#" + }, { + name: "description", + }] + }; + + var TEXTINPUT = { + name: "textinput", + value: [{ + name: "title", + required: true + }, { + name: "description", + required: true + }, { + name: "name", + required: true + }, { + name: "link", + required: true + }] + }; + + var ROOT = { + name: "rss", + attributes: [{ + name: "version", + value: "2.0" + }] + }; + + var xmlroot = this.createElement(ROOT); + var channel = this.createElement(CHANNEL); + xmlroot.setValue(channel); + + /** + * Get the writer's root element. + * @returns The writer's root element. + * @type jala.XmlWriter.XmlElement + */ + this.getRoot = function() { + return xmlroot; + }; + + /** + * Add child elements to the channel template. + * @param {Array} ext List of additional child elements. + */ + this.extendChannel = function(ext) { + this.extend(CHANNEL, ext); + channel = this.createElement(CHANNEL); + xmlroot.setValue(channel); + return; + }; + + /** + * Get the writer's channel element. + * @returns The writer's channel element. + * @type jala.XmlWriter.XmlElement + */ + this.getChannel = function() { + return channel; + }; + + /** + * Populate the channel element with data. + * @param {Object} data An XmlWriter-compliant object structure. + * @returns The populated channel element. + * @type jala.XmlWriter.XmlElement + */ + this.setChannel = function(data) { + return channel.populate(data); + }; + + /** + * Add child elements to the item template. + * @param {Array} ext List of additional child elements. + */ + this.extendItem = function(ext) { + this.extend(ITEM, ext); + return; + }; + + /** + * Get a new and innocent item element. + * @param {Object} data An XmlWriter-compliant object structure. + * @returns A new and innocent item element. + * @type jala.XmlWriter.XmlElement + */ + this.createItem = function(data) { + var item = this.createElement(ITEM); + item.populate(data); + return item; + }; + + /** + * Add an item element to the channel element. + * @param {jala.XmlWriter.XmlElement} item The item element to add. + */ + this.addItem = function(item) { + channel.addValue(item); + return; + }; + + /** + * Add a category element to an arbitrary element. + * @param {String} name The name of the category. + * @param {String} domain The domain of the category. + * @param {jala.XmlWriter.XmlElement} parent The optional parent element. + */ + this.addCategory = function(name, domain, parent) { + if (!parent) + parent = channel; + var cat = this.createElement(CATEGORY); + cat.populate({ + value: name, + attributes: {domain: domain} + }); + parent.addValue(cat); + return; + }; + + /** + * Populate the image element with data. + * @param {Object} data An XmlWriter-compliant object structure. + */ + this.setImage = function(data) { + var image = this.createElement(IMAGE); + image.populate(data); + channel.setValue(image); + return; + }; + + /** + * Populate the textInput element with data. + * @param {Object} data An XmlWriter-compliant object structure. + */ + this.setTextInput = function(data) { + var textInput = this.createElement(TEXTINPUT); + textInput.populate(data); + channel.setValue(textInput); + return; + }; + + return this; +}; diff --git a/modules/jala/code/Utilities.js b/modules/jala/code/Utilities.js new file mode 100644 index 00000000..506a34b9 --- /dev/null +++ b/modules/jala/code/Utilities.js @@ -0,0 +1,247 @@ +// +// Jala Project [http://opensvn.csie.org/traccgi/jala] +// +// Copyright 2004 ORF Online und Teletext GmbH +// +// Licensed under the Apache License, Version 2.0 (the ``License''); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ``AS IS'' BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// $Revision$ +// $LastChangedBy$ +// $LastChangedDate$ +// $HeadURL$ +// + +/** + * @fileoverview Fields and methods of the jala.Utilities class. + */ + +// Define the global namespace for Jala modules +if (!global.jala) { + global.jala = {}; +} + +/** + * HelmaLib dependencies + */ +app.addRepository("modules/core/Number.js"); + +/** + * Construct a utility object. + * @class This class contains various convenience methods + * which do not fit in any other class. + * @returns A new utitilty object. + * @constructor + */ +jala.Utilities = function() { + return this; +}; + +/** + * Return a string representation of the utitility class. + * @returns [jala.Utilities] + * @type String + * @ignore FIXME: JSDoc bug + */ +jala.Utilities.toString = function() { + return "[jala.Utilities]"; +}; + +/** + * Return a string representation of the utitility object. + * @returns [jala.Utilities Object] + * @type String + */ +jala.Utilities.prototype.toString = function() { + return "[jala.Utilities Object]"; +}; + +/** + * Default utility class instance. + * @type jala.Utilities + * @final + */ +jala.util = new jala.Utilities(); + +/** + * Creates a random password with different levels of security. + * @param {Number} len The length of the password (default: 8) + * @param {Number} level The security level + *
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--Global ++ + +
| +Method Summary | +|
+
+ <static> Boolean
+
+ |
+
+
+
+ isArray(<Object> val)
+
+ + + Returns true if the value passed as argument is an array. + |
+
+
+ <static> Boolean
+
+ |
+
+
+
+ isBoolean(<Object> val)
+
+ + + Returns true if the value passed as argument is either a boolean + literal or an instance of Boolean. + |
+
+
+ <static> Boolean
+
+ |
+
+
+
+ isDate(<Object> val)
+
+ + + Returns true if the value passed as argument is either a Javascript date + or an instance of java.util.Date. + |
+
+
+ <static> Boolean
+
+ |
+
+
+
+ isFunction(<Object> val)
+
+ + + Returns true if the value passed as argument is a function. + |
+
+
+ <static> Boolean
+
+ |
+
+
+
+ isNull(<Object> val)
+
+ + + Returns true if the value passed as argument is null. + |
+
+
+ <static> Boolean
+
+ |
+
+
+
+ isNumber(<Object> val)
+
+ + + Returns true if the value passed as argument is either a number, + an instance of Number or of java.lang.Number. + |
+
+
+ <static> Boolean
+
+ |
+
+
+
+ isObject(<Object> val)
+
+ + + Returns true if the value passed as argument is either a Javascript + object or an instance of java.lang.Object. + |
+
+
+ <static> Boolean
+
+ |
+
+
+
+ isString(<Object> val)
+
+ + + Returns true if the value passed as argument is either a string literal, + an instance of String or of java.lang.String. + |
+
+
+ <static> Boolean
+
+ |
+
+
+
+ isUndefined(<Object> val)
+
+ + + Returns true if the value passed as argument is undefined. + |
+
+ + + + + + + + + + + + + + + + + +
| + Method Detail + | +
<static> Boolean isArray(<Object> val)+ +
val - The value to test
+ <static> Boolean isBoolean(<Object> val)+ +
val - The value to test
+ <static> Boolean isDate(<Object> val)+ +
val - The value to test
+ <static> Boolean isFunction(<Object> val)+ +
val - The value to test
+ <static> Boolean isNull(<Object> val)+ +
val - The value to test
+ <static> Boolean isNumber(<Object> val)+ +
val - The value to test
+ <static> Boolean isObject(<Object> val)+ +
val - The value to test
+ <static> Boolean isString(<Object> val)+ +
val - The value to test
+ <static> Boolean isUndefined(<Object> val)+ +
val - The value to test
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--HopObject ++ + +
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ getAccessName(<Object> obj, <Number> maxLength)
+
+ + + Constructs a name from an object which + is unique in the underlying HopObject collection. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isClean()
+
+ + + Returns true if the internal state of this HopObject is CLEAN. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isDeleted()
+
+ + + Returns true if the internal state of this HopObject is DELETED. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isInvalid()
+
+ + + Returns true if the internal state of this HopObject is INVALID. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isModified()
+
+ + + Returns true if the internal state of this HopObject is MODIFIED. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isNew()
+
+ + + Returns true if the internal state of this HopObject is NEW. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isTransient()
+
+ + + Returns true if the internal state of this HopObject is TRANSIENT. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isVirtual()
+
+ + + Returns true if the internal state of this HopObject is VIRTUAL. + |
+
+ + + + + + + + + + + + + + + + + +
| + Method Detail + | +
String getAccessName(<Object> obj, <Number> maxLength)+ +
obj - The object representing or containing the alias name. Possible object types include: maxLength - The maximum length of the alias
+ Boolean isClean()+ +
Boolean isDeleted()+ +
Boolean isInvalid()+ +
Boolean isModified()+ +
Boolean isNew()+ +
Boolean isTransient()+ +
Boolean isVirtual()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + jala.Form + | +|
MINLENGTH |
+ "minlength" |
+
MAXLENGTH |
+ "maxlength" |
+
REQUIRE |
+ "require" |
+
CHECKOPTIONS |
+ "checkoptions" |
+
CONTENTTYPE |
+ "contenttype" |
+
MAXWIDTH |
+ "maxwidth" |
+
MINWIDTH |
+ "minwidth" |
+
MAXHEIGHT |
+ "maxheight" |
+
MINHEIGHT |
+ "minheight" |
+
+ +
| + jala.IndexManager + | +|
MAXTRIES |
+ 10 |
+
NORMAL |
+ 1 |
+
REBUILDING |
+ 2 |
+
+ +
| + jala.IndexManager.Job + | +|
ADD |
+ "add" |
+
REMOVE |
+ "remove" |
+
OPTIMIZE |
+ "optimize" |
+
+ +
| + jala.PodcastWriter + | +|
XMLHEADER |
+ '' |
+
+ +
| + jala.RemoteContent + | +|
HTTP |
+ 1 |
+
XMLRPC |
+ 2 |
+
SUFFIX |
+ ".cache" |
+
+ +
| + jala.Utilities + | +|
VALUE_ADDED |
+ 1 |
+
VALUE_MODIFIED |
+ 2 |
+
+ +
+ + +
+
+
|
++Jala 1.3 + + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +||||||||
+
+
|
++Jala 1.3 + + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +||||||||
+ ++ + ++Each class has its own separate page. Each of these pages has three sections consisting of a class description, summary tables, and detailed member descriptions:
+
+Each summary entry contains the first sentence from the detailed description for that item.- Class inheritance diagram
- Direct Subclasses
- Class declaration
- Class description +
+
- Field Summary
- Constructor Summary
- Method Summary +
+
- Field Detail
- Constructor Detail
- Method Detail
+The Index contains an alphabetic list of all classes, constructors, methods, and fields.+
+
+
+This help file applies to API documentation generated using the standard doclet.
+
+
+
+
+
|
++Jala 1.3 + + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +||||||||
+
+
|
++Jala 1.3 + + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +||||||||
+
+
|
++Jala 1.3 + + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.AsyncRequest ++ + +
+
This class is used to create requests of type "INTERNAL"
+ (like cron-jobs) that are processed in a separate thread and
+ therefor asynchronous.
+
Deprecated Use the app.invokeAsync method instead (built-in into Helma as of version 1.6)
Defined in AsyncRequest.js
+
| +Constructor Summary | +|
+
+
+ jala.AsyncRequest
+
+ (<Object> obj, <String> funcName, <Array> args)
+
+ + + Creates a new AsyncRequest instance. + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ evaluate()
+
+ + + Starts this asynchronous request. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isAlive()
+
+ + + Returns true if the underlying thread is alive + |
+
+
+ void
+
+ |
+
+
+
+ run()
+
+ + + Starts this asynchronous request. + |
+
+
+ void
+
+ |
+
+
+
+ setDelay(<Number> millis)
+
+ + + Defines the delay to wait before evaluating this asynchronous request. + |
+
+
+ void
+
+ |
+
+
+
+ setTimeout(<Number> seconds)
+
+ + + Sets the timeout of this asynchronous request. + |
+
| + Constructor Detail + | +
jala.AsyncRequest(<Object> obj, <String> funcName, <Array> args)+ + +
obj - Object in whose context the method should be called
+ funcName - Name of the function to call
+ args - Array containing the arguments that should be passed to the function (optional). This option is deprecated, instead pass the arguments directly to the run() method.
+ | + Method Detail + | +
void evaluate()+ +
Boolean isAlive()+ +
void run()+ +
void setDelay(<Number> millis)+ +
millis - Milliseconds to wait
+ void setTimeout(<Number> seconds)+ +
seconds - Thread-timeout.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.BitTorrent ++ + +
+
This class provides methods to create a BitTorrent
+ metadata file from any desired file.
+
Defined in BitTorrent.js
+
| +Constructor Summary | +|
+
+
+ jala.BitTorrent
+
+ (<String> filePath, <String> trackerUrl)
+
+ + + Constructs a new BitTorrent file. + |
+|
| +Method Summary | +|
+
+ Object
+
+ |
+
+
+
+ get(<String> name)
+
+ + + Get a torrent property. + |
+
+
+ Date
+
+ |
+
+
+
+ getCreationDate()
+
+ + + Get the creation date of the torrent. + |
+
+
+ Number
+
+ |
+
+
+
+ getPieceLength()
+
+ + + Get the piece length of the torrent. + |
+
+
+ helma.File
+
+ |
+
+
+
+ getSourceFile()
+
+ + + Returns the underlying source file. + |
+
+
+ helma.File
+
+ |
+
+
+
+ getTorrentFile()
+
+ + + Returns the underlying torrent file. + |
+
+
+ Array
+
+ |
+
+
+
+ keys()
+
+ + + Get all available property names. + |
+
+
+ void
+
+ |
+
+
+
+ save(<String> filename)
+
+ + + Saves the torrent as file. + |
+
+
+ void
+
+ |
+
+
+
+ set(<String> name, <Object> value)
+
+ + + Set a torrent property. + |
+
+
+ void
+
+ |
+
+
+
+ setCreationDate(<Date> date)
+
+ + + Set the creation date of the torrent. + |
+
+
+ void
+
+ |
+
+
+
+ setPieceLength(<Number> length)
+
+ + + Set the piece length of the torrent. + |
+
+
+ String
+
+ |
+
+
+
+ toString()
+
+ + + Get a string representation of the torrent. + |
+
+
+ <static> Object
+
+ |
+
+
+
+ bdecode(<String> code)
+
+ + + The bdecode method. + |
+
+
+ <static> String
+
+ |
+
+
+
+ bencode(<Object> obj)
+
+ + + The bencode method. + |
+
| + Constructor Detail + | +
jala.BitTorrent(<String> filePath, <String> trackerUrl)+ + +
filePath - The path to the original file.
+ trackerUrl - The URL string of the tracker.
+ | + Method Detail + | +
Object get(<String> name)+ +
name - The name of the property.
+ Date getCreationDate()+ +
Number getPieceLength()+ +
helma.File getSourceFile()+ +
helma.File getTorrentFile()+ +
Array keys()+ +
void save(<String> filename)+ +
filename - An optional name for the torrent file. If no name is given it will be composed from name of source file as defined in the torrent plus the ending ".torrent".
+ void set(<String> name, <Object> value)+ +
name - The name of the property.
+ value - The property's value.
+ void setCreationDate(<Date> date)+ +
date - The desired creation date.
+ void setPieceLength(<Number> length)+ +
length - The desired piece length.
+ String toString()+ +
<static> Object bdecode(<String> code)+ +
code - The encoded string.
+ <static> String bencode(<Object> obj)+ +
obj - The target JavaScript object.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Captcha ++ + +
+
Wrapper class for the
+ JCaptcha library.
+ A captcha (an acronym for "completely automated public
+ Turing test to tell computers and humans apart") is a
+ type of challenge-response test used in computing to
+ determine whether or not the user is human.
+
Defined in Captcha.js
+
| +Constructor Summary | +|
+
+
+ jala.Captcha
+
+ ()
+
+ + + Construct a new captcha. + |
+|
| +Method Summary | +|
+
+ com.octo.captcha.Captcha
+
+ |
+
+
+
+ getCaptcha()
+
+ + + Get a new captcha object. + |
+
+
+ void
+
+ |
+
+
+
+ renderImage()
+
+ + + Render a new captcha image. + |
+
+
+ String
+
+ |
+
+
+
+ toString()
+
+ + + Get a string representation of the captcha object. + |
+
+
+ Boolean
+
+ |
+
+
+
+ validate(<String> input)
+
+ + + Validate a user's input with the prompted captcha. + |
+
| + Constructor Detail + | +
jala.Captcha()+ + +
| + Method Detail + | +
com.octo.captcha.Captcha getCaptcha()+ +
void renderImage()+ +
String toString()+ +
Boolean validate(<String> input)+ +
input - The user's input.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Date.Calendar.Renderer ++ + +
+
A default renderer to use in conjunction with jala.Date.Calendar
+
Defined in Date.js
+
| + Field Summary | +|
+ jala.Date.Calendar |
+ calendar
+ + The calendar utilizing this renderer instance |
+
+ helma.Html |
+ html
+ + An instance of helma.Html used for rendering the calendar |
+
| +Constructor Summary | +|
+
+
+ jala.Date.Calendar.Renderer
+
+ (<jala.Date.Calendar> calendar)
+
+ + + Returns a new instance of the default calendar renderer. + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ renderCalendar(<Date> date, <String> body, <Date> prevMonth, <Date> nextMonth)
+
+ + + Renders the calendar directly to response. + |
+
+
+ void
+
+ |
+
+
+
+ renderDay(<Date> date, <Boolean> isExisting, <Boolean> isSelected)
+
+ + + Renders a single day within the calendar directly to response. + |
+
+
+ void
+
+ |
+
+
+
+ renderDayHeader(<String> text)
+
+ + + Renders a single cell in the calendar day header row directly to response. + |
+
+
+ void
+
+ |
+
+
+
+ renderPrevNextLink(<Date> date)
+
+ + + Renders a link to the previous or next month's calendar directly to response. + |
+
+
+ void
+
+ |
+
+
+
+ renderRow(<String> row)
+
+ + + Renders a single calendar row directly to response. + |
+
| Field Detail | +
jala.Date.Calendar calendar+
helma.Html html+
| + Constructor Detail + | +
jala.Date.Calendar.Renderer(<jala.Date.Calendar> calendar)+ + +
calendar - The calendar utilizing this renderer
+ | + Method Detail + | +
void renderCalendar(<Date> date, <String> body, <Date> prevMonth, <Date> nextMonth)+ +
date - A date object representing this calendar's month and year. Please mind that the day will be set to the last date in this month.
+ body - The rendered calendar weeks including the day header (basically the whole kernel of the table).
+ prevMonth - A date object set to the last available date of the previous month. This can be used to render a navigation link to the previous month.
+ nextMonth - A date object set to the first available date of the next month. This can be used to render a navigation link to the next month.
+ void renderDay(<Date> date, <Boolean> isExisting, <Boolean> isSelected)+ +
date - A date instance representing the day within the calendar.
+ isExisting - True if there is a child object in the calendar's collection to which the date cell should link to
+ isSelected - True if this calendar day should be rendered as selected day.
+ void renderDayHeader(<String> text)+ +
text - The text to display in the header field.
+ void renderPrevNextLink(<Date> date)+ +
date - A date object set to the previous or next available month. This can be null in case there is no previous or next month.
+ void renderRow(<String> row)+ +
row - The body of the calendar row.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Date.Calendar ++ + +
+
This class represents a calendar based based on a grouped
+ collection of HopObjects. It provides several methods for rendering
+ the calendar plus defining locale and timezone settings.
+
Defined in Date.js
+
| +Nested Class Summary | +|
+ <static class> |
+ jala.Date.Calendar.Renderer |
+
| +Constructor Summary | +|
+
+
+ jala.Date.Calendar
+
+ (<HopObject> collection)
+
+ + + Creates a new instance of jala.Data.Calendar + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ getAccessNameFormat()
+
+ + + Returns the format of the access name used by this calendar to access + child group objects of the collection this calendar is operating on. + |
+
+
+ String
+
+ |
+
+
+
+ getCalendar(today)
+
+ + + Returns a rendered calendar + |
+
+
+ HopObject
+
+ |
+
+
+
+ getCollection()
+
+ + + Returns the collection this calendar object works on + |
+
+
+ String
+
+ |
+
+
+
+ getHrefFormat()
+
+ + + Returns the date formatting pattern used to render hrefs. + |
+
+
+ java.util.Locale
+
+ |
+
+
+
+ getLocale()
+
+ + + Returns the locale used within this calendar instance. + |
+
+
+ Object
+
+ |
+
+
+
+ getRenderer()
+
+ + + Returns the renderer used by this calendar. + |
+
+
+ java.util.Locale
+
+ |
+
+
+
+ getTimeZone()
+
+ + + Returns the locale used within this calendar instance. + |
+
+
+ void
+
+ |
+
+
+
+ render(today)
+
+ + + Renders the calendar using either a custom renderer defined + using setRenderer() or the default one. + |
+
+
+ void
+
+ |
+
+
+
+ setAccessNameFormat(<String> fmt)
+
+ + + Sets the format of the group name to use when trying to access + child objects of the collection this calendar is operating on. + |
+
+
+ void
+
+ |
+
+
+
+ setHrefFormat(<String> fmt)
+
+ + + Sets the format of the hrefs to render by this calendar + to the format pattern passed as argument. + |
+
+
+ void
+
+ |
+
+
+
+ setLocale(<java.util.Locale> loc)
+
+ + + Sets the locale to use within this calendar object + |
+
+
+ void
+
+ |
+
+
+
+ setRenderer(<Object> r)
+
+ + + Sets the renderer to use. + |
+
+
+ void
+
+ |
+
+
+
+ setTimeZone(tz)
+
+ + + Sets the locale to use within this calendar object + |
+
| + Constructor Detail + | +
jala.Date.Calendar(<HopObject> collection)+ + +
collection - A grouped HopObject collection to work on
+ | + Method Detail + | +
String getAccessNameFormat()+ +
String getCalendar(today)+ +
HopObject getCollection()+ +
String getHrefFormat()+ +
java.util.Locale getLocale()+ +
Object getRenderer()+ +
java.util.Locale getTimeZone()+ +
void render(today)+ +
void setAccessNameFormat(<String> fmt)+ +
fmt - The date format pattern to use for accessing child objects
+ void setHrefFormat(<String> fmt)+ +
fmt - The date format pattern to use for rendering the href
+ void setLocale(<java.util.Locale> loc)+ +
loc - The locale to use
+ void setRenderer(<Object> r)+ +
r - The renderer to use
+ void setTimeZone(tz)+ +
loc - The locale to use
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Date ++ + +
+
This class provides various convenience
+ methods for rendering purposes.
+
Defined in Date.js
+
| +Nested Class Summary | +|
+ <static class> |
+ jala.Date.Calendar |
+
| +Constructor Summary | +|
+
+
+ jala.Date
+
+ ()
+
+ + + Constructs a new Renderings object. + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ renderEditor(<String> prefix, <Date> date, <Object> fmt)
+
+ + + Renders a timestamp as set of DropDown boxes, following the + format passed as argument. + |
+
+
+ String
+
+ |
+
+
+
+ renderEditorAsString(prefix, date, pattern)
+
+ + + Returns a timestamp as set of dropdown-boxes + |
+
| + Constructor Detail + | +
jala.Date()+ + +
| + Method Detail + | +
void renderEditor(<String> prefix, <Date> date, <Object> fmt)+ +
prefix - The prefix to use for all dropdown boxes, eg. "postdate"
+ date - A Date object to use as preselection (optional)
+ fmt - Array containing one parameter object for every single select box that should be rendered, with the following properties set: String renderEditorAsString(prefix, date, pattern)+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.DnsClient.Record ++ + +
+
Instances of this class wrap record data as received
+ from the nameserver.
+
Defined in DnsClient.js
+
| + Field Summary | +|
+ String |
+ cname
+ + The CNAME of this record. |
+
+ String |
+ email
+ + The email address responsible for a name server. |
+
+ String |
+ host
+ + The name of the host. |
+
+ String |
+ ipAddress
+ + The IP address of the host. |
+
+ String |
+ mx
+ + The name of the mail exchanging server. |
+
+ String |
+ text
+ + Descriptive text as received from the nameserver. |
+
+ Number |
+ type
+ + The type of the nameserver record represented by this Answer instance. |
+
| +Constructor Summary | +|
+
+
+ jala.DnsClient.Record
+
+ (<org.wonderly.net.dns.RR> data)
+
+ + + Constructs a new instance of jala.DnsClient.Record. + |
+|
| +Method Summary | +|
+
+ org.wonderly.net.dns.RR
+
+ |
+
+
+
+ getData()
+
+ + + Returns the wrapped nameserver record data + |
+
| Field Detail | +
String cname+
String email+
String host+
String ipAddress+
String mx+
String text+
Number type+
| + Constructor Detail + | +
jala.DnsClient.Record(<org.wonderly.net.dns.RR> data)+ + +
data - The data as received from the nameserver
+ | + Method Detail + | +
org.wonderly.net.dns.RR getData()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.DnsClient ++ + +
+
This is a wrapper around the Dns Client by wonderly.org
+ providing methods for querying Dns servers. For more information
+ about the Java DNS client visit
+ https://javadns.dev.java.net/.
+ Please mind that the nameserver specified must accept queries on port
+ 53 TCP (the Java DNS client used doesn't support UDP nameserver queries),
+ and that reverse lookups are not supported.
+
Defined in DnsClient.js
+
| +Nested Class Summary | +|
+ <static class> |
+ jala.DnsClient.Record |
+
| + Field Summary | +|
+ String |
+ nameServer
+ + Contains the IP Adress/FQDN of the name server to query. |
+
+ <static> <final> Number |
+ TYPE_A
+ + The "A" record/query type. |
+
+ <static> <final> Number |
+ TYPE_CNAME
+ + The "CNAME" record/query type. |
+
+ <static> <final> Number |
+ TYPE_MX
+ + The "MX" record/query type. |
+
+ <static> <final> Number |
+ TYPE_NS
+ + The "NS" record/query type. |
+
+ <static> <final> Number |
+ TYPE_PTR
+ + The "PTR" record/query type. |
+
+ <static> <final> Number |
+ TYPE_SOA
+ + The "SOA" record/query type. |
+
+ <static> <final> Number |
+ TYPE_TXT
+ + The "TXT" record/query type. |
+
+ <static> <final> Number |
+ TYPE_WKS
+ + The "WKS" record/query type. |
+
| +Constructor Summary | +|
+
+
+ jala.DnsClient
+
+ (<String> nameServer)
+
+ + + Constructs a new DnsClient object. + |
+|
| +Method Summary | +|
+
+ org.wonderly.net.dns.RR
+
+ |
+
+
+
+ query(<String> dName, <Number> queryType)
+
+ + + Queries the nameserver for a specific domain + and the given type of record. + |
+
+
+ org.wonderly.net.dns.RR
+
+ |
+
+
+
+ queryMailHost(<String> dName)
+
+ + + Convenience method to query for the MX-records + of the domain passed as argument. + |
+
| Field Detail | +
String nameServer+
<static> <final> Number TYPE_A+
<static> <final> Number TYPE_CNAME+
<static> <final> Number TYPE_MX+
<static> <final> Number TYPE_NS+
<static> <final> Number TYPE_PTR+
<static> <final> Number TYPE_SOA+
<static> <final> Number TYPE_TXT+
<static> <final> Number TYPE_WKS+
| + Constructor Detail + | +
jala.DnsClient(<String> nameServer)+ + +
nameServer - IP-Address or FQDN of nameserver to query
+ | + Method Detail + | +
org.wonderly.net.dns.RR query(<String> dName, <Number> queryType)+ +
dName - The domain name to query for
+ queryType - The type of records to retrieve
+ org.wonderly.net.dns.RR queryMailHost(<String> dName)+ +
dName - The domain name to query for
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Button ++ +
+
Subclass of jala.Form.Component.Input which renders a button.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Button
+
+ (<String> name)
+
+ + + Creates a new Button component instance + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ render(<Object> attr, <Object> value, <Object> reqData)
+
+ + + Renders a button to the response. + |
+
+
+ Object
+
+ |
+
+
+
+ renderControls(attr, value)
+
+ + + Creates a new attribute object for this button. + |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, checkRequirements, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Button(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
void render(<Object> attr, <Object> value, <Object> reqData)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+ reqData - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
+ Object renderControls(attr, value)+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Checkbox ++ + +
+
Subclass of jala.Form.Component.Input which renders and validates a
+ checkbox.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Checkbox
+
+ (<String> name)
+
+ + + Creates a new Checkbox component instance + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ checkRequirements(<Object> reqData)
+
+ + + Validates user input from checkbox. + |
+
+
+ Number
+
+ |
+
+
+
+ parseValue(<Object> reqData)
+
+ + + Parses the string input from the form. + |
+
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value, reqData)
+
+ + + Renders an checkbox to the response. + |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, render, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Checkbox(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
String checkRequirements(<Object> reqData)+ +
reqData - request data
+ Number parseValue(<Object> reqData)+ +
reqData - request data
+ void renderControls(<Object> attr, <Object> value, reqData)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Date ++ + +
+
Subclass of jala.Form.Component.Input which renders and validates a
+ date editor.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Date
+
+ (<String> name)
+
+ + + Constructs a new Date component instance + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ checkRequirements(<Object> reqData)
+
+ + + Validates user input from a date editor. + |
+
+
+ Date
+
+ |
+
+
+
+ parseValue(<Object> reqData)
+
+ + + Parses the string input from the form and converts it to a date object. + |
+
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value, <Object> reqData)
+
+ + + Renders a textarea tag to the response. + |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, render, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Date(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
String checkRequirements(<Object> reqData)+ +
reqData - request data
+ Date parseValue(<Object> reqData)+ +
reqData - request data
+ void renderControls(<Object> attr, <Object> value, <Object> reqData)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+ reqData - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Fieldset ++ + +
+
Instances of this class represent a form fieldset containing
+ numerous form components
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Fieldset
+
+ (<String> name)
+
+ + + Constructs a new Fieldset instance + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ render()
+
+ + + Renders all components within the fieldset. + |
+
+
+ void
+
+ |
+
+
+
+ save(<jala.Form.Tracker> tracker, <Object> destObj)
+
+ + + Saves all components within the fieldset. + |
+
+
+ void
+
+ |
+
+
+
+ validate(<jala.Form.Tracker> tracker)
+
+ + + Validates all components within the fieldset. + |
+
| + Constructor Detail + | +
jala.Form.Component.Fieldset(<String> name)+ + +
name - The name of the fieldset
+ | + Method Detail + | +
void render()+ +
void save(<jala.Form.Tracker> tracker, <Object> destObj)+ +
tracker -
+ destObj -
+ void validate(<jala.Form.Tracker> tracker)+ +
tracker -
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.File ++ +
+
Subclass of jala.Form.Component.Input which renders and validates a
+ file upload.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.File
+
+ (<String> name)
+
+ + + Creates a new File component instance + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ checkRequirements(<Object> reqData)
+
+ + + Validates a file upload by making sure it's there (if REQUIRE is set), + checking the file size, the content type and by trying to construct an image. + |
+
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value, <Object> reqData)
+
+ + + Renders a file input tag to the response. + |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, render, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.File(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
String checkRequirements(<Object> reqData)+ +
reqData - request data
+ tracker - jala.Form.Tracker object storing possible error messages
+ void renderControls(<Object> attr, <Object> value, <Object> reqData)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+ reqData - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Hidden ++ + +
+
Subclass of jala.Form.Component.Input which renders and validates a
+ hidden input tag.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Hidden
+
+ (<String> name)
+
+ + + Constructs a newly created Hidden component instance + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ render()
+
+ + + Renders this component directly to response. + |
+
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value, <Object> reqData)
+
+ + + Renders a hidden input tag to the response. + |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, checkRequirements, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Hidden(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
void render()+ +
void renderControls(<Object> attr, <Object> value, <Object> reqData)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+ reqData - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.File + | + +--jala.Form.Component.Image ++ + +
+
Subclass of jala.Form.Component.File which renders a file upload
+ and validates uploaded files as images.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Image
+
+ ()
+
+ + + Creates a new Image component instance + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ checkRequirements(<Object> reqData)
+
+ + + Validates an image upload by making sure it's there (if REQUIRE is set), + checking the file size, the content type and by trying to construct an image. + |
+
| Methods inherited from class jala.Form.Component.File | +
+
+renderControls
+ |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, render, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Image()+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
String checkRequirements(<Object> reqData)+ +
reqData - request data
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input ++ +
+
Instances of this class represent a single form input field.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Input
+
+ (<String> name)
+
+ + + Creates a new input component instance. + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ checkLength(<Object> reqData)
+
+ + + Checks user input for maximum length, minimum length and require + if the corresponding options have been set using the require method. + |
+
+
+ String
+
+ |
+
+
+
+ checkRequirements(<Object> reqData)
+
+ + + Checks user input against options set using the require method. + |
+
+
+ void
+
+ |
+
+
+
+ class_macro()
+
+ + + Renders this component's class name. + |
+
+
+ void
+
+ |
+
+
+
+ controls_macro()
+
+ + + Renders the control(s) of this component + |
+
+
+ void
+
+ |
+
+
+
+ error_macro()
+
+ + + Renders this component's error message (if set) directly to response + |
+
+
+ Object
+
+ |
+
+
+
+ getControlAttributes()
+
+ + + Creates a new attribute object for this element. + |
+
+
+ String|Number|Date
+
+ |
+
+
+
+ getValue()
+
+ + + Retrieves the property which is edited by this component. + |
+
+
+ void
+
+ |
+
+
+
+ help_macro()
+
+ + + Renders this component's help text, if set. + |
+
+
+ void
+
+ |
+
+
+
+ id_macro()
+
+ + + Renders this component's id + |
+
+
+ void
+
+ |
+
+
+
+ label_macro()
+
+ + + Renders this component's label. + |
+
+
+ void
+
+ |
+
+
+
+ name_macro()
+
+ + + Renders this component's name + |
+
+
+ Object
+
+ |
+
+
+
+ parseValue(<Object> reqData)
+
+ + + Parses the string input from the form and creates the datatype that + is edited with this component. + |
+
+
+ void
+
+ |
+
+
+
+ render()
+
+ + + Renders this component including label, error and help messages directly + to response. + |
+
+
+ void
+
+ |
+
+
+
+ render_macro()
+
+ + + Renders this component including label, error and help messages + directly to response + |
+
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value, <Object> reqData)
+
+ + + Renders the html form elements to the response. + |
+
+
+ String
+
+ |
+
+
+
+ renderError()
+
+ + + If the error tracker holds an error message for this component, + it is wrapped in a div-tag and returned as a string. + |
+
+
+ String
+
+ |
+
+
+
+ renderHelp()
+
+ + + If this component contains a help message, it is wrapped in + a div-tag and returned as a string. + |
+
+
+ String
+
+ |
+
+
+
+ renderLabel()
+
+ + + Returns the rendered label of this component + |
+
+
+ void
+
+ |
+
+
+
+ save(<jala.Form.Tracker> tracker, <Object> destObj)
+
+ + + Saves the parsed value using setValue. + |
+
+
+ Object
+
+ |
+
+
+
+ setValue(<Object> destObj, <Object> value)
+
+ + + Sets a property of the object passed as argument to the given value. + |
+
+
+ void
+
+ |
+
+
+
+ type_macro()
+
+ + + Renders this component's type + |
+
+
+ void
+
+ |
+
+
+
+ validate(<jala.Form.Tracker> tracker)
+
+ + + Validates the input provided to this component. + |
+
| + Constructor Detail + | +
jala.Form.Component.Input(<String> name)+ + +
name - Name of the component, used as name of the html control.
+ | + Method Detail + | +
String checkLength(<Object> reqData)+ +
reqData - request data
+ String checkRequirements(<Object> reqData)+ +
reqData - request data
+ void class_macro()+ +
void controls_macro()+ +
void error_macro()+ +
Object getControlAttributes()+ +
String|Number|Date getValue()+ +
void help_macro()+ +
void id_macro()+ +
void label_macro()+ +
void name_macro()+ +
Object parseValue(<Object> reqData)+ +
reqData - request data
+ void render()+ +
void render_macro()+ +
void renderControls(<Object> attr, <Object> value, <Object> reqData)+ +
attr - Basic attributes for the html form elements.
+ value - Value to be used for rendering this element.
+ reqData - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
+ String renderError()+ +
String renderHelp()+ +
String renderLabel()+ +
void save(<jala.Form.Tracker> tracker, <Object> destObj)+ +
tracker - Tracker object collecting request data, error messages and parsed values.
+ destObj - (optional) object whose values will be changed.
+ Object setValue(<Object> destObj, <Object> value)+ +
destObj - (optional) object whose values will be changed.
+ value - The value to set the property to
+ void type_macro()+ +
void validate(<jala.Form.Tracker> tracker)+ +
tracker - Tracker object collecting request data, error messages and parsed values.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Password ++ + +
+
Subclass of jala.Form.Component.Input which renders and validates a
+ password input tag.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Password
+
+ (<String> name)
+
+ + + Constructs a newly created Password component instance + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value, <Object> reqData)
+
+ + + Renders a password input tag to the response. + |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, render, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, checkRequirements, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Password(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
void renderControls(<Object> attr, <Object> value, <Object> reqData)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+ reqData - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Select + | + +--jala.Form.Component.Radio ++ + +
+
Subclass of jala.Form.Component.Input which renders and validates a
+ set of radio buttons.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Radio
+
+ (<String> name)
+
+ + + Creates a new Radio component instance + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ checkRequirements(<Object> reqData)
+
+ + + Validates user input from a set of radio buttons and makes sure that + option value list contains the user input. + |
+
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value)
+
+ + + Renders a set of radio buttons to the response. + |
+
| Methods inherited from class jala.Form.Component.Select | +
+
+parseOptions, checkOptions
+ |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, render, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Radio(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
String checkRequirements(<Object> reqData)+ +
reqData - request data
+ void renderControls(<Object> attr, <Object> value)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Select ++ +
+
Subclass of jala.Form.Component.Input which renders and validates a
+ dropdown element.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Select
+
+ (<String> name)
+
+ + + Constructs a new Select component instance + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ checkOptions(<Object> reqData)
+
+ + + Checks user input for optiongroups: Unless require("checkoptions") + has ben set to false, the user input must exist in the option array. + |
+
+
+ String
+
+ |
+
+
+
+ checkRequirements(<Object> reqData)
+
+ + + Validates user input from a dropdown element by making sure that + the option value list contains the user input. + |
+
+
+ Array
+
+ |
+
+
+
+ parseOptions()
+
+ + + Creates an array of options for a dropdown element or a + group of radiobuttons. + |
+
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value, <Object> reqData)
+
+ + + Renders a dropdown element to the response. + |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, render, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Select(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
String checkOptions(<Object> reqData)+ +
reqData - request data
+ String checkRequirements(<Object> reqData)+ +
reqData - request data
+ Array parseOptions()+ +
void renderControls(<Object> attr, <Object> value, <Object> reqData)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+ reqData - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component + | + +--jala.Form.Component.Skin ++ + +
+
Subclass of jala.Form.Component that allows rendering a skin
+ within a form.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Skin
+
+ (<String> name)
+
+ + + + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ render()
+
+ + + Renders the skin named by this component to the response. + |
+
| Methods inherited from class jala.Form.Component | +
+
+createDomId, validate, save
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Skin(<String> name)+ + + + +
name - The name of the component, used as the name of the skin
+ | + Method Detail + | +
void render()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Button + | + +--jala.Form.Component.Submit ++ + +
+
Subclass of jala.Form.Component.Button which renders a submit button.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Submit
+
+ (<String> name)
+
+ + + Creates a new Submit component instance + |
+|
| +Method Summary | +|
+
+ Object
+
+ |
+
+
+
+ renderControls(attr, value)
+
+ + + Creates a new attribute object for this button. + |
+
| Methods inherited from class jala.Form.Component.Button | +
+
+render
+ |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, checkRequirements, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Submit(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
Object renderControls(attr, value)+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component.Input + | + +--jala.Form.Component.Textarea ++ + +
+
Subclass of jala.Form.Component.Input which renders and validates a
+ textarea input field.
+
Defined in Form.js
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component.Textarea
+
+ (<String> name)
+
+ + + Constructs a new Textarea component. + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ renderControls(<Object> attr, <Object> value, <Object> reqData)
+
+ + + Renders a textarea input field to the response. + |
+
| Methods inherited from class jala.Form.Component.Input | +
+
+validate, save, getValue, setValue, render, renderError, renderLabel, renderHelp, render_macro, controls_macro, error_macro, label_macro, help_macro, id_macro, name_macro, type_macro, class_macro, getControlAttributes, checkLength, checkRequirements, parseValue
+ |
+
| + Constructor Detail + | +
jala.Form.Component.Textarea(<String> name)+ + +
name - Name of the component, used as name of the html controls.
+ | + Method Detail + | +
void renderControls(<Object> attr, <Object> value, <Object> reqData)+ +
attr - Basic attributes for this element.
+ value - Value to be used for rendering this element.
+ reqData - Request data for the whole form. This argument is passed only if the form is re-rendered after an error occured.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Component ++ +
+ Defined in Form.js
+
| +Nested Class Summary | +|
+ <static class> |
+ jala.Form.Component.Fieldset |
+
+ <static class> |
+ jala.Form.Component.Skin |
+
+ <static class> |
+ jala.Form.Component.Input |
+
+ <static class> |
+ jala.Form.Component.Password |
+
+ <static class> |
+ jala.Form.Component.Hidden |
+
+ <static class> |
+ jala.Form.Component.Textarea |
+
+ <static class> |
+ jala.Form.Component.Date |
+
+ <static class> |
+ jala.Form.Component.Select |
+
+ <static class> |
+ jala.Form.Component.Radio |
+
+ <static class> |
+ jala.Form.Component.Checkbox |
+
+ <static class> |
+ jala.Form.Component.File |
+
+ <static class> |
+ jala.Form.Component.Image |
+
+ <static class> |
+ jala.Form.Component.Button |
+
+ <static class> |
+ jala.Form.Component.Submit |
+
| +Constructor Summary | +|
+
+
+ jala.Form.Component
+
+ (name)
+
+ + + The abstract base class for all components. + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ createDomId(<String> idPart)
+
+ + + Creates a DOM identifier based on the name of the form, + the name of the component and an additional string. + |
+
+
+ void
+
+ |
+
+
+
+ render()
+
+ + + Function to render a component. + |
+
+
+ void
+
+ |
+
+
+
+ save(destObj, val)
+
+ + + Function to save the data of a component. + |
+
+
+ Object
+
+ |
+
+
+
+ validate(<jala.Form.Tracker> tracker)
+
+ + + Function to validate a component. + |
+
| + Constructor Detail + | +
jala.Form.Component(name)+ + +
| + Method Detail + | +
String createDomId(<String> idPart)+ +
idPart - Optional string appended to component's id.
+ void render()+ +
void save(destObj, val)+ +
Object validate(<jala.Form.Tracker> tracker)+ +
tracker - object tracking errors and holding parsed values and request data.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form.Tracker ++ + +
+
Instances of this class can contain error-messages and values
+
Defined in Form.js
+
| + Field Summary | +|
+ Object |
+ errors
+ + A map containing error messages |
+
+ Object |
+ reqData
+ + A map containing input from request data |
+
+ Object |
+ values
+ + A map containing parsed values (only for those fields that didn't + fail during checkRequirements method). |
+
| +Constructor Summary | +|
+
+
+ jala.Form.Tracker
+
+ (reqData)
+
+ + + A generic container for error-messages and values + |
+|
| +Method Summary | +|
+
+ Number
+
+ |
+
+
+
+ countErrors()
+
+ + + Returns the number of components for which this instance has + tracked an error. + |
+
+
+ Boolean
+
+ |
+
+
+
+ hasError()
+
+ + + Returns true if an error has been set for at least one component. + |
+
| Field Detail | +
Object errors+
Object reqData+
Object values+
| + Constructor Detail + | +
jala.Form.Tracker(reqData)+ + +
| + Method Detail + | +
Number countErrors()+ +
Boolean hasError()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Form ++ + +
+
A class that renders forms, validates submitted form data and
+ stores the data in a specified object.
+
Defined in Form.js
+
| +Nested Class Summary | +|
+ <static class> |
+ jala.Form.Component |
+
+ <static class> |
+ jala.Form.Tracker |
+
| + Field Summary | +|
+ Skin |
+ componentSkin
+ + Contains the default component skin |
+
+ String |
+ name
+ + Readonly reference to the name of the form |
+
+ <static> <final> String |
+ CHECKOPTIONS
+ + Constant used by require function to define that a select or + radio component should validate only if the user input is contained + in the list of options provided. |
+
+ <static> <final> String |
+ CONTENTTYPE
+ + Constant used by require function to define that a file upload + component should validate only if the file's content type is + in the list of allowed content types provided. |
+
+ <static> helma.Html |
+ html
+ + The HTML renderer used by jala.Form |
+
+ <static> <final> String |
+ MAXHEIGHT
+ + Constant used by require function to define that an image upload + component should validate only if the image's height is less than + the value provided. |
+
+ <static> <final> String |
+ MAXLENGTH
+ + Constant used by require function to define that a component + should not validate if userinput exceeds a maximum length. |
+
+ <static> <final> String |
+ MAXWIDTH
+ + Constant used by require function to define that an image upload + component should validate only if the image's width is less than + the value provided. |
+
+ <static> <final> String |
+ MINHEIGHT
+ + Constant used by require function to define that an image upload + component should validate only if the image's height is more than + the value provided. |
+
+ <static> <final> String |
+ MINLENGTH
+ + Constant used by require function to define that a component + should not validate if userinput is shorter than a given length. |
+
+ <static> <final> String |
+ MINWIDTH
+ + Constant used by require function to define that an image upload + component should validate only if the image's width is more than + the value provided. |
+
+ <static> <final> String |
+ REQUIRE
+ + Constant used by require function to define that a component + should validate only if the user did provide input. |
+
| +Constructor Summary | +|
+
+
+ jala.Form
+
+ (<String> name, <Object> dataObj)
+
+ + + Constructs a new Form instance + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ addComponent(<jala.Form.Component.Input> component)
+
+ + + Adds a component to this jala.Form instance + |
+
+
+ String
+
+ |
+
+
+
+ class_macro()
+
+ + + Returns the class name of the form + |
+
+
+ void
+
+ |
+
+
+
+ close_macro()
+
+ + + Writes the form closing tag to response + |
+
+
+ Boolean
+
+ |
+
+
+
+ containsFileUpload()
+
+ + + Returns true if this instance of jala.Form contains at least + one component doing a file upload. + |
+
+
+ Number
+
+ |
+
+
+
+ countErrors()
+
+ + + If this instance of jala.Form holds a jala.Form.Tracker + instance it returns the number of components that didn't + validate. + |
+
+
+ String
+
+ |
+
+
+
+ createDomId()
+
+ + + Creates a DOM identifier based on the arguments passed. + |
+
+
+ String
+
+ |
+
+
+
+ getClassName()
+
+ + + Returns the class name set for this form instance. + |
+
+
+ Object
+
+ |
+
+
+
+ getDataObject()
+
+ + + Returns the data object containing the values used + for rendering the form. + |
+
+
+ String
+
+ |
+
+
+
+ getErrorMessage()
+
+ + + Returns the general error message printed above the form + if any of the components didn't validate. + |
+
+
+ jala.Form.Tracker
+
+ |
+
+
+
+ getTracker()
+
+ + + Returns the tracker object this form instance uses for collecting + error messages and parsed values. + |
+
+
+ Boolean
+
+ |
+
+
+
+ handle(<Object> reqData, <Object> destObj)
+
+ + + Parses form input, applies check functions and stores the values + if the form does validate. + |
+
+
+ Boolean
+
+ |
+
+
+
+ hasError()
+
+ + + Returns true if this instance of jala.Form holds a jala.Form.Tracker + instance and at least one error has been set on this tracker. + |
+
+
+ String
+
+ |
+
+
+
+ id_macro()
+
+ + + Returns the id (equal to the name) of the form + |
+
+
+ Array
+
+ |
+
+
+
+ listComponents()
+
+ + + Returns an array containing the components + of this jala.Form instance. + |
+
+
+ String
+
+ |
+
+
+
+ name_macro()
+
+ + + Returns the name (equal to the id) of the form + |
+
+
+ void
+
+ |
+
+
+
+ open_macro()
+
+ + + Writes the form opening tag to response + |
+
+
+ void
+
+ |
+
+
+
+ render()
+
+ + + Renders this form including all components to response. + |
+
+
+ void
+
+ |
+
+
+
+ render_macro()
+
+ + + Renders the whole form to response + |
+
+
+ String
+
+ |
+
+
+
+ renderAsString(param)
+
+ + + renders the form as a string + |
+
+
+ void
+
+ |
+
+
+
+ save(<jala.Form.Tracker> tracker, <Object> destObj)
+
+ + + Sets the parsed values on an object. + |
+
+
+ void
+
+ |
+
+
+
+ setClassName(<String> newClassName)
+
+ + + Sets an extra classname for this form instance + |
+
+
+ void
+
+ |
+
+
+
+ setDataObject(newDataObj)
+
+ + + Sets the data object which is being edited by this form. + |
+
+
+ void
+
+ |
+
+
+
+ setErrorMessage(<String> newErrorMessage)
+
+ + + Sets the general error message printed above the form if any + of the components didn't validate. + |
+
+
+ void
+
+ |
+
+
+
+ setTracker(<jala.Form.Tracker> newTracker)
+
+ + + Sets the tracker object this form instance uses for collecting + error messages and parsed values. + |
+
+
+ jala.Form.Tracker
+
+ |
+
+
+
+ validate(<Object> reqData)
+
+ + + Validates user input from a submitted form by calling each + component's validate method. + |
+
+
+ <static> jala.Form
+
+ |
+
+
+
+ create(<Object> config, dataObj)
+
+ + + Parses a plain javascript object tree and configures a + new jala.Form instance according to the properties. + |
+
+
+ <static> void
+
+ |
+
+
+
+ extend(<Function> subClass, <Function> superClass)
+
+ + + Utility to set up the prototype, constructor, superclass and superconstructor + properties to support an inheritance strategy that can chain constructors and methods. + |
+
+
+ <static> String
+
+ |
+
+
+
+ isEmail(<String> name, <String> value, <Object> reqData, <jala.Form> formObj)
+
+ + + Static validator function to test values for being a valid email address. + |
+
+
+ <static> String
+
+ |
+
+
+
+ isUrl(<String> name, <String> value, <Object> reqData, <jala.Form> formObj)
+
+ + + Static validator function to test values for being a valid url. + |
+
+
+ <static> Object
+
+ |
+
+
+
+ propertyGetter(<String> name, value)
+
+ + + static default getter function used to return a field + from the data object. + |
+
+
+ <static> void
+
+ |
+
+
+
+ propertySetter(<String> name, <Object> value)
+
+ + + static default setter function used to change a field + of the data object. + |
+
| Field Detail | +
Skin componentSkin+
String name+
<static> <final> String CHECKOPTIONS+
+
<static> <final> String CONTENTTYPE+
+
<static> helma.Html html+
<static> <final> String MAXHEIGHT+
+
<static> <final> String MAXLENGTH+
+
<static> <final> String MAXWIDTH+
+
<static> <final> String MINHEIGHT+
+
<static> <final> String MINLENGTH+
+
<static> <final> String MINWIDTH+
+
<static> <final> String REQUIRE+
+
| + Constructor Detail + | +
jala.Form(<String> name, <Object> dataObj)+ + +
name - The name of the form
+ dataObj - An optional object used to retrieve values to display in the form input fields contained in this Form instance.
+ | + Method Detail + | +
void addComponent(<jala.Form.Component.Input> component)+ +
component -
+ String class_macro()+ +
void close_macro()+ +
Boolean containsFileUpload()+ +
Number countErrors()+ +
String createDomId()+ +
String getClassName()+ +
Object getDataObject()+ +
String getErrorMessage()+ +
jala.Form.Tracker getTracker()+ +
Boolean handle(<Object> reqData, <Object> destObj)+ +
reqData - input from form
+ destObj - object whose values should be chanegd
+ Boolean hasError()+ +
String id_macro()+ +
Array listComponents()+ +
String name_macro()+ +
void open_macro()+ +
void render()+ +
void render_macro()+ +
String renderAsString(param)+ +
void save(<jala.Form.Tracker> tracker, <Object> destObj)+ +
tracker - (optional) tracker object holding parsed data from form input.
+ destObj - (optional) object whose values will be changed. By default the dataObj passed to the constructor or to setDataObject is used.
+ void setClassName(<String> newClassName)+ +
newClassName - new classname
+ void setDataObject(newDataObj)+ +
dataObj - The object which is being edited by this form.
+ void setErrorMessage(<String> newErrorMessage)+ +
newErrorMessage - error message
+ void setTracker(<jala.Form.Tracker> newTracker)+ +
newTracker -
+ jala.Form.Tracker validate(<Object> reqData)+ +
reqData - Optional submitted form data. If not specified req.data is used.
+ <static> jala.Form create(<Object> config, dataObj)+ +
config - object tree containing config
+ <static> void extend(<Function> subClass, <Function> superClass)+ +
subClass - the object which inherits superClass' functions
+ superClass - the object to inherit
+ <static> String isEmail(<String> name, <String> value, <Object> reqData, <jala.Form> formObj)+ +
name - name of the property being validated.
+ value - value in form input
+ reqData - the whole request-data-object, in case properties depend on each other
+ formObj - instance of jala.Form
+ <static> String isUrl(<String> name, <String> value, <Object> reqData, <jala.Form> formObj)+ +
name - name of the property being validated.
+ value - value in form input
+ reqData - the whole request-data-object, in case properties depend on each other
+ formObj - instance of jala.Form
+ <static> Object propertyGetter(<String> name, value)+ +
name - Name of the property.
+ <static> void propertySetter(<String> name, <Object> value)+ +
name - Name of the property.
+ value - New value of the property.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.History ++ + +
+
This class is an implementation of a Browser-like history
+ stack suitable to use in any Helma application. The difference
+ to a Browser's history is that this implementation ignores
+ POST requests and checks if Urls in the stack are still valid to
+ prevent eg. redirections to a HopObject's url that has been deleted.
+ Plus it is capable to create new "intermediate" history-stacks
+ and this way maintain a "history of histories" which is needed for
+ eg. editing sessions in a popup window that should use their own
+ request history without interfering with the history of the
+ main window.
+
Defined in History.js
+
| +Constructor Summary | +|
+
+
+ jala.History
+
+ ()
+
+ + + Constructs a new History object. + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ add()
+
+ + + Initializes a new history stack, adds + it to the array of stacks (which makes it + the default one to use for further requests) + and records the current request Url. + |
+
+
+ void
+
+ |
+
+
+
+ clear()
+
+ + + Clears the currently active history stack + |
+
+
+ String
+
+ |
+
+
+
+ dump()
+
+ + + Returns the contents of all history stacks + as string + |
+
+
+ String
+
+ |
+
+
+
+ peek(<Number> offset)
+
+ + + Retrieves the request Url at the given position + in the current history stack. + |
+
+
+ String
+
+ |
+
+
+
+ pop(<Number> offset)
+
+ + + Retrieves the first valid request Url in history + stack starting with a given offset. + |
+
+
+ void
+
+ |
+
+
+
+ push()
+
+ + + Records a request Url in the currently active + history stack. + |
+
+
+ void
+
+ |
+
+
+
+ redirect(<Number> offset)
+
+ + + Redirects the client back to the first valid + request in history. + |
+
+
+ void
+
+ |
+
+
+
+ remove()
+
+ + + Removes the current history stack + |
+
| + Constructor Detail + | +
jala.History()+ + +
| + Method Detail + | +
void add()+ +
void clear()+ +
String dump()+ +
String peek(<Number> offset)+ +
offset - The index position in history stack to start searching at
+ String pop(<Number> offset)+ +
offset - The index position in history stack to start searching at
+ void push()+ +
void redirect(<Number> offset)+ +
offset - The index position in the stack to start searching at
+ void remove()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.HtmlDocument ++ + +
+
This class provides easy access to the elements of
+ an arbitrary HTML document. By using TagSoup, Dom4J and Jaxen
+ even invalid HTML can be parsed, turned into an object tree
+ and easily be processed with XPath expressions.
+
Defined in HtmlDocument.js
+
| +Constructor Summary | +|
+
+
+ jala.HtmlDocument
+
+ (<String> source)
+
+ + + Construct a new HTML document. + |
+|
| +Method Summary | +|
+
+ Array
+
+ |
+
+
+
+ getAll(<String> elementName)
+
+ + + Retrieves all elements by name from the document. + |
+
+
+ Array
+
+ |
+
+
+
+ getLinks()
+
+ + + Get all link elements of the HTML document. + |
+
+
+ org.dom4j.tree.DefaultElement
+
+ |
+
+
+
+ scrape(<String> xpathExpr)
+
+ + + Get all document nodes from an XPath expression. + |
+
+
+ String
+
+ |
+
+
+
+ toString()
+
+ + + Get a string representation of the HTML document. + |
+
| + Constructor Detail + | +
jala.HtmlDocument(<String> source)+ + +
source - The HTML source code.
+ | + Method Detail + | +
Array getAll(<String> elementName)+ +
elementName - The name of the desired element
+ Array getLinks()+ +
org.dom4j.tree.DefaultElement scrape(<String> xpathExpr)+ +
xpathExpr - An XPath expression.
+ String toString()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.I18n ++ + +
+
This class provides various functions and macros for
+ internationalization of Helma applications.
+
Defined in I18n.js
+
| +Constructor Summary | +|
+
+
+ jala.I18n
+
+ ()
+
+ + + Constructs a new instance of jala.I18n + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ formatMessage(<String> message, <Array> values)
+
+ + + Converts the message passed as argument into an instance + of java.text.MessageFormat, and formats it using the + replacement values passed. + |
+
+
+ Object
+
+ |
+
+
+
+ getCatalog(locale)
+
+ + + Helper method to get the message catalog + corresponding to the actual locale. + |
+
+
+ java.util.Locale
+
+ |
+
+
+
+ getLocale(localeId)
+
+ + + Returns the locale for the given id, which is expected to follow + the form language[_COUNTRY][_variant], where language
+ is a valid ISO Language Code (eg.
+ |
+
+
+ Function
+
+ |
+
+
+
+ getLocaleGetter()
+
+ + + Get the method for retrieving the locale. + |
+
+
+ Object
+
+ |
+
+
+
+ getMessages()
+
+ + + Get the message object. + |
+
+
+ String
+
+ |
+
+
+
+ gettext(<String> key )
+
+ + + Returns a localized message for the message key passed as + argument. + |
+
+
+ String
+
+ |
+
+
+
+ markgettext(<String> key)
+
+ + + A simple proxy method which is used to mark a message string + for the i18n parser as to be translated. + |
+
+
+ String
+
+ |
+
+
+
+ message_macro(param)
+
+ + + Returns a translated message. + |
+
+
+ String
+
+ |
+
+
+
+ ngettext(<String> singularKey, <String> pluralKey, <Number> amount )
+
+ + + Returns a localized message for the message key passed as + argument. + |
+
+
+ void
+
+ |
+
+
+
+ setHandler(<Object> handler)
+
+ + + Set (overwrite) the default handler containing + the messages (ie. + |
+
+
+ void
+
+ |
+
+
+
+ setLocaleGetter(<Function> func)
+
+ + + Set the method for retrieving the locale. + |
+
+
+ void
+
+ |
+
+
+
+ setMessages(<Object> msgObject)
+
+ + + Overwrite the default object containing + the messages (ie. + |
+
+
+ String
+
+ |
+
+
+
+ translate(singularKey, pluralKey, <Number> amount)
+
+ + + Tries to "translate" the given message key into a localized + message. + |
+
| + Constructor Detail + | +
jala.I18n()+ + +
| + Method Detail + | +
String formatMessage(<String> message, <Array> values)+ +
message - The message to format
+ values - An optional array containing replacement values
+ Object getCatalog(locale)+ +
java.util.Locale getLocale(localeId)+ +
language[_COUNTRY][_variant], where language
+ is a valid ISO Language Code (eg. "de"), COUNTRY a valid ISO
+ Country Code (eg. "AT"), and variant an identifier for the variant to use.Function getLocaleGetter()+ +
Object getMessages()+ +
String gettext(<String> key )+ +
number must
+ match the number of the additional argument (starting with zero).key - The message to localize
+ String markgettext(<String> key)+ +
key - The message that should be seen by the i18n parser as to be translated.
+ String message_macro(param)+ +
String ngettext(<String> singularKey, <String> pluralKey, <Number> amount )+ +
number must
+ match the number of the additional argument (starting with zero).singularKey - The singular message to localize
+ pluralKey - The plural form of the message to localize
+ amount - The amount which is used to determine whether the singular or plural form of the message should be returned.
+ void setHandler(<Object> handler)+ +
handler - The handler containing the message object
+ void setLocaleGetter(<Function> func)+ +
func - The getter method
+ void setMessages(<Object> msgObject)+ +
msgObject - The object containing the messages
+ String translate(singularKey, pluralKey, <Number> amount)+ +
amount - A number to determine whether to use the singular or plural form of the message
+ key - The message to translate (required)
+ plural - The plural form of the message to translate
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.ImageFilter ++ + +
+
This class provides several image manipulating
+ methods. Most of this filter library is based on filters created
+ by Janne Kipinä for JAlbum. For more information have a look
+ at http://www.ratol.fi/~jakipina/java/
+
Defined in ImageFilter.js
+
| +Constructor Summary | +|
+
+
+ jala.ImageFilter
+
+ (<Object> img)
+
+ + + Constructs a new ImageFilter object + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ gaussianBlur(<Number> radius, <Number> amount)
+
+ + + Performs a gaussian blur operation on the image + |
+
+
+ byte[]
+
+ |
+
+
+
+ getBytes()
+
+ + + Returns the wrapped image as byte array, to use eg. + |
+
+
+ helma.image.ImageWrapper
+
+ |
+
+
+
+ getImage()
+
+ + + Returns the image that has been worked on + |
+
+
+ void
+
+ |
+
+
+
+ sharpen(<Number> amount)
+
+ + + Sharpens the image using a plain sharpening kernel. + |
+
+
+ void
+
+ |
+
+
+
+ unsharpMask(<Number> radius, <Number> amount)
+
+ + + Performs an unsharp mask operation on the image + |
+
| + Constructor Detail + | +
jala.ImageFilter(<Object> img)+ + +
img - Either | + Method Detail + | +
void gaussianBlur(<Number> radius, <Number> amount)+ +
radius - The radius
+ amount - The amount
+ byte[] getBytes()+ +
helma.image.ImageWrapper getImage()+ +
void sharpen(<Number> amount)+ +
amount - The amount of sharpening to apply
+ void unsharpMask(<Number> radius, <Number> amount)+ +
radius - The radius
+ amount - The amount
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.IndexManager.Job ++ + +
+
Instances of this class represent a single index
+ manipulation job to be processed by the index manager.
+
Defined in IndexManager.js
See:
| + Field Summary | +|
+ Object |
+ callback
+ + The data needed to process this job. |
+
+ Date |
+ createtime
+ + The date and time at which this job was created. |
+
+ Number |
+ errors
+ + An internal error counter which is increased whenever processing + the job failed. |
+
+ Number |
+ type
+ + The type of the job |
+
+ <static> <final> Number |
+ ADD
+ + Constant defining an add job |
+
+ <static> <final> Number |
+ OPTIMIZE
+ + Constant defining an optimizing job |
+
+ <static> <final> Number |
+ REMOVE
+ + Constant defining a removal job |
+
| +Constructor Summary | +|
+
+
+ jala.IndexManager.Job
+
+ (<Number> type, callback)
+
+ + + Creates a new Job instance. + |
+|
| Field Detail | +
Object callback+
Date createtime+
Number errors+
Number type+
<static> <final> Number ADD+
+
<static> <final> Number OPTIMIZE+
+
<static> <final> Number REMOVE+
+
| + Constructor Detail + | +
jala.IndexManager.Job(<Number> type, callback)+ + +
type - The type of job, which can be either jala.IndexManager.Job.ADD, jala.IndexManager.Job.REMOVE or jala.IndexManager.Job.OPTIMIZE.
+ id - The Id of the job
+ data - The data needed to process the job.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.IndexManager ++ + +
+
This class basically sits on top of a helma.Search.Index instance
+ and provides methods for adding, removing and optimizing the underlying index.
+ All methods generate jobs that are put into an internal queue which is
+ processed asynchronously by a separate worker thread. This means all calls
+ to add(), remove() and optimize() will return immediately, but the changes to
+ the index will be done within a short delay. Please keep in mind to change the
+ status of this IndexManager instance to REBUILDING before starting to rebuild
+ the index, as this ensures that all add/remove/optimize jobs will stay in the
+ queue and will only be processed after switching the status back to NORMAL.
+ This ensures that objects that have been modified during a rebuilding process
+ are re-indexed properly afterwards.
+
Defined in IndexManager.js
See:
| +Nested Class Summary | +|
+ <static class> |
+ jala.IndexManager.Job |
+
| + Field Summary | +|
+ <static> <final> Number |
+ MAXTRIES
+ + Constant defining the maximum number of tries to add/remove + an object to/from the underlying index. |
+
+ <static> <final> Number |
+ NORMAL
+ + Constant defining normal mode of this index manager. |
+
+ <static> <final> Number |
+ REBUILDING
+ + Constant defining rebuilding mode of this index manager. |
+
| +Constructor Summary | +|
+
+
+ jala.IndexManager
+
+ (<String> name, <helma.File> dir, <String> lang)
+
+ + + Constructs a new IndexManager object. + |
+|
| +Method Summary | +|
+
+ Boolean
+
+ |
+
+
+
+ add(<helma.Search.Document> doc)
+
+ + + Queues the document object passed as argument for addition to the underlying + index. + |
+
+
+ void
+
+ |
+
+
+
+ log()
+
+ + + Helper function that prefixes every log message with + the name of the IndexManager. + |
+
+
+ Boolean
+
+ |
+
+
+
+ optimize()
+
+ + + Queues the optimization of the underlying index. + |
+
+
+ Boolean
+
+ |
+
+
+
+ remove(<Number> id)
+
+ + + Queues the removal of all index documents whose identifier value ("id" by default) + matches the number passed as argument. + |
+
| Field Detail | +
<static> <final> Number MAXTRIES+
+
<static> <final> Number NORMAL+
+
<static> <final> Number REBUILDING+
+
| + Constructor Detail + | +
jala.IndexManager(<String> name, <helma.File> dir, <String> lang)+ + +
name - The name of the index, which is the name of the directory the index already resides or will be created in.
+ dir - The base directory where this index's directory is already existing or will be created in.
+ lang - The language of the documents in this index. This leads to the proper Lucene analyzer being used for indexing documents.
+ | + Method Detail + | +
Boolean add(<helma.Search.Document> doc)+ +
doc - The document object that should be added to the underlying index.
+ void log()+ +
level - An optional logging level. Accepted values
+ msg - The log message are "debug", "info", "warn" and "error".
+ Boolean optimize()+ +
Boolean remove(<Number> id)+ +
id - The identifier value
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.ListRenderer.ArrayList ++ + +
+
A simple wrapper around an array to use in conjunction
+ with jala.ListRenderer. This wrapper can either handle complete arrays
+ or subsections of an array. In the latter case the wrapper needs offset
+ and total size information as argument to mimick a complete array.
+
Defined in ListRenderer.js
+
| + Field Summary | +|
+ Number |
+ length
+ + The length of this ArrayList instance. |
+
+ Number |
+ offset
+ + The offset of this ArrayList instance. |
+
| +Constructor Summary | +|
+
+
+ jala.ListRenderer.ArrayList
+
+ (<Array> arr, <Number> offset, <Number> total)
+
+ + + Creates a new ArrayList instance. + |
+|
| +Method Summary | +|
+
+ Object
+
+ |
+
+
+
+ get(<Number> idx)
+
+ + + Returns the element at the index position passed + as argument. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isSubset()
+
+ + + Returns true if this ArrayList is a subsection of a bigger array + |
+
+
+ Number
+
+ |
+
+
+
+ size()
+
+ + + Returns the size of this ArrayList, which is either + the length of the wrapped array or the total size + passed as argument to the constructor (in case the wrapped + array is just a subsection). + |
+
+
+ Number
+
+ |
+
+
+
+ subsetSize()
+
+ + + Returns the actual size of this ArrayList's wrapped array. + |
+
| Field Detail | +
Number length+
Number offset+
| + Constructor Detail + | +
jala.ListRenderer.ArrayList(<Array> arr, <Number> offset, <Number> total)+ + +
arr - The array (or a subsection of an array) to wrap
+ offset - An optional offset to use (mandatory if the array is just a subsection).
+ total - An optional total size of the array. This argument is mandatory if the wrapped array is just a subsection.
+ | + Method Detail + | +
Object get(<Number> idx)+ +
idx - The index position of the element to return
+ Boolean isSubset()+ +
Number size()+ +
Number subsetSize()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.ListRenderer ++ + +
+
Defined in ListRenderer.js
+
| +Nested Class Summary | +|
+ <static class> |
+ jala.ListRenderer.ArrayList |
+
| + Field Summary | +|
+ <static> <final> Object |
+ defaultRenderer
+ + Default Renderer object containing functions + used for rendering different list items (eg. |
+
| +Constructor Summary | +|
+
+
+ jala.ListRenderer
+
+ (<HopObject|ArrayList|Array> coll, <Object> renderer)
+
+ + + + |
+|
| +Method Summary | +|
+
+ Number
+
+ |
+
+
+
+ currentEnd_macro()
+
+ + + Returns the end item number in the current page + |
+
+
+ Number
+
+ |
+
+
+
+ currentPage_macro()
+
+ + + Returns the current page number + |
+
+
+ Number
+
+ |
+
+
+
+ currentStart_macro()
+
+ + + Returns the start item number in the current page + |
+
+
+ String
+
+ |
+
+
+
+ getBaseHref()
+
+ + + Returns the base href of this ListRenderer instance + |
+
+
+ HopObject|Array
+
+ |
+
+
+
+ getCollection()
+
+ + + Returns the collection this ListRenderer instance operates on + |
+
+
+ Number
+
+ |
+
+
+
+ getCurrentPage()
+
+ + + Returns the current page index. + |
+
+
+ Number
+
+ |
+
+
+
+ getEndIndex()
+
+ + + Returns the zero-based index position of the last item of the current page + in the collection this ListRenderer operates on. + |
+
+
+ Number
+
+ |
+
+
+
+ getItemSkin()
+
+ + + Returns the name of the skin rendered for a single list item + |
+
+
+ String
+
+ |
+
+
+
+ getList(<Object> param)
+
+ + + Returns the rendered list of collection items as string + |
+
+
+ Number
+
+ |
+
+
+
+ getMaxPages()
+
+ + + Returns the maximum number of pages handled by this ListRenderer instance + |
+
+
+ String
+
+ |
+
+
+
+ getNextLink(<Object> param)
+
+ + + Returns a rendered link to the previous page as string. + |
+
+
+ String
+
+ |
+
+
+
+ getPageHref(<Number> page)
+
+ + + Returns the href of a page. + |
+
+
+ String
+
+ |
+
+
+
+ getPageNavigation(<Object> param)
+
+ + + Returns the rendered page navigation bar as string + |
+
+
+ Number
+
+ |
+
+
+
+ getPageSize()
+
+ + + Returns the number of items displayed on one page + |
+
+
+ String
+
+ |
+
+
+
+ getPrevLink(<Object> param)
+
+ + + Returns a rendered link to the previous page as string. + |
+
+
+ Object
+
+ |
+
+
+
+ getRenderer()
+
+ + + Returns the renderer used by this ListRenderer instance + |
+
+
+ Number
+
+ |
+
+
+
+ getStartIndex()
+
+ + + Returns the zero-based index position of the first item of the current page + in the collection this ListRenderer operates on. + |
+
+
+ Number
+
+ |
+
+
+
+ getTotalPages()
+
+ + + Returns the total number of pages handled by this ListRenderer instance + (which is the collection size divided by the page size). + |
+
+
+ String
+
+ |
+
+
+
+ getUrlParameterName()
+
+ + + Returns the name of the URL parameter name containing the index + of the page to display + |
+
+
+ String
+
+ |
+
+
+
+ getUrlParameters()
+
+ + + Returns any additional URL parameters included in every navigation link + rendered by this ListRenderer instance. + |
+
+
+ Number
+
+ |
+
+
+
+ limit_macro(<Object> param)
+
+ + + Either renders the maximum number of items per page, or + sets the limit to a given number. + |
+
+
+ String
+
+ |
+
+
+
+ nextLink_macro(<Object> param)
+
+ + + Returns a rendered link to the next page. + |
+
+
+ String
+
+ |
+
+
+
+ pageNavigation_macro(<Object> param)
+
+ + + Returns the rendered page navigation bar. + |
+
+
+ String
+
+ |
+
+
+
+ prevLink_macro(<Object> param)
+
+ + + Returns a rendered link to the previous page. + |
+
+
+ void
+
+ |
+
+
+
+ render_macro(<Object> param)
+
+ + + Renders the current page of this list. + |
+
+
+ void
+
+ |
+
+
+
+ renderList(<Object> param)
+
+ + + Renders the list of items for one page directly to response. + |
+
+
+ String
+
+ |
+
+
+
+ renderListAsString(<Object> param)
+
+ + + Returns the rendered list of collection items as string + |
+
+
+ void
+
+ |
+
+
+
+ renderNextLink(<Object> param)
+
+ + + Renders a link to the next page directly to response. + |
+
+
+ String
+
+ |
+
+
+
+ renderNextLinkAsString(param)
+
+ + + Returns a rendered link to the previous page as string + |
+
+
+ Object
+
+ |
+
+
+
+ renderPageNavigation(<Object> param)
+
+ + + Renders the page navigation bar directly to response. + |
+
+
+ String
+
+ |
+
+
+
+ renderPageNavigationAsString(param)
+
+ + + Returns the rendered page navigation bar as string + |
+
+
+ void
+
+ |
+
+
+
+ renderPrevLink(<Object> param)
+
+ + + Renders a link to the previous page directly to response. + |
+
+
+ String
+
+ |
+
+
+
+ renderPrevLinkAsString(<Object> param)
+
+ + + Returns a rendered link to the previous page as string + |
+
+
+ void
+
+ |
+
+
+
+ setBaseHref(<String> href)
+
+ + + Sets the base href of this ListRenderer instance. + |
+
+
+ void
+
+ |
+
+
+
+ setCollection(<HopObject|ArrayList|Array> coll)
+
+ + + Sets the collection of this ListRenderer + |
+
+
+ void
+
+ |
+
+
+
+ setItemSkin(<String> name)
+
+ + + Sets the name of the skin to render for every list item + |
+
+
+ void
+
+ |
+
+
+
+ setMaxPages(<Number> pages)
+
+ + + Sets the maximum number of pages to display + |
+
+
+ void
+
+ |
+
+
+
+ setPageSize(<Number> size)
+
+ + + Sets the number of items to display on a single page + |
+
+
+ void
+
+ |
+
+
+
+ setRenderer(<Object> r)
+
+ + + Sets the renderer to be used by this ListRenderer instance + |
+
+
+ void
+
+ |
+
+
+
+ setUrlParameterName(<String> name)
+
+ + + Sets the name of the URL parameter name containing the index of the page + to display + |
+
+
+ void
+
+ |
+
+
+
+ setUrlParameters(<String> params)
+
+ + + Sets additional parameters to include in every navigation link + |
+
+
+ Number
+
+ |
+
+
+
+ size_macro()
+
+ + + Returns the total number of items + |
+
+
+ Number
+
+ |
+
+
+
+ totalPages_macro()
+
+ + + Returns the total number of pages + |
+
| Field Detail | +
<static> <final> Object defaultRenderer+
| + Constructor Detail + | +
jala.ListRenderer(<HopObject|ArrayList|Array> coll, <Object> renderer)+ + + + +
coll - The collection this ListRenderer operates on, or - for backwards compatibility only - a parameter object containing the collection and any other optional configuration parameters.
+ renderer - An optional renderer to use. If this is set, any rendering method defined in this renderer overrides the default renderer.
+ | + Method Detail + | +
Number currentEnd_macro()+ +
Number currentPage_macro()+ +
Number currentStart_macro()+ +
String getBaseHref()+ +
HopObject|Array getCollection()+ +
Number getCurrentPage()+ +
Number getEndIndex()+ +
Number getItemSkin()+ +
String getList(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ Number getMaxPages()+ +
String getNextLink(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ String getPageHref(<Number> page)+ +
page - The optional page number to include in the href.
+ String getPageNavigation(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ Number getPageSize()+ +
String getPrevLink(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ Object getRenderer()+ +
Number getStartIndex()+ +
Number getTotalPages()+ +
String getUrlParameterName()+ +
String getUrlParameters()+ +
Number limit_macro(<Object> param)+ +
param - Extra macro parameters: String nextLink_macro(<Object> param)+ +
param - Extra macro parameters: String pageNavigation_macro(<Object> param)+ +
param - Extra macro parameters: String prevLink_macro(<Object> param)+ +
param - Extra macro parameters: void render_macro(<Object> param)+ +
param - Extra macro parameters: void renderList(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ String renderListAsString(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ void renderNextLink(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ String renderNextLinkAsString(param)+ +
Object renderPageNavigation(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ String renderPageNavigationAsString(param)+ +
void renderPrevLink(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ String renderPrevLinkAsString(<Object> param)+ +
param - Object containing extra parameters (e.g. from a macro call).
+ void setBaseHref(<String> href)+ +
href - The base href to use for rendering links
+ void setCollection(<HopObject|ArrayList|Array> coll)+ +
coll - The collection this ListRenderer instance should operate on
+ void setItemSkin(<String> name)+ +
name - The name of the skin to render for every list item
+ void setMaxPages(<Number> pages)+ +
pages - The maximum number of pages to display
+ void setPageSize(<Number> size)+ +
size - The number of items to display on one page
+ void setRenderer(<Object> r)+ +
r - The renderer to use
+ void setUrlParameterName(<String> name)+ +
name - The name of the page URL parameter
+ void setUrlParameters(<String> params)+ +
params - A string to append to every navigation URL
+ Number size_macro()+ +
Number totalPages_macro()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Mp3.Id3v1 ++ + +
+
This class represents an Id3v1 tag.
+
Defined in Mp3.js
+
| +Constructor Summary | +|
+
+
+ jala.Mp3.Id3v1
+
+ (audioObj)
+
+ + + Constructs a new Id3v1 tag from an Mp3 file + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ copyFrom(tag)
+
+ + + Copies standard fields from another tag. + |
+
+
+ String
+
+ |
+
+
+
+ getAlbum()
+
+ + + Returns the album information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getArtist()
+
+ + + Returns the artist information of the tag. + |
+
+
+ jala.Mp3
+
+ |
+
+
+
+ getAudio()
+
+ + + Returns the wrapper for the underlying audio file. + |
+
+
+ String
+
+ |
+
+
+
+ getComment()
+
+ + + Returns the comment information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getGenre()
+
+ + + Returns the genre information of the tag. + |
+
+
+ org.farng.mp3.id3.AbstractID3v1
+
+ |
+
+
+
+ getJavaObject()
+
+ + + Returns the java representation of the tag, + class depends on the actual library used. + |
+
+
+ Object
+
+ |
+
+
+
+ getTextContent(<String> id)
+
+ + + This method could be used to retrieve an arbitrary field + of the underlying tag. + |
+
+
+ String
+
+ |
+
+
+
+ getTitle()
+
+ + + Returns the title information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getTrackNumber()
+
+ + + Returns the track number information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getYear()
+
+ + + Returns the year information of the tag. + |
+
+
+ void
+
+ |
+
+
+
+ setAlbum(<String> album)
+
+ + + Sets the album information. + |
+
+
+ void
+
+ |
+
+
+
+ setArtist(<String> artist)
+
+ + + Sets the artist information. + |
+
+
+ void
+
+ |
+
+
+
+ setComment(<String> comment)
+
+ + + Sets the comment + |
+
+
+ void
+
+ |
+
+
+
+ setGenre(<String> genre)
+
+ + + Sets the genre information. + |
+
+
+ void
+
+ |
+
+
+
+ setTextContent(<String> id, val)
+
+ + + This method could be used to set an arbitrary field + of the underlying tag. + |
+
+
+ void
+
+ |
+
+
+
+ setTitle(<String> title)
+
+ + + Sets the title information + |
+
+
+ void
+
+ |
+
+
+
+ setTrackNumber(<Number> trackNumber)
+
+ + + Sets the track number information. + |
+
+
+ void
+
+ |
+
+
+
+ setYear(<Number> year)
+
+ + + Sets the year information. + |
+
| + Constructor Detail + | +
jala.Mp3.Id3v1(audioObj)+ + +
mp3File -
+ | + Method Detail + | +
void copyFrom(tag)+ +
src - object with getter methods for fields album, artist, comment, title, trackNumber, genre and year.
+ String getAlbum()+ +
String getArtist()+ +
jala.Mp3 getAudio()+ +
String getComment()+ +
String getGenre()+ +
org.farng.mp3.id3.AbstractID3v1 getJavaObject()+ +
Object getTextContent(<String> id)+ +
id -
+ String getTitle()+ +
String getTrackNumber()+ +
String getYear()+ +
void setAlbum(<String> album)+ +
album -
+ void setArtist(<String> artist)+ +
artist -
+ void setComment(<String> comment)+ +
comment -
+ void setGenre(<String> genre)+ +
genre -
+ void setTextContent(<String> id, val)+ +
id -
+ value -
+ void setTitle(<String> title)+ +
title -
+ void setTrackNumber(<Number> trackNumber)+ +
trackNumber -
+ void setYear(<Number> year)+ +
year -
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Mp3.Id3v2 ++ + +
+
This class represents an Id3v2 tag.
+
Defined in Mp3.js
+
| +Constructor Summary | +|
+
+
+ jala.Mp3.Id3v2
+
+ (audioObj)
+
+ + + Constructs a new Id3v2 tag from an Mp3 file + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ copyFrom(tag)
+
+ + + Copies standard fields from another tag. + |
+
+
+ String
+
+ |
+
+
+
+ getAlbum()
+
+ + + Returns the album information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getArtist()
+
+ + + Returns the artist information of the tag. + |
+
+
+ jala.Mp3
+
+ |
+
+
+
+ getAudio()
+
+ + + Returns the wrapper for the underlying audio file. + |
+
+
+ String
+
+ |
+
+
+
+ getAuthor()
+
+ + + Returns the author information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getComment()
+
+ + + Returns the comment information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getCopyright()
+
+ + + Returns the copyright information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getGenre()
+
+ + + Returns the genre information of the tag. + |
+
+
+ helma.util.MimePart
+
+ |
+
+
+
+ getImage(<String> pictureType)
+
+ + + Extracts the image from the tag + |
+
+
+ org.farng.mp3.id3.AbstractID3v2
+
+ |
+
+
+
+ getJavaObject()
+
+ + + returns the java representation of the tag, + class depends on the actual library used. + |
+
+
+ String
+
+ |
+
+
+
+ getSubtitle()
+
+ + + Returns the subtitle information of the tag. + |
+
+
+ Number
+
+ |
+
+
+
+ getSubtype()
+
+ + + Returns the version number of this id3v2 (values 2 to 4 for id3v2.2 to id3v2.4) + |
+
+
+ String
+
+ |
+
+
+
+ getTextContent(idStr)
+
+ + + This method can be used to retrieve an arbitrary text frame + of the underlying tag. + |
+
+
+ Number
+
+ |
+
+
+
+ getTextEncoding()
+
+ + + Returns the text encoding used when setting values. + |
+
+
+ String
+
+ |
+
+
+
+ getTitle()
+
+ + + Returns the title information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getTrackNumber()
+
+ + + Returns the track number information of the tag. + |
+
+
+ String
+
+ |
+
+
+
+ getUrl()
+
+ + + Returns the Url stored in this tag + |
+
+
+ String
+
+ |
+
+
+
+ getYear()
+
+ + + Returns the year information of the tag. + |
+
+
+ void
+
+ |
+
+
+
+ removeFromAudio()
+
+ + + Removes the tag from the audio file and + nulls out the wrapper. + |
+
+
+ void
+
+ |
+
+
+
+ setAlbum(<String> album)
+
+ + + Sets the album information. + |
+
+
+ void
+
+ |
+
+
+
+ setArtist(<String> artist)
+
+ + + Sets the artist information. + |
+
+
+ void
+
+ |
+
+
+
+ setAuthor(<String> author)
+
+ + + Sets the author information in this tag + |
+
+
+ void
+
+ |
+
+
+
+ setComment(<String> comment)
+
+ + + Sets the comment + |
+
+
+ void
+
+ |
+
+
+
+ setCopyright(<String> copyright)
+
+ + + Sets the copyright information in this tag + |
+
+
+ void
+
+ |
+
+
+
+ setGenre(<String> genre)
+
+ + + Sets the genre information. + |
+
+
+ void
+
+ |
+
+
+
+ setImage(<Number> pictureType, <String> mimeType, <Array> byteArray)
+
+ + + adds an image to the file. + |
+
+
+ void
+
+ |
+
+
+
+ setSubtitle(<String> title)
+
+ + + Sets the subtitle information + |
+
+
+ String
+
+ |
+
+
+
+ setTextContent(idStr, val)
+
+ + + This method can be used to set an arbitrary field + of the underlying tag. + |
+
+
+ void
+
+ |
+
+
+
+ setTextEncoding(<Number|String> encType)
+
+ + + sets the text encoding used when creating new frames + (the encoding type of old frames can't be changed with + JavaMusicTag) + |
+
+
+ void
+
+ |
+
+
+
+ setTitle(<String> title)
+
+ + + Sets the title information + |
+
+
+ void
+
+ |
+
+
+
+ setTrackNumber(<Number> trackNumber)
+
+ + + Sets the track number information. + |
+
+
+ void
+
+ |
+
+
+
+ setUrl(<String> url, <String> desc)
+
+ + + Stores the Url passed as argument in this tag. + |
+
+
+ void
+
+ |
+
+
+
+ setYear(<Number> year)
+
+ + + Sets the year information. + |
+
| + Constructor Detail + | +
jala.Mp3.Id3v2(audioObj)+ + +
mp3File -
+ | + Method Detail + | +
void copyFrom(tag)+ +
src - object with getter methods for fields album, artist, comment, title, trackNumber, genre and year.
+ String getAlbum()+ +
String getArtist()+ +
jala.Mp3 getAudio()+ +
String getAuthor()+ +
String getComment()+ +
String getCopyright()+ +
String getGenre()+ +
helma.util.MimePart getImage(<String> pictureType)+ +
pictureType - number describing picture type (default is 3, describing a front cover).
+ org.farng.mp3.id3.AbstractID3v2 getJavaObject()+ +
String getSubtitle()+ +
Number getSubtype()+ +
String getTextContent(idStr)+ +
id - Frame identifier according to Id3v2 specification or shortcut as defined in jala.Mp3.FIELD_MAPPING.
+ Number getTextEncoding()+ +
String getTitle()+ +
String getTrackNumber()+ +
String getUrl()+ +
String getYear()+ +
void removeFromAudio()+ +
void setAlbum(<String> album)+ +
album -
+ void setArtist(<String> artist)+ +
artist -
+ void setAuthor(<String> author)+ +
author - The author information to set
+ void setComment(<String> comment)+ +
comment -
+ void setCopyright(<String> copyright)+ +
copyright - The copyright information to set
+ void setGenre(<String> genre)+ +
genre -
+ void setImage(<Number> pictureType, <String> mimeType, <Array> byteArray)+ +
pictureType - number determining picture type
+ mimeType - mime type of image
+ byteArray - image binary data
+ desc - optional description
+ void setSubtitle(<String> title)+ +
title -
+ String setTextContent(idStr, val)+ +
id - Frame identifier according to Id3v2 specification
+ value -
+ void setTextEncoding(<Number|String> encType)+ +
encType - the new encoding type as number or string
+ void setTitle(<String> title)+ +
title -
+ void setTrackNumber(<Number> trackNumber)+ +
trackNumber -
+ void setUrl(<String> url, <String> desc)+ +
url - The url to store in this tag
+ desc - An optiona description of the Url
+ void setYear(<Number> year)+ +
year -
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Mp3 ++ + +
+
This is a class representing an MP3 file
+ providing methods to access its metadata.
+
+
Defined in Mp3.js
+
| +Nested Class Summary | +|
+ <static class> |
+ jala.Mp3.Id3v1 |
+
+ <static class> |
+ jala.Mp3.Id3v2 |
+
| + Field Summary | +|
+ Object |
+ album
+ + |
+
+ Object |
+ artist
+ + |
+
+ Object |
+ comment
+ + |
+
+ Object |
+ genre
+ + |
+
+ Object |
+ title
+ + |
+
+ Object |
+ trackNumber
+ + |
+
+ Object |
+ year
+ + |
+
+ <static> <final> Array |
+ GENRES
+ + Array defining valid genres in ID3v1 |
+
+ <static> <final> Array |
+ MODES
+ + Array defining mp3 modes. |
+
+ <static> <final> Array |
+ PICTURE_TYPES
+ + Array defining valid picture types. |
+
+ <static> <final> Array |
+ TEXT_ENCODINGS
+ + Array defining valid text encodings. |
+
| +Constructor Summary | +|
+
+
+ jala.Mp3
+
+ (<String|File> file)
+
+ + + Constructs a new jala.Mp3 wrapper and + parses the header data of the MP3 file. + |
+|
| +Method Summary | +|
+
+ Object
+
+ |
+
+
+
+ createTag(<Object> tagClass, <Object> tagObject)
+
+ + + This method creates a new tag object, attaches it + to the file (thereby replacing an existing tag of + this type) and returns it. + |
+
+
+ jala.Mp3.Id3v1
+
+ |
+
+
+
+ createV1Tag(<Object> tagObject)
+
+ + + If the file doesn't contain an ID3v1 tag, this method + creates a new ID3v1 tag object, attaches it to the file + and returns it. + |
+
+
+ jala.Mp3.Id3v2
+
+ |
+
+
+
+ createV2Tag(<Object> tagObject)
+
+ + + If the file doesn't contain an ID3v2 tag, this method + creates a new ID3v2 tag object, attaches it to the file + and returns it. + |
+
+
+ Number
+
+ |
+
+
+
+ getBitRate()
+
+ + + Returns the bit rate the file was encoded with. + |
+
+
+ String
+
+ |
+
+
+
+ getChannelMode()
+
+ + + Returns the channel mode the file was encoded with. + |
+
+
+ Number
+
+ |
+
+
+
+ getDuration()
+
+ + + The audio length of the file in seconds at best estimate + from the file info (method returns immediately). + |
+
+
+ helma.File
+
+ |
+
+
+
+ getFile()
+
+ + + Returns a helma.File reference to the wrapped file. + |
+
+
+ Number
+
+ |
+
+
+
+ getFrequency()
+
+ + + Returns the frequency the file was encoded with. + |
+
+
+ org.farng.mp3.MP3File
+
+ |
+
+
+
+ getJavaObject()
+
+ + + Returns the underlying java object + |
+
+
+ Object
+
+ |
+
+
+
+ getMetadata()
+
+ + + Returns a plain JavaScript object containing the values of + all fields stored in either the Id3 V1 or V2 tag + |
+
+
+ Number
+
+ |
+
+
+
+ getSize()
+
+ + + Returns the file size in bytes. + |
+
+
+ Object
+
+ |
+
+
+
+ getTag(tagClass)
+
+ + + Returns a tag object, type is specified using the class name + in jala.Mp3.*. + |
+
+
+ jala.Mp3.Id3v1
+
+ |
+
+
+
+ getV1Tag()
+
+ + + + |
+
+
+ jala.Mp3.Id3v2
+
+ |
+
+
+
+ getV2Tag()
+
+ + + + |
+
+
+ Object
+
+ |
+
+
+
+ hasTag(tagClass)
+
+ + + Tells if the file contains a certain tag, type is specified + using the class name in jala.Mp3. + |
+
+
+ Boolean
+
+ |
+
+
+
+ hasV1Tag()
+
+ + + Returns true if the file contains a ID3v1 tag. + |
+
+
+ Boolean
+
+ |
+
+
+
+ hasV2Tag()
+
+ + + Returns true if the file contains a ID3v2 tag. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isVariableBitRate()
+
+ + + Returns true if the file is (or seems to be) encoded with + variable bit rate. + |
+
+
+ Number
+
+ |
+
+
+
+ parseDuration()
+
+ + + Parses the audio file to extract the precise duration of the audio. + |
+
+
+ void
+
+ |
+
+
+
+ removeTag(tagClass)
+
+ + + Removes a tag from the file, type is specified using the + class name in jala.Mp3.* + |
+
+
+ void
+
+ |
+
+
+
+ removeV1Tag()
+
+ + + Removes the ID3v1 tag from the file. + |
+
+
+ Object
+
+ |
+
+
+
+ removeV2Tag()
+
+ + + Removes the ID3v2 tag from the file. + |
+
+
+ Boolean
+
+ |
+
+
+
+ save(<String|helma.File> outFile)
+
+ + + Writes changed metadata back to the source file or to a new file. + |
+
+
+ void
+
+ |
+
+
+
+ setMetadata(<Object> metadata)
+
+ + + Stores the metadata passed as argument in the ID2 v1 and v2 tags + of the wrapped MP3 file. + |
+
| Field Detail | +
Object album+
Object artist+
Object comment+
Object genre+
Object title+
Object trackNumber+
Object year+
<static> <final> Array GENRES+
<static> <final> Array MODES+
<static> <final> Array PICTURE_TYPES+
<static> <final> Array TEXT_ENCODINGS+
| + Constructor Detail + | +
jala.Mp3(<String|File> file)+ + +
file - The mp3 file to be parsed, either as path string or as any kind of file object
+ | + Method Detail + | +
Object createTag(<Object> tagClass, <Object> tagObject)+ +
tagClass -
+ tagObject - optional tag whose standard properties are copied to the new tag.
+ jala.Mp3.Id3v1 createV1Tag(<Object> tagObject)+ +
tagObject - optional tag whose standard properties are copied to the new tag.
+ jala.Mp3.Id3v2 createV2Tag(<Object> tagObject)+ +
tagObject - optional tag whose standard properties are copied to the new tag.
+ Number getBitRate()+ +
String getChannelMode()+ +
Number getDuration()+ +
helma.File getFile()+ +
Number getFrequency()+ +
org.farng.mp3.MP3File getJavaObject()+ +
Object getMetadata()+ +
Number getSize()+ +
Object getTag(tagClass)+ +
jala.Mp3.Id3v1 getV1Tag()+ + + + + + + + + + + +
jala.Mp3.Id3v2 getV2Tag()+ + + + + + + + + + + +
Object hasTag(tagClass)+ +
Boolean hasV1Tag()+ +
Boolean hasV2Tag()+ +
Boolean isVariableBitRate()+ +
Number parseDuration()+ +
void removeTag(tagClass)+ +
void removeV1Tag()+ +
Object removeV2Tag()+ +
Boolean save(<String|helma.File> outFile)+ +
outFile - (optional) save the modified file to a different file
+ void setMetadata(<Object> metadata)+ +
metadata - An object containing the fields to set and their values.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.XmlWriter + | + +--jala.Rss20Writer + | + +--jala.PodcastWriter ++ + +
+
Class to create, modify and render standard-compliant
+ RSS 2.0 feeds including support for Apple's Podcast specification.
+
Defined in PodcastWriter.js
+
| + Field Summary | +|
+ <static> <final> String |
+ XMLHEADER
+ + A typical XML header as default. |
+
| +Constructor Summary | +|
+
+
+ jala.PodcastWriter
+
+ (<String> header)
+
+ + + + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ addItunesCategory(<String> name, <String> subName, <jala.XmlWriter.XmlElement> parent)
+
+ + + Add an iTunes Podcast category. + |
+
| Methods inherited from class jala.Rss20Writer | +
+
+getRoot, extendChannel, getChannel, setChannel, extendItem, createItem, addItem, addCategory, setImage, setTextInput
+ |
+
| Methods inherited from class jala.XmlWriter | +
+
+createElement, extend, addNamespace, write, toString, clone
+ |
+
| Field Detail | +
<static> <final> String XMLHEADER+
+
| + Constructor Detail + | +
jala.PodcastWriter(<String> header)+ + + + +
header - Optional XML header.
+ | + Method Detail + | +
void addItunesCategory(<String> name, <String> subName, <jala.XmlWriter.XmlElement> parent)+ +
name - The category's name.
+ subName - The (optional) sub-category's name.
+ parent - Optional parent element to add the category to.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--helma.Http + | + +--jala.RemoteContent ++ + +
+
API to define, fetch and update content
+ from a remote site.
+
Defined in RemoteContent.js
+
| + Field Summary | +|
+ <static> <final> File |
+ CACHEDIR
+ + The default cache directory. |
+
+ <static> <final> int |
+ HTTP
+ + A constant representing the HTTP retrieval method. |
+
+ <static> <final> String |
+ SUFFIX
+ + The default name of the cache directory. |
+
+ <static> <final> int |
+ XMLRPC
+ + A constant representing the XML-RPC retrieval method. |
+
| +Constructor Summary | +|
+
+
+ jala.RemoteContent
+
+ (<String> url, <Integer> method, <File> storage)
+
+ + + Construct a new remote content handler. + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ clear()
+
+ + + Flushes (empties) the cached remote content. + |
+
+
+ Object
+
+ |
+
+
+
+ get(<String> key)
+
+ + + Get an arbitrary property of the remote content. + |
+
+
+ Array
+
+ |
+
+
+
+ getKeys()
+
+ + + Get all available property names. + |
+
+
+ Boolean
+
+ |
+
+
+
+ needsUpdate()
+
+ + + Tests whether the remote content needs to be updated. + |
+
+
+ void
+
+ |
+
+
+
+ setInterval(<Number> interval)
+
+ + + Set the interval the remote content's + cache is bound to be updated. + |
+
+
+ String
+
+ |
+
+
+
+ toString()
+
+ + + Get a string representation of the remote content. + |
+
+
+ String
+
+ |
+
+
+
+ update()
+
+ + + Get the updated and cached remote content. + |
+
+
+ Object
+
+ |
+
+
+
+ valueOf()
+
+ + + Get the value of the remote content. + |
+
+
+ <static> void
+
+ |
+
+
+
+ exec()
+
+ + + Apply a custom method on all remote content in a file-based cache. + |
+
+
+ <static> void
+
+ |
+
+
+
+ flush(<File> cache)
+
+ + + Remove all remote content from a file-based cache. + |
+
+
+ <static> void
+
+ |
+
+
+
+ forEach(<Function> callback, <File> cache)
+
+ + + Apply a custom method on all remote content in a file-based cache. + |
+
| Field Detail | +
<static> <final> File CACHEDIR+
<static> <final> int HTTP+
+
<static> <final> String SUFFIX+
+
<static> <final> int XMLRPC+
+
| + Constructor Detail + | +
jala.RemoteContent(<String> url, <Integer> method, <File> storage)+ + +
url - The URL string of the remote site.
+ method - The method to retrieve the remote content.
+ storage - The cache directory.
+ | + Method Detail + | +
void clear()+ +
Object get(<String> key)+ +
key - The name of the property.
+ Array getKeys()+ +
Boolean needsUpdate()+ +
void setInterval(<Number> interval)+ +
interval - The interval value in milliseconds.
+ String toString()+ +
String update()+ +
Object valueOf()+ +
<static> void exec()+ +
callback - The callback method to be executed for each remote content file.
+ cache - An optional target directory.
+ <static> void flush(<File> cache)+ +
cache - An optional target directory.
+ <static> void forEach(<Function> callback, <File> cache)+ +
callback - The callback method to be executed for each remote content file.
+ cache - An optional target directory.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.XmlWriter + | + +--jala.Rss20Writer ++ +
+
Class to create, modify and render standard-compliant
+ RSS 2.0 feeds.
+
Defined in Rss20Writer.js
+
| +Constructor Summary | +|
+
+
+ jala.Rss20Writer
+
+ (<String> header)
+
+ + + + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ addCategory(<String> name, <String> domain, <jala.XmlWriter.XmlElement> parent)
+
+ + + Add a category element to an arbitrary element. + |
+
+
+ void
+
+ |
+
+
+
+ addItem(<jala.XmlWriter.XmlElement> item)
+
+ + + Add an item element to the channel element. + |
+
+
+ jala.XmlWriter.XmlElement
+
+ |
+
+
+
+ createItem(<Object> data)
+
+ + + Get a new and innocent item element. + |
+
+
+ void
+
+ |
+
+
+
+ extendChannel(<Array> ext)
+
+ + + Add child elements to the channel template. + |
+
+
+ void
+
+ |
+
+
+
+ extendItem(<Array> ext)
+
+ + + Add child elements to the item template. + |
+
+
+ jala.XmlWriter.XmlElement
+
+ |
+
+
+
+ getChannel()
+
+ + + Get the writer's channel element. + |
+
+
+ jala.XmlWriter.XmlElement
+
+ |
+
+
+
+ getRoot()
+
+ + + Get the writer's root element. + |
+
+
+ jala.XmlWriter.XmlElement
+
+ |
+
+
+
+ setChannel(<Object> data)
+
+ + + Populate the channel element with data. + |
+
+
+ void
+
+ |
+
+
+
+ setImage(<Object> data)
+
+ + + Populate the image element with data. + |
+
+
+ void
+
+ |
+
+
+
+ setTextInput(<Object> data)
+
+ + + Populate the textInput element with data. + |
+
| Methods inherited from class jala.XmlWriter | +
+
+createElement, extend, addNamespace, write, toString, clone
+ |
+
| + Constructor Detail + | +
jala.Rss20Writer(<String> header)+ + + + +
header - Optional XML header.
+ | + Method Detail + | +
void addCategory(<String> name, <String> domain, <jala.XmlWriter.XmlElement> parent)+ +
name - The name of the category.
+ domain - The domain of the category.
+ parent - The optional parent element.
+ void addItem(<jala.XmlWriter.XmlElement> item)+ +
item - The item element to add.
+ jala.XmlWriter.XmlElement createItem(<Object> data)+ +
data - An XmlWriter-compliant object structure.
+ void extendChannel(<Array> ext)+ +
ext - List of additional child elements.
+ void extendItem(<Array> ext)+ +
ext - List of additional child elements.
+ jala.XmlWriter.XmlElement getChannel()+ +
jala.XmlWriter.XmlElement getRoot()+ +
jala.XmlWriter.XmlElement setChannel(<Object> data)+ +
data - An XmlWriter-compliant object structure.
+ void setImage(<Object> data)+ +
data - An XmlWriter-compliant object structure.
+ void setTextInput(<Object> data)+ +
data - An XmlWriter-compliant object structure.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.Utilities ++ + +
+
This class contains various convenience methods
+ which do not fit in any other class.
+
Defined in Utilities.js
+
| + Field Summary | +|
+ <static> <final> Number |
+ VALUE_ADDED
+ + Static field indicating ad added object property. |
+
+ <static> <final> Number |
+ VALUE_MODIFIED
+ + Static field indicating a modified object property. |
+
+ <static> <final> Number |
+ VALUE_REMOVED
+ + Static field indicating a removed object property. |
+
| +Constructor Summary | +|
+
+
+ jala.Utilities
+
+ ()
+
+ + + Construct a utility object. + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ createPassword(<Number> len, <Number> level)
+
+ + + Creates a random password with different levels of security. + |
+
+
+ Object
+
+ |
+
+
+
+ diffObjects(<Object> obj1, <Object> obj2)
+
+ + + Returns an array containing the properties that are + added, removed or modified in one object compared to another. + |
+
+
+ Object
+
+ |
+
+
+
+ patchObject(<Object> obj, <Object> diff)
+
+ + + Patches an object with a "diff" object created by the + diffObjects() method. + |
+
+
+ String
+
+ |
+
+
+
+ toString()
+
+ + + Return a string representation of the utitility object. + |
+
| Field Detail | +
<static> <final> Number VALUE_ADDED+
+
<static> <final> Number VALUE_MODIFIED+
+
<static> <final> Number VALUE_REMOVED+
+
| + Constructor Detail + | +
jala.Utilities()+ + +
| + Method Detail + | +
String createPassword(<Number> len, <Number> level)+ +
len - The length of the password (default: 8)
+ level - The security level Object diffObjects(<Object> obj1, <Object> obj2)+ +
obj1 - The first of two objects which should be compared
+ obj2 - The second of two objects which should be compared
+ Object patchObject(<Object> obj, <Object> diff)+ +
obj - The Object the diff should be applied to
+ diff - A "diff" object created by the diffObjects() method
+ String toString()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.XmlRpcRequest ++ + +
+
Instances of this class provide the necessary functionality
+ for issueing XmlRpc requests to a remote service.
+
Defined in XmlRpcRequest.js
+
| +Constructor Summary | +|
+
+
+ jala.XmlRpcRequest
+
+ (<String> url, <String> methodName)
+
+ + + A constructor for XmlRpc request objects + |
+|
| +Method Summary | +|
+
+ Boolean
+
+ |
+
+
+
+ debug()
+
+ + + Returns true if debug is enabled for this request, false otherwise + |
+
+
+ Object
+
+ |
+
+
+
+ execute()
+
+ + + Calling this method executes the remote method using + the arguments specified. + |
+
+
+ String
+
+ |
+
+
+
+ getCredentials()
+
+ + + Returns the credentials of this request + |
+
+
+ String
+
+ |
+
+
+
+ getInputEncoding()
+
+ + + Returns the input encoding + |
+
+
+ String
+
+ |
+
+
+
+ getMethodName()
+
+ + + Returns the name of the remote function to call + |
+
+
+ String
+
+ |
+
+
+
+ getOutputEncoding()
+
+ + + Returns the output encoding + |
+
+
+ java.net.Proxy
+
+ |
+
+
+
+ getProxy()
+
+ + + Returns the proxy object. + |
+
+
+ Number
+
+ |
+
+
+
+ getReadTimeout()
+
+ + + Returns the socket timeout of this request + |
+
+
+ Number
+
+ |
+
+
+
+ getTimeout()
+
+ + + Returns the connection timeout of this request + |
+
+
+ java.net.URL
+
+ |
+
+
+
+ getUrl()
+
+ + + Returns the URL of this request + |
+
+
+ void
+
+ |
+
+
+
+ setCredentials(<String> username, <String> password)
+
+ + + Sets the credentials for basic http authentication to + use with this request. + |
+
+
+ void
+
+ |
+
+
+
+ setDebug(<Boolean> flag)
+
+ + + Enables or disables the debug mode. + |
+
+
+ void
+
+ |
+
+
+
+ setEncoding(<String> enc)
+
+ + + Sets both input and output encoding to the + specified encoding string + |
+
+
+ void
+
+ |
+
+
+
+ setInputEncoding(<String> enc)
+
+ + + Sets the input encoding to the specified encoding string + |
+
+
+ void
+
+ |
+
+
+
+ setOutputEncoding(<String> enc)
+
+ + + Sets the output encoding to the specified encoding string + |
+
+
+ void
+
+ |
+
+
+
+ setProxy(<String> proxyString)
+
+ + + Sets the proxy host and port. + |
+
+
+ void
+
+ |
+
+
+
+ setReadTimeout(<Number> millis)
+
+ + + Sets the socket timeout to the specified milliseconds. + |
+
+
+ void
+
+ |
+
+
+
+ setTimeout(<Number> millis)
+
+ + + Sets the connection timeout to the specified milliseconds. + |
+
+
+ <static> String
+
+ |
+
+
+
+ argumentsToString(<Object> args)
+
+ + + Helper method to format an arguments array into + a string useable for debugging output. + |
+
+
+ <static> java.lang.Object
+
+ |
+
+
+
+ convertArgument(<Object> obj)
+
+ + + Helper method for converting a Javascript object into + its appropriate Java object. + |
+
+
+ <static> Object
+
+ |
+
+
+
+ convertResult(<java.lang.Object> obj)
+
+ + + Converts a Java object into its appropriate Javascript representation. + |
+
| + Constructor Detail + | +
jala.XmlRpcRequest(<String> url, <String> methodName)+ + +
url - The url of the XmlRpc entry point
+ methodName - The name of the method to call
+ | + Method Detail + | +
Boolean debug()+ +
Object execute()+ +
String getCredentials()+ +
String getInputEncoding()+ +
String getMethodName()+ +
String getOutputEncoding()+ +
java.net.Proxy getProxy()+ +
Number getReadTimeout()+ +
Number getTimeout()+ +
java.net.URL getUrl()+ +
void setCredentials(<String> username, <String> password)+ +
username - The username
+ password - The password
+ void setDebug(<Boolean> flag)+ +
flag - True or false.
+ void setEncoding(<String> enc)+ +
enc - The encoding to use for both input and output. This must be a valid java encoding string.
+ void setInputEncoding(<String> enc)+ +
enc - The encoding to use for input. This must be a valid java encoding string.
+ void setOutputEncoding(<String> enc)+ +
enc - The encoding to use for output. This must be a valid java encoding string.
+ void setProxy(<String> proxyString)+ +
proxyString - The proxy string in the form 'fqdn:port' (eg. my.proxy.com:3128)
+ void setReadTimeout(<Number> millis)+ +
millis - The timeout to use as socket timeout
+ void setTimeout(<Number> millis)+ +
millis - The timeout to use as connection timeout
+ <static> String argumentsToString(<Object> args)+ +
args - An arguments array
+ <static> java.lang.Object convertArgument(<Object> obj)+ +
obj - The Javascript object to convert
+ <static> Object convertResult(<java.lang.Object> obj)+ +
obj - The Java object to convert
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.XmlWriter ++ +
+
This class defines a generic interface to write
+ arbitrary and validating XML source code. This is done
+ by first applying data objects onto template objects,
+ both in a specified format. Then, the resulting object
+ tree is transformed into XML. Moreover, template objects
+ can be extended with other template objects to provide
+ full flexibility in inheriting subclasses.
+
Defined in XmlWriter.js
+
| +Constructor Summary | +|
+
+
+ jala.XmlWriter
+
+ (<String> header)
+
+ + + Construct a new XML writer. + |
+|
| +Method Summary | +|
+
+ jala.XmlWriter.XmlElement
+
+ |
+
+
+
+ addNamespace(<String> name, <String> url)
+
+ + + Add a namespace to this writer. + |
+
+
+ jala.XmlWriter
+
+ |
+
+
+
+ clone(obj)
+
+ + + Clone this XML writer. + |
+
+
+ jala.XmlWriter.XmlElement
+
+ |
+
+
+
+ createElement(<Object> data)
+
+ + + Get a newly created XML element. + |
+
+
+ jala.XmlWriter
+
+ |
+
+
+
+ extend(<Object> template, <Object> ext)
+
+ + + Extend a template object. + |
+
+
+ jala.XmlWriter.XmlElement
+
+ |
+
+
+
+ getRoot()
+
+ + + Get the root XML element of this writer. + |
+
+
+ String
+
+ |
+
+
+
+ toString()
+
+ + + Get the XML output as string. + |
+
+
+ void
+
+ |
+
+
+
+ write()
+
+ + + Write the XML to the response buffer. + |
+
| + Constructor Detail + | +
jala.XmlWriter(<String> header)+ + +
header - An optional XML header.
+ | + Method Detail + | +
jala.XmlWriter.XmlElement addNamespace(<String> name, <String> url)+ +
name - The name of the namespace.
+ url - The URL string of the namespace.
+ jala.XmlWriter clone(obj)+ +
The - clone templare.
+ jala.XmlWriter.XmlElement createElement(<Object> data)+ +
data - The XML data as object tree.
+ jala.XmlWriter extend(<Object> template, <Object> ext)+ +
template - The template object.
+ ext - The extension object.
+ jala.XmlWriter.XmlElement getRoot()+ +
String toString()+ +
void write()+ +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.0 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.db.DataType ++ + +
+
Instances of this class represent a data type. Each instance
+ contains the code number as defined in java.sql.Types, the name of
+ the data type as defined in java.sql.Types and optional creation parameters
+ allowed for this data type.
+
Defined in Database.js
+
| +Constructor Summary | +|
+
+
+ jala.db.DataType
+
+ (<Number> type, <String> typeName, <String> params)
+
+ + + Returns a newly created DataType instance. + |
+|
| +Method Summary | +|
+
+ String
+
+ |
+
+
+
+ getParams()
+
+ + + Returns the creation parameter string of this data type + |
+
+
+ Number
+
+ |
+
+
+
+ getType()
+
+ + + Returns the sql type code number as defined in java.sql.Types + |
+
+
+ String
+
+ |
+
+
+
+ getTypeName()
+
+ + + Returns the type name of this data type, which can be + used in sql queries. + |
+
+
+ Boolean
+
+ |
+
+
+
+ needsQuotes()
+
+ + + Returns true if values for this data type should be surrounded + by (single) quotes. + |
+
| + Constructor Detail + | +
jala.db.DataType(<Number> type, <String> typeName, <String> params)+ + +
type - The sql code number of this data type
+ typeName - The type name of this data type, as used within sql statements
+ params - Optional creation parameters allowed for this data type.
+ | + Method Detail + | +
String getParams()+ +
Number getType()+ +
String getTypeName()+ +
Boolean needsQuotes()+ +
+
+
|
++Jala 1.0 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.db.RamDatabase + | + +--jala.db.FileDatabase ++ + +
+
Instances of this class represent a file based in-process database
+
Important: You need the h2.jar in directory "lib/ext"
+ of your helma installation for this library to work, which you can get
+ at http://www.h2database.com/.
+
Defined in Database.js
+
| +Constructor Summary | +|
+
+
+ jala.db.FileDatabase
+
+ (<String> name, <helma.File> directory, <String> username, <String> password)
+
+ + + Returns a newly created instance of FileDatabase. + |
+|
| +Method Summary | +|
+
+ Boolean
+
+ |
+
+
+
+ backup(<helma.File> file)
+
+ + + Creates a backup of this database, using the file passed as argument. + |
+
+
+ helma.File
+
+ |
+
+
+
+ getDirectory()
+
+ + + Returns the directory where the database files are stored. + |
+
+
+ String
+
+ |
+
+
+
+ getName()
+
+ + + Returns the name of the database. + |
+
+
+ String
+
+ |
+
+
+
+ getPassword()
+
+ + + Returns the password of this database + |
+
+
+ String
+
+ |
+
+
+
+ getUsername()
+
+ + + Returns the username of this database + |
+
+
+ Boolean
+
+ |
+
+
+
+ remove()
+
+ + + Deletes all files of this database on disk. + |
+
+
+ Boolean
+
+ |
+
+
+
+ restore(<helma.File> backupFile)
+
+ + + Restores this database using a backup on disk. + |
+
| Methods inherited from class jala.db.RamDatabase | +
+
+getUrl, getProperties, getConnection, shutdown, dropTable, tableExists, copyTables, runScript, dump
+ |
+
| + Constructor Detail + | +
jala.db.FileDatabase(<String> name, <helma.File> directory, <String> username, <String> password)+ + +
name - The name of the database. This name is used as prefix for all database files
+ directory - The directory where the database files should be stored in.
+ username - Optional username (defaults to "sa"). This username is used when creating the database, so the same should be used when creating subsequent instances of jala.db.FileDatabase pointing to the same database
+ password - Optional password (defaults to "").
+ | + Method Detail + | +
Boolean backup(<helma.File> file)+ +
file - The file to write the backup to
+ helma.File getDirectory()+ +
String getName()+ +
String getPassword()+ +
String getUsername()+ +
Boolean remove()+ +
Boolean restore(<helma.File> backupFile)+ +
backupFile - The backup file to use for restore
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.db.RamDatabase ++ +
+
Instances of this class represent an in-memory sql database.
+
Important: You need the h2.jar in directory "lib/ext"
+ of your helma installation for this library to work, which you can get
+ at http://www.h2database.com/.
+
Defined in Database.js
+
| +Constructor Summary | +|
+
+
+ jala.db.RamDatabase
+
+ (<String> name, <String> username, <String> password)
+
+ + + Returns a newly created RamDatabase instance. + |
+|
| +Method Summary | +|
+
+ void
+
+ |
+
+
+
+ copyTables(<helma.Database> database, <Array> tables)
+
+ + + Copies all tables in the database passed as argument into this embedded database. + |
+
+
+ Boolean
+
+ |
+
+
+
+ dropTable(<String> tableName)
+
+ + + Drops the table with the given name + |
+
+
+ Boolean
+
+ |
+
+
+
+ dump(<helma.File> file, <Object> props)
+
+ + + Dumps the database schema and data into a file + |
+
+
+ helma.Database
+
+ |
+
+
+
+ getConnection(props)
+
+ + + Returns a connection to this database + |
+
+
+ String
+
+ |
+
+
+
+ getName()
+
+ + + Returns the name of the database + |
+
+
+ String
+
+ |
+
+
+
+ getPassword()
+
+ + + Returns the password of this database + |
+
+
+ helma.util.ResourceProperties
+
+ |
+
+
+
+ getProperties(<Object> props)
+
+ + + Returns a properties object containing the connection properties + for this database. + |
+
+
+ String
+
+ |
+
+
+
+ getUrl(<Object> props)
+
+ + + Returns the JDBC Url to connect to this database + |
+
+
+ String
+
+ |
+
+
+
+ getUsername()
+
+ + + Returns the username of this database + |
+
+
+ Boolean
+
+ |
+
+
+
+ runScript(<helma.File> file, <Object> props, <String> charset, <Boolean> continueOnError)
+
+ + + Runs the script file passed as argument in the context of this database. + |
+
+
+ void
+
+ |
+
+
+
+ shutdown()
+
+ + + Stops this in-process database by issueing a "SHUTDOWN" sql command. + |
+
+
+ Boolean
+
+ |
+
+
+
+ tableExists(<String> name)
+
+ + + Returns true if the table exists already in the database + |
+
| + Constructor Detail + | +
jala.db.RamDatabase(<String> name, <String> username, <String> password)+ + +
name - The name of the database. If not given a private un-named database is created, that can only be accessed through this instance of jala.db.RamDatabase
+ username - Optional username (defaults to "sa"). This username is used when creating the database, so the same should be used when creating subsequent instances of jala.db.RamDatabase pointing to a named database.
+ password - Optional password (defaults to "").
+ | + Method Detail + | +
void copyTables(<helma.Database> database, <Array> tables)+ +
database - The database to copy the tables from
+ tables - An optional array containing the names of the tables to copy. If not given all tables are copied
+ Boolean dropTable(<String> tableName)+ +
tableName - The name of the table
+ Boolean dump(<helma.File> file, <Object> props)+ +
file - The file where the database dump will be
+ props - Optional object containing connection properties
+ helma.Database getConnection(props)+ +
An - optional parameter object containing connection properties to add to the connection Url.
+ String getName()+ +
String getPassword()+ +
helma.util.ResourceProperties getProperties(<Object> props)+ +
props - An optional parameter object containing connection properties to add to the connection Url.
+ String getUrl(<Object> props)+ +
props - Optional connection properties to add
+ String getUsername()+ +
Boolean runScript(<helma.File> file, <Object> props, <String> charset, <Boolean> continueOnError)+ +
file - The script file to run
+ props - Optional object containing connection properties
+ charset - Optional character set to use (defaults to "UTF-8")
+ continueOnError - Optional flag indicating whether to continue on error or not (defaults to false)
+ void shutdown()+ +
Boolean tableExists(<String> name)+ +
name - The name of the table
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.db.Server ++ + +
+
Instances of this class represent a H2 database listener that
+ allows multiple databases to be accessed via tcp.
+
Important: You need the h2.jar in directory "lib/ext"
+ of your helma installation for this library to work, which you can get
+ at http://www.h2database.com/.
+
Defined in Database.js
+
| +Constructor Summary | +|
+
+
+ jala.db.Server
+
+ (<helma.File> baseDir, <Number> port)
+
+ + + Returns a new Server instance. + |
+|
| +Method Summary | +|
+
+ Boolean
+
+ |
+
+
+
+ createOnDemand(<Boolean> bool)
+
+ + + If called with boolean true as argument, this server creates databases + on-the-fly, otherwise it only accepts connections to already existing + databases. + |
+
+
+ helma.Database
+
+ |
+
+
+
+ getConnection(<String> name, <String> username, <String> password, <Object> props)
+
+ + + Returns a connection to a database within this server. + |
+
+
+ helma.File
+
+ |
+
+
+
+ getDirectory()
+
+ + + Returns the directory used by this server instance + |
+
+
+ Number
+
+ |
+
+
+
+ getPort()
+
+ + + Returns the port this server listens on + |
+
+
+ helma.util.ResourceProperties
+
+ |
+
+
+
+ getProperties(<String> name, <String> username, <String> password, <Object> props)
+
+ + + Returns a properties object containing the connection properties + of the database with the given name. + |
+
+
+ String
+
+ |
+
+
+
+ getUrl(<String> name, <Object> props)
+
+ + + Returns the JDBC Url to use for connections to a given database. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isPublic(<Boolean> bool)
+
+ + + If called with boolean true as argument, this server accepts connections + from outside localhost. + |
+
+
+ Boolean
+
+ |
+
+
+
+ isRunning()
+
+ + + Returns true if the database server is running. + |
+
+
+ Boolean
+
+ |
+
+
+
+ start()
+
+ + + Starts the database server. + |
+
+
+ Boolean
+
+ |
+
+
+
+ stop()
+
+ + + Stops the database server. + |
+
+
+ Boolean
+
+ |
+
+
+
+ useSsl(<Boolean> bool)
+
+ + + Toggles the use of Ssl encryption within this server. + |
+
| + Constructor Detail + | +
jala.db.Server(<helma.File> baseDir, <Number> port)+ + +
baseDir - The directory where the database files are located or should be stored
+ port - The port to listen on (defaults to 9001)
+ createOnDemand - If true this server will create non-existing databases on-the-fly, if false it only accepts connections to already existing databases in the given base directory
+ makePublic - If true this database is reachable from outside, if false it's only reachable from localhost
+ useSsl - If true SSL will be used to encrypt the connection
+ | + Method Detail + | +
Boolean createOnDemand(<Boolean> bool)+ +
bool - If true this server creates non-existing databases on demand, if false it only allows connections to existing databases. If no argument is given, this method returns the current setting.
+ helma.Database getConnection(<String> name, <String> username, <String> password, <Object> props)+ +
name - The name of the database running within this server
+ username - Optional username to use for this connection
+ password - Optional password to use for this connection
+ props - An optional parameter object containing connection properties to add to the connection Url.
+ helma.File getDirectory()+ +
Number getPort()+ +
helma.util.ResourceProperties getProperties(<String> name, <String> username, <String> password, <Object> props)+ +
name - The name of the database
+ username - Optional username to use for this connection
+ password - Optional password to use for this connection
+ props - An optional parameter object containing connection properties to add to the connection Url.
+ String getUrl(<String> name, <Object> props)+ +
name - An optional name of a database running
+ props - Optional connection properties to add
+ Boolean isPublic(<Boolean> bool)+ +
bool - If true this server accepts connections from outside localhost. If no argument is given, this method returns the current setting.
+ Boolean isRunning()+ +
Boolean start()+ +
Boolean stop()+ +
Boolean useSsl(<Boolean> bool)+ +
bool - If true SSL encryption will be used, false otherwise. If no argument is given, this method returns the current setting.
+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala.db ++ + +
| +Nested Class Summary | +|
+ <static class> |
+ jala.db.Server |
+
+ <static class> |
+ jala.db.DataType |
+
+ <static class> |
+ jala.db.RamDatabase |
+
+ <static class> |
+ jala.db.FileDatabase |
+
+ + + + + + + + + + + + + + + + + +
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
Object + | + +--jala ++ + +
| +Nested Class Summary | +|
+ <static class> |
+ jala.AsyncRequest |
+
+ <static class> |
+ jala.BitTorrent |
+
+ <static class> |
+ jala.Captcha |
+
+ <static class> |
+ jala.Date |
+
+ <static class> |
+ jala.DnsClient |
+
+ <static class> |
+ jala.Form |
+
+ <static class> |
+ jala.History |
+
+ <static class> |
+ jala.HtmlDocument |
+
+ <static class> |
+ jala.I18n |
+
+ <static class> |
+ jala.ImageFilter |
+
+ <static class> |
+ jala.IndexManager |
+
+ <static class> |
+ jala.ListRenderer |
+
+ <static class> |
+ jala.Mp3 |
+
+ <static class> |
+ jala.PodcastWriter |
+
+ <static class> |
+ jala.RemoteContent |
+
+ <static class> |
+ jala.Rss20Writer |
+
+ <static class> |
+ jala.Utilities |
+
+ <static class> |
+ jala.XmlRpcRequest |
+
+ <static class> |
+ jala.XmlWriter |
+
| + Field Summary | +|
+ <static> <final> jala.Date |
+ date
+ + Default date class instance. |
+
+ <static> Object |
+ db
+ + Namespace declaration |
+
+ <static> <final> jala.I18n |
+ i18n
+ + Default i18n class instance. |
+
+ <static> <final> jala.Utilities |
+ util
+ + Default utility class instance. |
+
| Field Detail | +
<static> <final> jala.Date date+
<static> Object db+
<static> <final> jala.I18n i18n+
<static> <final> jala.Utilities util+
+
+
|
++Jala 1.3 + + | + +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + | +||||||||
| + SUMMARY: FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
| jala.AsyncRequest
+ + |
+
| jala.BitTorrent
+ + |
+
| jala.Captcha
+ + |
+
| jala.db.FileDatabase
+ + |
+
| jala.db.RamDatabase
+ + |
+
| jala.db.Server
+ + |
+
| jala.Date
+ + |
+
| jala.Date.Calendar
+ + |
+
| jala.Date.Calendar.Renderer
+ + |
+
| jala.DnsClient
+ + |
+
| jala.DnsClient.Record
+ + |
+
| jala.Form
+ + |
+
| jala.Form.Component
+ + |
+
| jala.Form.Component.Button
+ + |
+
| jala.Form.Component.Checkbox
+ + |
+
| jala.Form.Component.Date
+ + |
+
| jala.Form.Component.Fieldset
+ + |
+
| jala.Form.Component.File
+ + |
+
| jala.Form.Component.Hidden
+ + |
+
| jala.Form.Component.Image
+ + |
+
| jala.Form.Component.Input
+ + |
+
| jala.Form.Component.Password
+ + |
+
| jala.Form.Component.Radio
+ + |
+
| jala.Form.Component.Select
+ + |
+
| jala.Form.Component.Skin
+ + |
+
| jala.Form.Component.Submit
+ + |
+
| jala.Form.Component.Textarea
+ + |
+
| jala.Form.Tracker
+ + |
+
| jala.History
+ + |
+
| jala.HtmlDocument
+ + |
+
| jala.I18n
+ + |
+
| jala.ImageFilter
+ + |
+
| jala.IndexManager
+ + |
+
| jala.IndexManager.Job
+ + |
+
| jala.ListRenderer
+ + |
+
| jala.ListRenderer.ArrayList
+ + |
+
| jala.Mp3
+ + |
+
| jala.Mp3.Id3v1
+ + |
+
| jala.Mp3.Id3v2
+ + |
+
| jala.PodcastWriter
+ + |
+
| jala.RemoteContent
+ + |
+
| jala.Rss20Writer
+ + |
+
| jala.Utilities
+ + |
+
| jala.XmlRpcRequest
+ + |
+
| jala.XmlWriter
+ + |
+
| All Classes
+
+
+Files
+ |
+
+ + + diff --git a/modules/jala/docs/overview-summary-AsyncRequest.js.html b/modules/jala/docs/overview-summary-AsyncRequest.js.html new file mode 100644 index 00000000..2e5de3c2 --- /dev/null +++ b/modules/jala/docs/overview-summary-AsyncRequest.js.html @@ -0,0 +1,170 @@ + + +
+
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.AsyncRequest class.
+
+
| + + Class Summary + + | +|
| jala.AsyncRequest | +This class is used to create requests of type "INTERNAL" + (like cron-jobs) that are processed in a separate thread and + therefor asynchronous. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.BitTorrent class.
+
+
| + + Class Summary + + | +|
| jala.BitTorrent | +This class provides methods to create a BitTorrent + metadata file from any desired file. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.Captcha class.
+
+
| + + Class Summary + + | +|
| jala.Captcha | +Wrapper class for the + JCaptcha library. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.db package.
+
+
| + + Class Summary + + | +|
| jala.db.FileDatabase | +Instances of this class represent a file based in-process database
+ Important: You need the h2.jar in directory "lib/ext" + of your helma installation for this library to work, which you can get + at http://www.h2database.com/. |
+
| jala.db.RamDatabase | +Instances of this class represent an in-memory sql database. | +
| jala.db.Server | +Instances of this class represent a H2 database listener that + allows multiple databases to be accessed via tcp. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.Date class.
+
+
| + + Class Summary + + | +|
| jala.Date | +This class provides various convenience + methods for rendering purposes. | +
| jala.Date.Calendar | +This class represents a calendar based based on a grouped + collection of HopObjects. | +
| jala.Date.Calendar.Renderer | +A default renderer to use in conjunction with jala.Date.Calendar + | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.DnsClient class.
+
+
| + + Class Summary + + | +|
| jala.DnsClient | +This is a wrapper around the Dns Client by wonderly.org + providing methods for querying Dns servers. | +
| jala.DnsClient.Record | +Instances of this class wrap record data as received + from the nameserver. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ This class can be used to render forms and to validate
+ and store user submits. Further types of form components can be added
+ by subclassing jala.Form.Component.Input.
+
+
| + + Class Summary + + | +|
| jala.Form | +A class that renders forms, validates submitted form data and + stores the data in a specified object. | +
| jala.Form.Component | ++ |
| jala.Form.Component.Button | +Subclass of jala.Form.Component.Input which renders a button. | +
| jala.Form.Component.Checkbox | +Subclass of jala.Form.Component.Input which renders and validates a + checkbox. | +
| jala.Form.Component.Date | +Subclass of jala.Form.Component.Input which renders and validates a + date editor. | +
| jala.Form.Component.Fieldset | +Instances of this class represent a form fieldset containing + numerous form components + | +
| jala.Form.Component.File | +Subclass of jala.Form.Component.Input which renders and validates a + file upload. | +
| jala.Form.Component.Hidden | +Subclass of jala.Form.Component.Input which renders and validates a + hidden input tag. | +
| jala.Form.Component.Image | +Subclass of jala.Form.Component.File which renders a file upload + and validates uploaded files as images. | +
| jala.Form.Component.Input | +Instances of this class represent a single form input field. | +
| jala.Form.Component.Password | +Subclass of jala.Form.Component.Input which renders and validates a + password input tag. | +
| jala.Form.Component.Radio | +Subclass of jala.Form.Component.Input which renders and validates a + set of radio buttons. | +
| jala.Form.Component.Select | +Subclass of jala.Form.Component.Input which renders and validates a + dropdown element. | +
| jala.Form.Component.Skin | +Subclass of jala.Form.Component that allows rendering a skin + within a form. | +
| jala.Form.Component.Submit | +Subclass of jala.Form.Component.Button which renders a submit button. | +
| jala.Form.Component.Textarea | +Subclass of jala.Form.Component.Input which renders and validates a + textarea input field. | +
| jala.Form.Tracker | +Instances of this class can contain error-messages and values + | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the Global prototype.
+
+
| + + Method Summary + + | +|
+
+ static Boolean
+
+ |
+
+
+
+ isArray(<Object> val)
+
+ + + Returns true if the value passed as argument is an array. + |
+
+
+ static Boolean
+
+ |
+
+
+
+ isBoolean(<Object> val)
+
+ + + Returns true if the value passed as argument is either a boolean + literal or an instance of Boolean. + |
+
+
+ static Boolean
+
+ |
+
+
+
+ isDate(<Object> val)
+
+ + + Returns true if the value passed as argument is either a Javascript date + or an instance of java.util.Date. + |
+
+
+ static Boolean
+
+ |
+
+
+
+ isFunction(<Object> val)
+
+ + + Returns true if the value passed as argument is a function. + |
+
+
+ static Boolean
+
+ |
+
+
+
+ isNull(<Object> val)
+
+ + + Returns true if the value passed as argument is null. + |
+
+
+ static Boolean
+
+ |
+
+
+
+ isNumber(<Object> val)
+
+ + + Returns true if the value passed as argument is either a number, + an instance of Number or of java.lang.Number. + |
+
+
+ static Boolean
+
+ |
+
+
+
+ isObject(<Object> val)
+
+ + + Returns true if the value passed as argument is either a Javascript + object or an instance of java.lang.Object. + |
+
+
+ static Boolean
+
+ |
+
+
+
+ isString(<Object> val)
+
+ + + Returns true if the value passed as argument is either a string literal, + an instance of String or of java.lang.String. + |
+
+
+ static Boolean
+
+ |
+
+
+
+ isUndefined(<Object> val)
+
+ + + Returns true if the value passed as argument is undefined. + |
+
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.History class.
+
+
| + + Class Summary + + | +|
| jala.History | +This class is an implementation of a Browser-like history + stack suitable to use in any Helma application. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Additional fields and methods of the HopObject class.
+
+
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.HtmlDocument class.
+
+
| + + Class Summary + + | +|
| jala.HtmlDocument | +This class provides easy access to the elements of + an arbitrary HTML document. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Methods and macros for internationalization
+ of Helma applications.
+
+
| + + Class Summary + + | +|
| jala.I18n | +This class provides various functions and macros for + internationalization of Helma applications. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.ImageFilter class.
+
+
| + + Class Summary + + | +|
| jala.ImageFilter | +This class provides several image manipulating + methods. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.IndexManager class.
+
+
| + + Class Summary + + | +|
| jala.IndexManager | +This class basically sits on top of a helma.Search.Index instance + and provides methods for adding, removing and optimizing the underlying index. | +
| jala.IndexManager.Job | +Instances of this class represent a single index + manipulation job to be processed by the index manager. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.ListRenderer class.
+
+
| + + Class Summary + + | +|
| jala.ListRenderer | ++ |
| jala.ListRenderer.ArrayList | +A simple wrapper around an array to use in conjunction + with jala.ListRenderer. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.audio package.
+
+
| + + Class Summary + + | +|
| jala.Mp3 | +This is a class representing an MP3 file + providing methods to access its metadata. | +
| jala.Mp3.Id3v1 | +This class represents an Id3v1 tag. | +
| jala.Mp3.Id3v2 | +This class represents an Id3v2 tag. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.PodcastWriter class.
+
+
| + + Class Summary + + | +|
| jala.PodcastWriter | +Class to create, modify and render standard-compliant + RSS 2.0 feeds including support for Apple's Podcast specification. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.RemoteContent class.
+
+
| + + Class Summary + + | +|
| jala.RemoteContent | +API to define, fetch and update content + from a remote site. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.Rss20Writer class.
+
+
| + + Class Summary + + | +|
| jala.Rss20Writer | +Class to create, modify and render standard-compliant + RSS 2.0 feeds. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.Utilities class.
+
+
| + + Class Summary + + | +|
| jala.Utilities | +This class contains various convenience methods + which do not fit in any other class. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.XmlRpcRequest class.
+
+
| + + Class Summary + + | +|
| jala.XmlRpcRequest | +Instances of this class provide the necessary functionality + for issueing XmlRpc requests to a remote service. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Fields and methods of the jala.XmlWriter class.
+
+
| + + Class Summary + + | +|
| jala.XmlWriter | +This class defines a generic interface to write + arbitrary and validating XML source code. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+ Wrapper for automatic inclusion of all Jala modules.
+
+
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++ +Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+ This document is the API Specification for + Jala 1.3. +
+ + + ++ + Jala is a Helma-based library and utility project initially developed to ease the work at ORF.at's software development department. + + +
+ +| + + File Summary + + | +|
| all.js | +Wrapper for automatic inclusion of all Jala modules. | +
| AsyncRequest.js | +Fields and methods of the jala.AsyncRequest class. | +
| BitTorrent.js | +Fields and methods of the jala.BitTorrent class. | +
| Captcha.js | +Fields and methods of the jala.Captcha class. | +
| Database.js | +Fields and methods of the jala.db package. | +
| Date.js | +Fields and methods of the jala.Date class. | +
| DnsClient.js | +Fields and methods of the jala.DnsClient class. | +
| Form.js | +This class can be used to render forms and to validate + and store user submits. | +
| Global.js | +Fields and methods of the Global prototype. | +
| History.js | +Fields and methods of the jala.History class. | +
| HopObject.js | +Additional fields and methods of the HopObject class. | +
| HtmlDocument.js | +Fields and methods of the jala.HtmlDocument class. | +
| I18n.js | +Methods and macros for internationalization + of Helma applications. | +
| ImageFilter.js | +Fields and methods of the jala.ImageFilter class. | +
| IndexManager.js | +Fields and methods of the jala.IndexManager class. | +
| ListRenderer.js | +Fields and methods of the jala.ListRenderer class. | +
| Mp3.js | +Fields and methods of the jala.audio package. | +
| PodcastWriter.js | +Fields and methods of the jala.PodcastWriter class. | +
| RemoteContent.js | +Fields and methods of the jala.RemoteContent class. | +
| Rss20Writer.js | +Fields and methods of the jala.Rss20Writer class. | +
| Utilities.js | +Fields and methods of the jala.Utilities class. | +
| XmlRpcRequest.js | +Fields and methods of the jala.XmlRpcRequest class. | +
| XmlWriter.js | +Fields and methods of the jala.XmlWriter class. | +
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+
+
|
++Jala 1.3 + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +||||||||
+
+
|
++Jala 1.3 + | +|||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + | +|||||||
+ Version 2.1, February 1999 + +
+ ++
Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + [This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] ++ + +
+ The licenses for most software are designed to take away your + freedom to share and change it. By contrast, the GNU General Public + Licenses are intended to guarantee your freedom to share and change + free software--to make sure the software is free for all its users. +
+ ++ This license, the Lesser General Public License, applies to some + specially designated software packages--typically libraries--of the + Free Software Foundation and other authors who decide to use it. You + can use it too, but we suggest you first think carefully about whether + this license or the ordinary General Public License is the better + strategy to use in any particular case, based on the explanations below. +
+ ++ When we speak of free software, we are referring to freedom of use, + not price. Our General Public Licenses are designed to make sure that + you have the freedom to distribute copies of free software (and charge + for this service if you wish); that you receive source code or can get + it if you want it; that you can change the software and use pieces of + it in new free programs; and that you are informed that you can do + these things. +
+ ++ To protect your rights, we need to make restrictions that forbid + distributors to deny you these rights or to ask you to surrender these + rights. These restrictions translate to certain responsibilities for + you if you distribute copies of the library or if you modify it. +
+ ++ For example, if you distribute copies of the library, whether gratis + or for a fee, you must give the recipients all the rights that we gave + you. You must make sure that they, too, receive or can get the source + code. If you link other code with the library, you must provide + complete object files to the recipients, so that they can relink them + with the library after making changes to the library and recompiling + it. And you must show them these terms so they know their rights. +
+ ++ We protect your rights with a two-step method: (1) we copyright the + library, and (2) we offer you this license, which gives you legal + permission to copy, distribute and/or modify the library. +
+ ++ To protect each distributor, we want to make it very clear that + there is no warranty for the free library. Also, if the library is + modified by someone else and passed on, the recipients should know + that what they have is not the original version, so that the original + author's reputation will not be affected by problems that might be + introduced by others. +
+ ++ Finally, software patents pose a constant threat to the existence of + any free program. We wish to make sure that a company cannot + effectively restrict the users of a free program by obtaining a + restrictive license from a patent holder. Therefore, we insist that + any patent license obtained for a version of the library must be + consistent with the full freedom of use specified in this license. +
+ ++ Most GNU software, including some libraries, is covered by the + ordinary GNU General Public License. This license, the GNU Lesser + General Public License, applies to certain designated libraries, and + is quite different from the ordinary General Public License. We use + this license for certain libraries in order to permit linking those + libraries into non-free programs. +
+ ++ When a program is linked with a library, whether statically or using + a shared library, the combination of the two is legally speaking a + combined work, a derivative of the original library. The ordinary + General Public License therefore permits such linking only if the + entire combination fits its criteria of freedom. The Lesser General + Public License permits more lax criteria for linking other code with + the library. +
+ ++ We call this license the "Lesser" General Public License because it + does Less to protect the user's freedom than the ordinary General + Public License. It also provides other free software developers Less + of an advantage over competing non-free programs. These disadvantages + are the reason we use the ordinary General Public License for many + libraries. However, the Lesser license provides advantages in certain + special circumstances. +
+ ++ For example, on rare occasions, there may be a special need to + encourage the widest possible use of a certain library, so that it becomes + a de-facto standard. To achieve this, non-free programs must be + allowed to use the library. A more frequent case is that a free + library does the same job as widely used non-free libraries. In this + case, there is little to gain by limiting the free library to free + software only, so we use the Lesser General Public License. +
+ ++ In other cases, permission to use a particular library in non-free + programs enables a greater number of people to use a large body of + free software. For example, permission to use the GNU C Library in + non-free programs enables many more people to use the whole GNU + operating system, as well as its variant, the GNU/Linux operating + system. +
+ ++ Although the Lesser General Public License is Less protective of the + users' freedom, it does ensure that the user of a program that is + linked with the Library has the freedom and the wherewithal to run + that program using a modified version of the Library. +
+ ++ The precise terms and conditions for copying, distribution and + modification follow. Pay close attention to the difference between a + "work based on the library" and a "work that uses the library". The + former contains code derived from the library, whereas the latter must + be combined with the library in order to run. +
+ ++ +
+ ++ 0. + This License Agreement applies to any software library or other + program which contains a notice placed by the copyright holder or + other authorized party saying it may be distributed under the terms of + this Lesser General Public License (also called "this License"). + Each licensee is addressed as "you". +
+ ++ A "library" means a collection of software functions and/or data + prepared so as to be conveniently linked with application programs + (which use some of those functions and data) to form executables. +
+ ++ The "Library", below, refers to any such software library or work + which has been distributed under these terms. A "work based on the + Library" means either the Library or any derivative work under + copyright law: that is to say, a work containing the Library or a + portion of it, either verbatim or with modifications and/or translated + straightforwardly into another language. (Hereinafter, translation is + included without limitation in the term "modification".) +
+ ++ "Source code" for a work means the preferred form of the work for + making modifications to it. For a library, complete source code means + all the source code for all modules it contains, plus any associated + interface definition files, plus the scripts used to control compilation + and installation of the library. +
+ ++ Activities other than copying, distribution and modification are not + covered by this License; they are outside its scope. The act of + running a program using the Library is not restricted, and output from + such a program is covered only if its contents constitute a work based + on the Library (independent of the use of the Library in a tool for + writing it). Whether that is true depends on what the Library does + and what the program that uses the Library does. +
+ ++ 1. + You may copy and distribute verbatim copies of the Library's + complete source code as you receive it, in any medium, provided that + you conspicuously and appropriately publish on each copy an + appropriate copyright notice and disclaimer of warranty; keep intact + all the notices that refer to this License and to the absence of any + warranty; and distribute a copy of this License along with the + Library. +
+ ++ You may charge a fee for the physical act of transferring a copy, + and you may at your option offer warranty protection in exchange for a + fee. +
+ ++ 2. + You may modify your copy or copies of the Library or any portion + of it, thus forming a work based on the Library, and copy and + distribute such modifications or work under the terms of Section 1 + above, provided that you also meet all of these conditions: +
+ ++
+ (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) +
+ ++ These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the Library, + and can be reasonably considered independent and separate works in + themselves, then this License, and its terms, do not apply to those + sections when you distribute them as separate works. But when you + distribute the same sections as part of a whole which is a work based + on the Library, the distribution of the whole must be on the terms of + this License, whose permissions for other licensees extend to the + entire whole, and thus to each and every part regardless of who wrote + it. +
+ ++ Thus, it is not the intent of this section to claim rights or contest + your rights to work written entirely by you; rather, the intent is to + exercise the right to control the distribution of derivative or + collective works based on the Library. +
+ ++ In addition, mere aggregation of another work not based on the Library + with the Library (or with a work based on the Library) on a volume of + a storage or distribution medium does not bring the other work under + the scope of this License. +
+ 3. + You may opt to apply the terms of the ordinary GNU General Public + License instead of this License to a given copy of the Library. To do + this, you must alter all the notices that refer to this License, so + that they refer to the ordinary GNU General Public License, version 2, + instead of to this License. (If a newer version than version 2 of the + ordinary GNU General Public License has appeared, then you can specify + that version instead if you wish.) Do not make any other change in + these notices. +
+ ++ Once this change is made in a given copy, it is irreversible for + that copy, so the ordinary GNU General Public License applies to all + subsequent copies and derivative works made from that copy. +
+ ++ This option is useful when you wish to copy part of the code of + the Library into a program that is not a library. +
+ ++ 4. + You may copy and distribute the Library (or a portion or + derivative of it, under Section 2) in object code or executable form + under the terms of Sections 1 and 2 above provided that you accompany + it with the complete corresponding machine-readable source code, which + must be distributed under the terms of Sections 1 and 2 above on a + medium customarily used for software interchange. +
+ ++ If distribution of object code is made by offering access to copy + from a designated place, then offering equivalent access to copy the + source code from the same place satisfies the requirement to + distribute the source code, even though third parties are not + compelled to copy the source along with the object code. +
+ ++ 5. + A program that contains no derivative of any portion of the + Library, but is designed to work with the Library by being compiled or + linked with it, is called a "work that uses the Library". Such a + work, in isolation, is not a derivative work of the Library, and + therefore falls outside the scope of this License. +
+ ++ However, linking a "work that uses the Library" with the Library + creates an executable that is a derivative of the Library (because it + contains portions of the Library), rather than a "work that uses the + library". The executable is therefore covered by this License. + Section 6 states terms for distribution of such executables. +
+ ++ When a "work that uses the Library" uses material from a header file + that is part of the Library, the object code for the work may be a + derivative work of the Library even though the source code is not. + Whether this is true is especially significant if the work can be + linked without the Library, or if the work is itself a library. The + threshold for this to be true is not precisely defined by law. +
+ ++ If such an object file uses only numerical parameters, data + structure layouts and accessors, and small macros and small inline + functions (ten lines or less in length), then the use of the object + file is unrestricted, regardless of whether it is legally a derivative + work. (Executables containing this object code plus portions of the + Library will still fall under Section 6.) +
+ ++ Otherwise, if the work is a derivative of the Library, you may + distribute the object code for the work under the terms of Section 6. + Any executables containing that work also fall under Section 6, + whether or not they are linked directly with the Library itself. +
+ ++ 6. + As an exception to the Sections above, you may also combine or + link a "work that uses the Library" with the Library to produce a + work containing portions of the Library, and distribute that work + under terms of your choice, provided that the terms permit + modification of the work for the customer's own use and reverse + engineering for debugging such modifications. +
+ ++ You must give prominent notice with each copy of the work that the + Library is used in it and that the Library and its use are covered by + this License. You must supply a copy of this License. If the work + during execution displays copyright notices, you must include the + copyright notice for the Library among them, as well as a reference + directing the user to the copy of this License. Also, you must do one + of these things: +
+ ++
+ For an executable, the required form of the "work that uses the + Library" must include any data and utility programs needed for + reproducing the executable from it. However, as a special exception, + the materials to be distributed need not include anything that is + normally distributed (in either source or binary form) with the major + components (compiler, kernel, and so on) of the operating system on + which the executable runs, unless that component itself accompanies + the executable. +
+ ++ It may happen that this requirement contradicts the license + restrictions of other proprietary libraries that do not normally + accompany the operating system. Such a contradiction means you cannot + use both them and the Library together in an executable that you + distribute. +
+ ++ 7. You may place library facilities that are a work based on the + Library side-by-side in a single library together with other library + facilities not covered by this License, and distribute such a combined + library, provided that the separate distribution of the work based on + the Library and of the other library facilities is otherwise + permitted, and provided that you do these two things: +
+ ++
+ 8. You may not copy, modify, sublicense, link with, or distribute + the Library except as expressly provided under this License. Any + attempt otherwise to copy, modify, sublicense, link with, or + distribute the Library is void, and will automatically terminate your + rights under this License. However, parties who have received copies, + or rights, from you under this License will not have their licenses + terminated so long as such parties remain in full compliance. +
+ ++ 9. + You are not required to accept this License, since you have not + signed it. However, nothing else grants you permission to modify or + distribute the Library or its derivative works. These actions are + prohibited by law if you do not accept this License. Therefore, by + modifying or distributing the Library (or any work based on the + Library), you indicate your acceptance of this License to do so, and + all its terms and conditions for copying, distributing or modifying + the Library or works based on it. +
+ ++ 10. + Each time you redistribute the Library (or any work based on the + Library), the recipient automatically receives a license from the + original licensor to copy, distribute, link with or modify the Library + subject to these terms and conditions. You may not impose any further + restrictions on the recipients' exercise of the rights granted herein. + You are not responsible for enforcing compliance by third parties with + this License. +
+ ++ 11. + If, as a consequence of a court judgment or allegation of patent + infringement or for any other reason (not limited to patent issues), + conditions are imposed on you (whether by court order, agreement or + otherwise) that contradict the conditions of this License, they do not + excuse you from the conditions of this License. If you cannot + distribute so as to satisfy simultaneously your obligations under this + License and any other pertinent obligations, then as a consequence you + may not distribute the Library at all. For example, if a patent + license would not permit royalty-free redistribution of the Library by + all those who receive copies directly or indirectly through you, then + the only way you could satisfy both it and this License would be to + refrain entirely from distribution of the Library. +
+ ++ If any portion of this section is held invalid or unenforceable under any + particular circumstance, the balance of the section is intended to apply, + and the section as a whole is intended to apply in other circumstances. +
+ ++ It is not the purpose of this section to induce you to infringe any + patents or other property right claims or to contest validity of any + such claims; this section has the sole purpose of protecting the + integrity of the free software distribution system which is + implemented by public license practices. Many people have made + generous contributions to the wide range of software distributed + through that system in reliance on consistent application of that + system; it is up to the author/donor to decide if he or she is willing + to distribute software through any other system and a licensee cannot + impose that choice. +
+ ++ This section is intended to make thoroughly clear what is believed to + be a consequence of the rest of this License. +
+ ++ 12. + If the distribution and/or use of the Library is restricted in + certain countries either by patents or by copyrighted interfaces, the + original copyright holder who places the Library under this License may add + an explicit geographical distribution limitation excluding those countries, + so that distribution is permitted only in or among countries not thus + excluded. In such case, this License incorporates the limitation as if + written in the body of this License. +
+ ++ 13. + The Free Software Foundation may publish revised and/or new + versions of the Lesser General Public License from time to time. + Such new versions will be similar in spirit to the present version, + but may differ in detail to address new problems or concerns. +
+ ++ Each version is given a distinguishing version number. If the Library + specifies a version number of this License which applies to it and + "any later version", you have the option of following the terms and + conditions either of that version or of any later version published by + the Free Software Foundation. If the Library does not specify a + license version number, you may choose any version ever published by + the Free Software Foundation. +
+ ++ 14. + If you wish to incorporate parts of the Library into other free + programs whose distribution conditions are incompatible with these, + write to the author to ask for permission. For software which is + copyrighted by the Free Software Foundation, write to the Free + Software Foundation; we sometimes make exceptions for this. Our + decision will be guided by the two goals of preserving the free status + of all derivatives of our free software and of promoting the sharing + and reuse of software generally. +
+ ++ NO WARRANTY +
+ ++ 15. + BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO + WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. + EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR + OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY + KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE + LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME + THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. +
+ ++ 16. + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN + WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY + AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU + FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR + CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE + LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING + RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A + FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF + SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH + DAMAGES. +
+ \ No newline at end of file diff --git a/modules/jala/tests/1meg.reference-win.torrent b/modules/jala/tests/1meg.reference-win.torrent new file mode 100644 index 00000000..bfa6890a --- /dev/null +++ b/modules/jala/tests/1meg.reference-win.torrent @@ -0,0 +1 @@ +d8:announce30:http://tracker.orf.at/announce13:creation datei1172497604e4:infod6:lengthi1048576e4:name4:1meg12:piece lengthi262144e6:pieces80:. §èWYÇôÂTÔÙÃ>ôäY§. §èWYÇôÂTÔÙÃ>ôäY§. §èWYÇôÂTÔÙÃ>ôäY§. §èWYÇôÂTÔÙÃ>ôäY§ee \ No newline at end of file diff --git a/modules/jala/tests/1meg.reference.torrent b/modules/jala/tests/1meg.reference.torrent new file mode 100644 index 00000000..16454c90 Binary files /dev/null and b/modules/jala/tests/1meg.reference.torrent differ diff --git a/modules/jala/tests/AsyncRequest.js b/modules/jala/tests/AsyncRequest.js new file mode 100644 index 00000000..c7033aa2 --- /dev/null +++ b/modules/jala/tests/AsyncRequest.js @@ -0,0 +1,65 @@ +// +// Jala Project [http://opensvn.csie.org/traccgi/jala] +// +// Copyright 2004 ORF Online und Teletext GmbH +// +// Licensed under the Apache License, Version 2.0 (the ``License''); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ``AS IS'' BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// $Revision$ +// $LastChangedBy$ +// $LastChangedDate$ +// $HeadURL$ +// + + +var result = undefined; + +/** + * A simple test of jala.AsyncRequest. It constructs a new AsyncRequest + * with a test function defined below that sets various properties + * of the global result object above. After evaluating the async request + * the current thread sleeps for a short period of time to wait for + * the other request to finish, and then does the testing of the result. + */ +var testAsyncRequest = function() { + var r = new jala.AsyncRequest(global, "testFunction"); + r.run("jala"); + // wait until the async request started above has finished + // before testing the result, but no longer than 1 second. + var elapsed = 0; + var interval = 5; + while (result === undefined && elapsed < 1000) { + elapsed += interval; + java.lang.Thread.sleep(interval); + } + assertNotUndefined(result); + assertEqual(result.name, "jala"); + assertEqual(result.request, req); + assertEqual(result.response, res); + assertFalse(r.isAlive()); + return; +}; + +/** + * A simple test function that assigns an object to the global + * property "result". + * @param {String} name A string to use as name + */ +var testFunction = function(name) { + result = { + name: name, + request: req, + response: res + }; + return; +}; diff --git a/modules/jala/tests/BitTorrent.js b/modules/jala/tests/BitTorrent.js new file mode 100644 index 00000000..ac1e92bd --- /dev/null +++ b/modules/jala/tests/BitTorrent.js @@ -0,0 +1,59 @@ +// +// Jala Project [http://opensvn.csie.org/traccgi/jala] +// +// Copyright 2004 ORF Online und Teletext GmbH +// +// Licensed under the Apache License, Version 2.0 (the ``License''); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ``AS IS'' BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// $Revision$ +// $LastChangedBy$ +// $LastChangedDate$ +// $HeadURL$ +// + +/** + * A simple test of jala.BitTorrent. + * FIXME: Needs resolution of issue #33 + */ +var testBitTorrent = function() { + var size = 1024 * 1024; // 1 meg + var file = new java.io.File(jala.Test.getTestFile("1meg")); + var fos = new java.io.FileOutputStream(file, false); + var channel = fos.getChannel(); + var iterations = 0; + while (channel.size() < size) { + channel.write(java.nio.ByteBuffer.allocate(1024)); + } + channel.close(); + fos.close(); + + var torrent = new jala.BitTorrent(file); + // Testing against file generated with BitTorrent.app (OS X) + torrent.set("announce", "http://tracker.orf.at/announce"); + // S3 defines a multitracker list with a single tracker item + //torrent.set("announce-list", [["http://tracker.amazonaws.com:6969/announce"]]); + torrent.setCreationDate(new Date(2007, 1, 26, 14, 46, 44)); + torrent.save(); + file["delete"](); + + try { + var torrentFile = torrent.getTorrentFile(); + var refFile = new helma.File(jala.Test.getTestFile("1meg.reference.torrent")); + assertEqual(torrentFile.readAll().trim(), refFile.readAll().trim()); + } catch (x) { + throw(x); + } finally { + torrentFile.remove(); + } + return; +}; diff --git a/modules/jala/tests/Database.js b/modules/jala/tests/Database.js new file mode 100644 index 00000000..a2b95509 --- /dev/null +++ b/modules/jala/tests/Database.js @@ -0,0 +1,163 @@ +/** + * Contains the system's temporary directory + * @type helma.File + * @private + */ +var tmpDir = new helma.File(java.lang.System.getProperty("java.io.tmpdir")); + +/** + * Contains the server created in testServer method + * @private + */ +var server = null; + +/** + * Basic tests for jala.db.RamDatabase. All of these tests are + * valid for jala.db.FileDatabase too. + */ +var testRamDatabase = function() { + var db = new jala.db.RamDatabase("test"); + assertNotNull(db); + assertEqual(db.getName(), "test"); + assertEqual(db.getDatabasePath(), "mem:test"); + assertEqual(db.getUrl(), "jdbc:h2:mem:test"); + // test connection to database + var conn = db.getConnection(); + assertNotNull(conn); + assertTrue(conn instanceof helma.Database); + + // create a table + db.createTable("test", [ + { + name: "id", + type: java.sql.Types.INTEGER, + nullable: false, + unique: true + }, + { + name: "name", + type: java.sql.Types.VARCHAR, + length: 255 + } + ], "id"); + + // test if the table exists + assertTrue(db.tableExists("test")); + + // dump database + var dumpFile = new helma.File(tmpDir, "backup.test.sql"); + assertTrue(db.dump(dumpFile)); + assertTrue(dumpFile.exists()); + assertTrue(dumpFile.getLength() > 0); + // remove dump file again + dumpFile.remove(); + + // drop table + db.dropTable("test"); + assertFalse(db.tableExists("test")); + + // test db shutdown + db.shutdown(); + assertThrows(function() { + conn.query("select 1 = 1"); + }, Packages.org.h2.jdbc.JdbcSQLException); + return; +}; + +/** + * Basic tests for jala.db.FileDatabase that are different to + * jala.db.RamDatabase + */ +var testFileDatabase = function() { + var db = new jala.db.FileDatabase("test", tmpDir); + assertNotNull(db); + assertEqual(db.getName(), "test"); + assertEqual(db.getDirectory(), tmpDir); + + var dbDir = new helma.File(tmpDir, "test"); + assertEqual(db.getDatabasePath(), "file:" + dbDir.getAbsolutePath()); + assertEqual(db.getUrl(), "jdbc:h2:file:" + dbDir.getAbsolutePath()); + + // execute sql script (need to do that, otherwise the backup won't + // work because the database is empty) + var sqlFile = jala.Test.getTestFile("Database.script.sql"); + assertTrue(db.runScript(sqlFile)); + assertTrue(db.tableExists("test")); + + // test backup + var backupFile = new helma.File(tmpDir, "backup.zip"); + assertTrue(db.backup(backupFile)); + assertTrue(backupFile.exists()); + assertTrue(backupFile.getLength() > 0); + + // remove the database + db.remove(); + assertFalse((new helma.File(db.getDirectory(), db.getName() + ".data.db")).exists()); + assertFalse((new helma.File(db.getDirectory(), db.getName() + ".index.db")).exists()); + assertFalse((new helma.File(db.getDirectory(), db.getName() + ".trace.db")).exists()); + + // test restore + assertTrue(db.restore(backupFile)); + assertTrue(db.tableExists("test")); + + // remove backup file and database + backupFile.remove(); + db.remove(); + + return; +}; + +var testServer = function() { + server = new jala.db.Server(tmpDir); + // test default config + assertEqual(tmpDir, server.getDirectory()); + assertEqual(server.getPort(), 9092); + assertFalse(server.useSsl()); + assertFalse(server.isPublic()); + assertFalse(server.createOnDemand()); + + // test setting config properties + server.useSsl(true); + assertTrue(server.useSsl()); + server.isPublic(true); + assertTrue(server.isPublic()); + server.createOnDemand(true); + assertTrue(server.createOnDemand()); + + // reset back some of them + server.useSsl(false); + assertFalse(server.useSsl()); + server.isPublic(false); + assertFalse(server.isPublic()); + + // start the server + assertTrue(server.start()); + + // test connection properties (this also includes testing + // of server.getUrl()) + var props = server.getProperties("test", "test", "1111"); + assertEqual(props.getProperty("test.url"), "jdbc:h2:tcp://localhost:9092/test"); + assertEqual(props.getProperty("test.driver"), "org.h2.Driver"); + assertEqual(props.getProperty("test.user"), "test"); + assertEqual(props.getProperty("test.password"), "1111"); + + var conn = server.getConnection("test", "test", "1111"); + assertNotNull(conn); + + // stop the server + assertTrue(server.stop()); + // and remove the file database created above + var db = new jala.db.FileDatabase("test", tmpDir, "test", "1111"); + db.remove(); + return; +}; + +/** + * Stuff to do on cleanup + */ +var cleanup = function() { + if (server != null) { + server.stop(); + } + return; +}; diff --git a/modules/jala/tests/Database.script.sql b/modules/jala/tests/Database.script.sql new file mode 100644 index 00000000..7beab74d --- /dev/null +++ b/modules/jala/tests/Database.script.sql @@ -0,0 +1,4 @@ +CREATE TABLE test (id INTEGER NOT NULL, name VARCHAR(255), PRIMARY KEY (id)); +INSERT INTO test (id, name) VALUES (1, 'jala'); +INSERT INTO test (id, name) VALUES (2, 'Database'); +INSERT INTO test (id, name) VALUES (3, 'Test'); diff --git a/modules/jala/tests/DnsClient.js b/modules/jala/tests/DnsClient.js new file mode 100644 index 00000000..19ceb720 --- /dev/null +++ b/modules/jala/tests/DnsClient.js @@ -0,0 +1,66 @@ +// +// Jala Project [http://opensvn.csie.org/traccgi/jala] +// +// Copyright 2004 ORF Online und Teletext GmbH +// +// Licensed under the Apache License, Version 2.0 (the ``License''); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ``AS IS'' BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// $Revision$ +// $LastChangedBy$ +// $LastChangedDate$ +// $HeadURL$ +// + + +var dnsClient = new jala.DnsClient("68.12.16.25"); +var result; + +/** + * Testing default mode (A records) + */ +var testAQuery = function() { + result = dnsClient.query("nomatic.org"); + assertEqual(result.length, 1); + assertEqual(result[0].ipAddress, "213.129.249.34"); + return; +}; + +/** + * Testing SOA record queries + */ +var testSoaQuery = function() { + result = dnsClient.query("nomatic.org", jala.DnsClient.TYPE_SOA); + assertEqual(result.length, 1); + assertEqual(result[0].email, "hostmaster.nomatic.org"); + return; +}; + +/** + * Testing MX record queries + */ +var testMxQuery = function() { + result = dnsClient.query("nomatic.org", jala.DnsClient.TYPE_MX); + assertEqual(result.length, 1); + assertEqual(result[0].mx, "grace.nomatic.org"); + return; +}; + +/** + * Testing NS record queries + */ +var testNsQuery = function() { + result = dnsClient.query("nomatic.org", jala.DnsClient.TYPE_NS); + assertEqual(result.length, 3); + // can't test single records as their order changes unpredictably + return; +}; diff --git a/modules/jala/tests/Form.fileupload.doc b/modules/jala/tests/Form.fileupload.doc new file mode 100644 index 00000000..40b88854 Binary files /dev/null and b/modules/jala/tests/Form.fileupload.doc differ diff --git a/modules/jala/tests/Form.imageupload.jpg b/modules/jala/tests/Form.imageupload.jpg new file mode 100644 index 00000000..84a3d709 Binary files /dev/null and b/modules/jala/tests/Form.imageupload.jpg differ diff --git a/modules/jala/tests/Form.js b/modules/jala/tests/Form.js new file mode 100644 index 00000000..0fee8358 --- /dev/null +++ b/modules/jala/tests/Form.js @@ -0,0 +1,460 @@ +// +// Jala Project [http://opensvn.csie.org/traccgi/jala] +// +// Copyright 2004 ORF Online und Teletext GmbH +// +// Licensed under the Apache License, Version 2.0 (the ``License''); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ``AS IS'' BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// $Revision$ +// $LastChangedBy$ +// $LastChangedDate$ +// $HeadURL$ +// + +/** + * a global variable containing the form instance + * @type jala.Form + */ +var form; + + +/** + * Create and configure the form object + */ +var setup = function() { + form = jala.Form.create(getConfig(), new DataObject()); + // form.render(); // show the test form + return; +}; + + +/** + * Test the form rendering mechanism + */ +var testFormRender = function() { + var html = new jala.HtmlDocument(form.renderAsString()); + var list = html.getAll("*"); + + var idx = 2; + assertEqual(list[idx].name, "form"); + assertAttribute(list[idx].attributes, "id", "test"); + assertAttribute(list[idx].attributes, "class", "form"); + assertAttribute(list[idx].attributes, "name", "test"); + assertAttribute(list[idx].attributes, "enctype", "multipart/form-data"); + assertAttribute(list[idx].attributes, "method", "post"); + + + // alias / input + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testAlias"); + assertAttribute(list[idx].attributes, "class", "component require"); + + assertEqual(list[++idx].name, "label"); + assertAttribute(list[idx].attributes, "for", "testAliasControl"); + + assertEqual(list[++idx].name, "input"); + assertAttribute(list[idx].attributes, "id", "testAliasControl"); + assertAttribute(list[idx].attributes, "class", "input"); + assertAttribute(list[idx].attributes, "type", "text"); + assertAttribute(list[idx].attributes, "maxlength", "10"); + assertAttribute(list[idx].attributes, "name", "alias"); + assertAttribute(list[idx].attributes, "size", "20"); + + assertEqual(list[++idx].name, "div"); + assertEqual(list[idx].value, "Enter alias."); + assertAttribute(list[idx].attributes, "class", "helpText"); + + + // desc / textarea + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testDesc"); + assertAttribute(list[idx].attributes, "class", "component require"); + + assertEqual(list[++idx].name, "label"); + assertAttribute(list[idx].attributes, "for", "testDescControl"); + + assertEqual(list[++idx].name, "textarea"); + assertAttribute(list[idx].attributes, "id", "testDescControl"); + assertAttribute(list[idx].attributes, "class", "textarea"); + assertAttribute(list[idx].attributes, "name", "desc"); + assertAttribute(list[idx].attributes, "cols", "30"); + assertAttribute(list[idx].attributes, "rows", "3"); + + + + // pushdate / date + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testPushdate"); + assertAttribute(list[idx].attributes, "class", "component require"); + + assertEqual(list[++idx].name, "label"); + assertAttribute(list[idx].attributes, "for", "testPushdateControl"); + + assertEqual(list[++idx].name, "input"); + assertAttribute(list[idx].attributes, "id", "testPushdateControl"); + assertAttribute(list[idx].attributes, "class", "date"); + assertAttribute(list[idx].attributes, "type", "text"); + assertAttribute(list[idx].attributes, "name", "pushdate"); + + + // isonline / checkbox + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testIsonline"); + assertAttribute(list[idx].attributes, "class", "component optional"); + + assertEqual(list[++idx].name, "label"); + assertAttribute(list[idx].attributes, "for", "testIsonlineControl"); + + assertEqual(list[++idx].name, "input"); + assertAttribute(list[idx].attributes, "id", "testIsonlineControl"); + assertAttribute(list[idx].attributes, "type", "checkbox"); + assertAttribute(list[idx].attributes, "class", "checkbox"); + assertAttribute(list[idx].attributes, "name", "isonline"); + assertAttribute(list[idx].attributes, "value", "1"); + + + // category / select + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testCategory"); + assertAttribute(list[idx].attributes, "class", "component optional"); + + assertEqual(list[++idx].name, "label"); + assertAttribute(list[idx].attributes, "for", "testCategoryControl"); + + assertEqual(list[++idx].name, "select"); + assertAttribute(list[idx].attributes, "id", "testCategoryControl"); + assertAttribute(list[idx].attributes, "class", "select"); + assertAttribute(list[idx].attributes, "name", "category"); + assertAttribute(list[idx].attributes, "size", "1"); + + assertEqual(list[++idx].name, "option"); + assertAttribute(list[idx].attributes, "value", "cat0"); + + assertEqual(list[++idx].name, "option"); + assertAttribute(list[idx].attributes, "value", "cat1"); + + assertEqual(list[++idx].name, "option"); + assertAttribute(list[idx].attributes, "value", "cat2"); + + assertEqual(list[++idx].name, "option"); + assertAttribute(list[idx].attributes, "value", "cat3"); + + + // fieldset + assertEqual(list[++idx].name, "fieldset"); + + assertEqual(list[++idx].name, "legend"); + assertEqual(list[idx].value, "a fieldset"); + + + // fileupload + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testFileupload"); + assertAttribute(list[idx].attributes, "class", "component optional"); + + assertEqual(list[++idx].name, "label"); + assertAttribute(list[idx].attributes, "for", "testFileuploadControl"); + + assertEqual(list[++idx].name, "input"); + assertAttribute(list[idx].attributes, "id", "testFileuploadControl"); + assertAttribute(list[idx].attributes, "class", "file"); + assertAttribute(list[idx].attributes, "type", "file"); + assertAttribute(list[idx].attributes, "accept", "application/msword"); + assertAttribute(list[idx].attributes, "name", "fileupload"); + + + // imageupload + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testImageupload"); + assertAttribute(list[idx].attributes, "class", "component optional"); + + assertEqual(list[++idx].name, "label"); + assertAttribute(list[idx].attributes, "for", "testImageuploadControl"); + + assertEqual(list[++idx].name, "input"); + assertAttribute(list[idx].attributes, "id", "testImageuploadControl"); + assertAttribute(list[idx].attributes, "class", "image"); + assertAttribute(list[idx].attributes, "type", "file"); + assertAttribute(list[idx].attributes, "name", "imageupload"); + + + // submit + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testSubmit"); + assertAttribute(list[idx].attributes, "class", "component"); + + assertEqual(list[++idx].name, "input"); + assertAttribute(list[idx].attributes, "id", "testSubmitControl"); + assertAttribute(list[idx].attributes, "class", "submit"); + assertAttribute(list[idx].attributes, "name", "submit"); + assertAttribute(list[idx].attributes, "value", "Submit this form"); + assertAttribute(list[idx].attributes, "type", "submit"); + + + // cancel + assertEqual(list[++idx].name, "div"); + assertAttribute(list[idx].attributes, "id", "testCancel"); + assertAttribute(list[idx].attributes, "class", "component"); + + assertEqual(list[++idx].name, "input"); + assertAttribute(list[idx].attributes, "id", "testCancelControl"); + assertAttribute(list[idx].attributes, "class", "button"); + assertAttribute(list[idx].attributes, "name", "cancel"); + assertAttribute(list[idx].attributes, "value", "Cancel edit"); + assertAttribute(list[idx].attributes, "type", "button"); + + return; +} + + +/** + * Test the form validation mechanism + */ +var testFormValidate = function() { + var reqData = getRequestData(); + + // default userinput values that should validate + var tracker = form.validate(reqData); + assertFalse(tracker.hasError()); + + // now try invalid values in userinput: + reqData["alias"] = "a"; + reqData["desc"] = ""; + reqData["pushdate"] = "17.5.2007"; + reqData["category"] = "invalidOption"; + tracker = form.validate(reqData); + assertTrue(tracker.hasError()); + assertEqual(tracker.errors["alias"], "Alias is too short."); + assertEqual(tracker.errors["desc"], "Please enter text into this field."); + assertEqual(tracker.errors["pushdate"], "This date cannot be parsed."); + assertEqual(tracker.errors["category"], "Please select a valid option."); + + // reset to default userinput: + reqData = getRequestData(); + // require a smaller image: + form.components.uploadfieldset.components.imageupload.require("maxwidth", 100, "Maximum width exceeded."); + tracker = form.validate(reqData); + assertTrue(tracker.hasError()); + assertEqual(tracker.errors["imageupload"], "Maximum width exceeded."); + // undo image restriction: + form.components.uploadfieldset.components.imageupload.require("maxwidth", 200, "Maximum width exceeded."); + tracker = form.validate(reqData); + assertFalse(tracker.hasError()); + + return; +}; + + +/** + * Test the form rendering mechanism in the case of an error + */ +var testFormRenderWithError = function() { + var reqData = getRequestData(); + reqData["alias"] = "a"; + var tracker = form.validate(reqData); + + var html = new jala.HtmlDocument(form.renderAsString()); + var list = html.getAll("*"); + assertEqual(list[4].name, "div"); + assertEqual(list[4].value, "Alias is too short."); + assertAttribute(list[4].attributes, "class", "errorText"); +}; + + +/** + * Test the form save mechanism + */ +var testFormSave = function() { + var dataObj = form.getDataObject(); + + var reqData = getRequestData(); + var tracker = form.validate(reqData); + assertFalse(tracker.hasError()); + form.save(); + assertEqual(dataObj.alias, "aliasValue"); + assertEqual(dataObj.getProperty("desc"), "descriptionValue"); + assertEqual(dataObj.pushdate.toString(), new Date(2007, 4, 17, 11, 32, 0).toString()); + assertEqual(dataObj.isonline, 1); + assertEqual(dataObj.getProperty("category"), "cat2"); + + return; +} + + + +/** + * Helper function to dump an html element to the response + * @param {Object} el + */ +var debugElement = function(el) { + res.write("" + el.name + " (" + el.value + ")