Antville 1.2 API Reference
Class Index | File Index

Classes


Class HopObject


Defined in: HopObject.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Helma’s built-in HopObject with Antville’s extensions.
Method Summary
Method Attributes Method Name and Description
 
addTag(name)
 
checkbox_macro(param, name)
 
created_macro(param, format)
 
creator_macro(param, mode)
 
 
<static>  
HopObject.getFromPath(name, collection)
 
 
 
 
 
input_macro(param, name)
 
 
link_filter(text, param, action)
 
link_macro(param, url, text)
 
log()
 
macro_macro(param, handler)
 
map(values)
 
modified_macro(param, format)
 
modifier_macro(param, mode)
 
notify(action)
 
 
radiobutton_macro(param, name)
<static>  
HopObject.remove(collection, options)
 
removeTag(tag)
 
select_macro(param, name)
 
self_macro(param, property)
 
setTags(tags)
 
skin_macro(param, name)
 
textarea_macro(param, name)
 
 
 
 
upload_macro(param, name)
Class Detail
HopObject()
Helma’s built-in HopObject with Antville’s extensions.
Method Detail
addTag(name)
Parameters:
{String} name

checkbox_macro(param, name)
Parameters:
{Object} param
{String} name

created_macro(param, format)
Parameters:
{Object} param
{String} format

creator_macro(param, mode)
Parameters:
{Object} param
{String} mode

{Object[]} getFormOptions()
Returns:
{Object[]}

{Number|String} getFormValue(name)
Parameters:
{String} name
Returns:
{Number|String}

<static> HopObject.getFromPath(name, collection)
Parameters:
{String} name
{HopObject} collection

getPermission()
Returns:
Boolean

{Tag[]} getTags()
Returns:
{Tag[]}

{String} getTitle()
Returns:
{String}

handleMetadata(name)
Parameters:
{String} name

input_macro(param, name)
Parameters:
{Object} param
{String} name

kind_macro()

{String} link_filter(text, param, action)
Parameters:
{String} text
{Object} param
{String} action
Returns:
{String}

link_macro(param, url, text)
Parameters:
{Object} param
{String} url
{String} text

log()

macro_macro(param, handler)
Parameters:
{Object} param
{HopObject} handler Optional

map(values)
Parameters:
{Object} values

modified_macro(param, format)
Parameters:
{Object} param
{String} format

modifier_macro(param, mode)
Parameters:
{Object} param
{String} mode

notify(action)
Parameters:
{String} action

onRequest()

radiobutton_macro(param, name)
Parameters:
{Object} param
{String} name

<static> HopObject.remove(collection, options)
Parameters:
{HopObject} collection
{Object} options
Optional flags, e.g. to force or prevent any conditional checks of individual prototype’s remove() methods

removeTag(tag)
Parameters:
{String} tag

select_macro(param, name)
Parameters:
{Object} param
{String} name

{HopObject} self_macro(param, property)
Parameters:
{Object} param
{String} property
Returns:
{HopObject}

setTags(tags)
Parameters:
{Tag[]|String} tags

skin_macro(param, name)
Parameters:
{Object} param
{String} name

textarea_macro(param, name)
Parameters:
{Object} param
{String} name

{String} toString()
Returns:
{String}

{Object} touch()
Returns:
{Object}

type_macro()

upload_macro(param, name)
Parameters:
{Object} param
{String} name

Documentation generated by JsDoc Toolkit 2.3.3-beta on Sat Jun 05 2010 18:29:02 GMT+0200 (CEST)