Antville 1.2 API Reference
Class Index | File Index

Classes


Class Image


Extends HopObject.

Defined in: Image.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Image(data)
Field Summary
Field Attributes Field Name and Description
 
 
 
 
 
 
 
<static> <constant>  
Image.KEYS
 
 
 
 
 
 
 
 
 
 
 
 
<static> <constant>  
 
 
Method Summary
Method Attributes Method Name and Description
 
 
 
getConstraint(mime, maxWidth, maxHeight)
 
getFile(name)
<static>  
Image.getFileExtension(type)
 
 
 
getPermission(action)
 
 
getUrl(name)
 
href(action)
 
<static>  
Image.remove()
 
 
render_macro(param)
 
 
 
update(data)
 
 
writeFiles(data, thumbnail)
Methods borrowed from class HopObject:
addTag, checkbox_macro, created_macro, creator_macro, getFormOptions, getTags, getTitle, handleMetadata, input_macro, kind_macro, link_filter, link_macro, log, map, modified_macro, modifier_macro, notify, onRequest, radiobutton_macro, removeTag, select_macro, self_macro, setTags, skin_macro, textarea_macro, toString, touch, type_macro, upload_macro
Class Detail
Image(data)
Parameters:
{Object} data
Field Detail
{Number} contentLength

{String} contentType

{Date} created

{User} creator

{String} description

{String} fileName

{Number} height

<static> <constant> Image.KEYS

{Metadata} metadata

{Date} modified

{User} modifier

{String} name

origin

{HopObject} parent

{Number} parent_id

{String} parent_type

{String} prototype

{Tag[]} tags

{Number} thumbnailHeight

{String} thumbnailName

<static> <constant> Image.THUMBNAILWIDTH

{Number} thumbnailWidth

{Number} width
Method Detail
contentLength_macro()

{String} getConfirmText()
Returns:
{String}

{Object} getConstraint(mime, maxWidth, maxHeight)
Parameters:
{helma.util.MimePart} mime
{Number} maxWidth
{Number} maxHeight
Throws:
{Error}
Returns:
{Object}

{helma.File} getFile(name)
Parameters:
{Object} name
Returns:
{helma.File}
See:
Site#getStaticFile

<static> {String} Image.getFileExtension(type)
Parameters:
{String} type
Returns:
{String}

{Object} getFormValue(name)
Parameters:
{String} name
Returns:
{Object}

{String} getJSON()
Returns:
{String}

{Boolean} getPermission(action)
Parameters:
{String} action
Returns:
{Boolean}

{helma.File} getThumbnailFile()
Returns:
{helma.File}

{String} getUrl(name)
Parameters:
{Object} name
Returns:
{String}
See:
Site#getStaticUrl

{String} href(action)
Parameters:
{String} action
Returns:
{String}

macro_macro()

<static> Image.remove()

removeFiles()
Throws:
{Error}

render_macro(param)
Parameters:
{Object} param

tags_macro()

thumbnail_macro(param)
Parameters:
{Object} param

update(data)
Parameters:
{Object} data

url_macro()

writeFiles(data, thumbnail)
Parameters:
{helma.Image|helma.util.MimePart} data
{Object} thumbnail
Throws:
{Error}

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