Class Rabbit

Object
   |
   +--Rabbit

class Rabbit

Rabbit is a framework for providing kind of rapid application prototyping features in Helma.
Defined in Global/Rabbit.js

Field Detail

DATE

<static> <final> Number DATE

Constant representing the date datatype

See Also:

Constant Field Values

DATEFORMAT

<static> <final> String DATEFORMAT

Constant representing the format of the date datatype

See Also:

Constant Field Values

EMAIL

<static> <final> Number EMAIL

Constant representing the e-mail datatype

See Also:

Constant Field Values

FILE

<static> <final> Number FILE

Constant representing the file datatype

See Also:

Constant Field Values

IMAGE

<static> <final> Number IMAGE

Constant representing the image datatype

See Also:

Constant Field Values

NUMBER

<static> <final> Number NUMBER

Constant representing the numeric datatype

See Also:

Constant Field Values

TEXT

<static> <final> Number TEXT

Constant representing the alphanumeric datatype

See Also:

Constant Field Values

VERSION

<static> <final> Number VERSION

Constant representing the current version number

See Also:

Constant Field Values

Rabbit

Rabbit(<Boolean> restricted)

Constructs a new instance of the Rabbit class.

Parameters:
restricted - Flag indicating whether some global and prototype settings will be applied on instantation. If true, the values as described in registerGlobals() will be set.

editor

void editor(<HopObject> object)

Renders an editor for a HopObject instance. Each property will be represented with an appropriate form display according to its datatype.

Parameters:
object - The underlying HopObject instance.

getChildElement

HopObject getChildElement(<String> child)

Retrieves the child element of an HopObject instance. Depending on the value of req.data.rabbit, an update of the child HopObject is carried out, additionally.

Parameters:
child - The name of the child element

Returns:
The resulting Hopobject instance

getMeta

Object getMeta(<String> prototype, <String> property)

For convenience, easier access and also better performance all settings of a prototype are serialized to a file which serves as object cache. This method retrieves a certain property of the desired prototype from cache.

Parameters:
prototype - The name of the prototype.
property - The name of the property.

Returns:
The value of the prototype's property or null.

getSetup

Object getSetup(<HopObject> object)

Gets a map of key/value pairs defining the database mapping of an arbitrary HopObject instance's prototype.

Parameters:
object - The underlying HopObject

Returns:
The resulting map structure

init

java.sql.Statement init()

Initializes the Rabbit framework. At this point a connection to the HSQL database is made and the db.properties file is written enabling read and write access to the database for the Helma application.

Returns:
An object used for executing a static SQL statement and returning the results it produces.

readPropertiesFile

Object readPropertiesFile(<String> dir, <String> name)

Reads a Java properties file into a JavaScript map.

Parameters:
dir - The directory containing the properties file
name - The name of the properties file

Returns:
The resulting map structure.

registerGlobals

void registerGlobals()

Registers some global and HopObject-related fields and methods for convenience. The following values are defined:
• global.EMAIL
• global.DATE
• global.FILE
• global.IMAGE
• global.NUMBER
• global.TEXT
• global.registerPrototype
• global.render
• global.resetPrototypes
• HopObject.prototype.edit_action
• HopObject.prototype.getChildElement
• HopObject.prototype.main_action
Most of the time this is automatically done by calling the Rabbit constructor without any arguments.

reset

void reset()

Drops all previously created tables from the database and clear the object cache of the Helma application.

setMeta

void setMeta(<String> prototype, <String> property, <Object> value)

For convenience, easier access and also better performance all settings of a prototype are serialized to a file which serves as object cache. This method sets the value of a property of the desired prototype in cache.

Parameters:
prototype - The name of the prototype.
property - The name of the property.
value - The future value of the prototype's property.

setup

void setup(<String> prototype, <Object> map)

Defines a HopObject prototype and its database mapping. The desired mapping is achieved by creating all necessary tables in the databse as well as writing the corresponding type.properties files for each prototype.

Parameters:
prototype - The name of the prototype.
map - A map of key/value pairs defining all database-related properties of the prototype's instances optionally including
• _db - the name of the database
• _children - all default and additional named collections
• _table - the name of the database table containing the data of the prototype's instances

update

void update(object, data)

Updates a HopObject instance from a map of key/value pairs derived from the corresponding Rabbit editor. Only properties which previously were defined via the setup() method will be updated.

Parameters:
The - desired HopObject instance
The - underlying map data

viewer

void viewer(<HopObject> object)

Renders a viewer for a HopObject instance. Each property will be represented with an appropriate display according to its datatype.

Parameters:
object - The underlying HopObject instance.

writePropertiesFile

String writePropertiesFile(<String> dir, <String> name, <Object> data)

Creates a Java properties file from a JavaScript map.

Parameters:
dir - The directory containing the properties file
name - The name of the properties file
data - The underlying map structure.

Returns:
The contents of the Java properties file

chooser

<static> String chooser(<String> name, <Object> options, <String> selected, buffer)

Helper method to render an HTML drop down element.

Parameters:
name - The name of the element.
options - A map of key/value pairs containing the names and values of each option.
selected - The currently selected value.
The - name of a snippet buffer (see snippet() method for details)

Returns:
The rendered HTML code.

dateEditor

<static> String dateEditor(<String> name, <Date> date, buffer)

Helper method to render a combination of HTML drop down elements representing an editor for a datetime value.

Parameters:
name - The name of the element.
date - The underlying date object.
The - name of a snippet buffer (see snippet() method for details)

Returns:
The rendered HTML code.

getPropertyMeta

<static> Object getPropertyMeta(<HopObject> object, <String> property, <String> name)

Helper method to retrieve property meta data.

Parameters:
object - The HopObject containing the underlying property
property - The name of the underlying property
name - The key of the desired meta value

Returns:
The resulting meta value

property

<static> HopObject property(<String> property)

Helper method to render a property of a HopObject instance. Depending on the content type the property will be output as inline display or as downloadable binary.

Parameters:
property - The name of the property.

Returns:
A new HopObject

setPropertyMeta

<static> void setPropertyMeta(<HopObject> object, <String> property, <String> name, <Object> value)

Helper method to set property meta data.

Parameters:
object - The HopObject containing the underlying property
property - The name of the underlying property
name - The key of the desired meta value
value - The property's future meta value

snippet

<static> Object snippet(<String> name, <Object> param, <String> buffer)

Renders a snippet. A snippet can be a skin or a "subskin", depending on the name. A subskin is a part of a skin file which is delimited by an HTML comment structure of the form
To enable a skin file containing snippets the file must end with ".snippets.skin". The rendering mechanics comply to Helma's generic skin features with the exception that an additional third argument can be provided to determine a snippet buffer. Snippet buffers are handled by res.data.rendered, ie. the rendered result will be appended to the contents of a named property in res.data.rendered.

Parameters:
name - The name of the snippet. If the name contains a colon (e.g. "main:header"), the Rabbit framework tries to render the subskin "header" contained in the skin file "main.snippets.skin". Otherwise, common rendering applies.
param - A generic Helma macro paramater object.
buffer - The name of a snippet buffer. This name will be used to determine a named property in res.data.rendered. E.g. "header" relates to res.data.rendered.header where any additionally rendered snippet using the "header" buffer will be appended to. Since snippet buffers reside in res.handlers.rendered, one can refer to them from within skin files via the "rendered" macro, e.g.

<% rendered.header %>