XmlMap

Overview

File

Class

Tree

Index

Help

Rabbit 1.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class XmlMap

Object
   |
   +--HopObject
         |
         +--XmlMap

class XmlMap
extends HopObject

A simple HopObject-based, XML-powered property manager. Its properties are handled as XML elements containing the corresponding XML-encoded values.
Defined in .jsdoc/XmlMap.js

Fields inherited from class HopObject


   cache, _id, _parent, _prototype

Constructor Summary
`XmlMap ()` Constructs a new XmlMap instance.

Method Summary
`Object`	`get(<String> key)` Returns the value of a property of the XmlMap instance.
`HopObject`	`getAll()` Returns the cached property map of the XmlMap instance.
`String`	`getXmlRef()` Gets the name of the property that holds the XML content for this object.
`Array`	`keys()` Get all valid keys of the XmlMap instance.
`void`	`remove(<String> key)` Removes a property from the cache object and updates the XML content at the parent object.
`void`	`removeAll()` Removes all properties and values from the XmlMap instance.
`void`	`set(<String> key, <Object> value)` Sets a property of the cache object and updates the XML content at the parent object.
`Boolean`	`setAll(<HopObject> obj)` Replaces the whole XML-encoded content.
`Number`	`size()` Gets the amount of elements contained by the XmlMap instance.
`String`	`toSource()` Returns the source of the underlying HopObject of the XmlMap instance.
`String`	`toString()` Returns a string representation of the XmlMap instance.
`String`	`valueOf()` Gets the raw, XML-encoded content.

Methods inherited from class HopObject



add, addAt, clearCache, contains, count, editor, getById, getChildElement, href, invalidate, list, onRequest, persist, prefetchChildren, removeChild, renderSkin, renderSkinAsString, setParent

Constructor Detail

XmlMap

XmlMap()

Constructs a new XmlMap instance.

Method Detail

get

Object get(<String> key)

Returns the value of a property of the XmlMap instance.

Parameters:

key

Returns:

The resulting value

getAll

HopObject getAll()

Returns the cached property map of the XmlMap instance. Checks if the cache is still up-to-date and (re)creates it if necessary.

Returns:

The cached map of the XmlMap instance

getXmlRef

String getXmlRef()

Gets the name of the property that holds the XML content for this object. The name is constructed out of the object's mountpoint and the suffix "_xml".

Returns:

The resulting value

keys

Array keys()

Get all valid keys of the XmlMap instance.

Returns:

The list of valid keys

remove

void remove(<String> key)

Removes a property from the cache object and updates the XML content at the parent object.

Parameters:

key

removeAll

void removeAll()

Removes all properties and values from the XmlMap instance.

set

void set(<String> key, <Object> value)

Sets a property of the cache object and updates the XML content at the parent object.

Parameters:

key

value

setAll

Boolean setAll(<HopObject> obj)

Replaces the whole XML-encoded content.

Parameters:

obj

Returns:

False in case an error occured, false otherwise

size

Number size()

Gets the amount of elements contained by the XmlMap instance.

Returns:

The size of the XmlMap instance.

toSource

String toSource()

Returns the source of the underlying HopObject of the XmlMap instance. Useful for debugging purposes.

Returns:

The source of the underlying HopObject.

toString

String toString()

Returns a string representation of the XmlMap instance.

Returns:

A string representing the XmlMap object

valueOf

String valueOf()

Gets the raw, XML-encoded content.

Returns:

The XML content

Overview

File

Class

Tree

Index

Help

Rabbit 1.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Thu Feb 15 20:58:41 2007