Antville 1.2-beta API Reference
Class Index | File Index

Classes


Class Site


Extends HopObject.

Defined in: Site.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Site(name, title)
A Site object is the basic container of Antville.
Field Summary
Field Attributes Field Name and Description
<static>  
Site.$tags
<static>  
Site.archive
<static>  
The way the archive of a site is displayed
<static>  
The way comments of a site are displayed
<static>  
Site.created
The date and time of site creation
<static>  
Site.creator
A reference to a user who created a site
<static>  
Site.files
<static>  
Site.galleries
<static>  
Site.images
<static>  
Site.layout
<static>  
Site.locale
The place and language settings of a site
<static>  
The long date format string
<static>  
Site.members
<static>  
Site.metadata
<static>  
Site.mode
The access level of a site
<static>  
Site.modified
The date and time when a site was last modified
<static>  
Site.modifier
A reference to a user who modified a site
<static>  
The way notifications are sent from a site
<static>  
Site.notified
The date and time of the last notification sent to the owners of a site
<static>  
Site.pageMode
The way stories of a site are displayed
<static>  
Site.pageSize
The amount of stories to be displayed simultaneously
<static>  
Site.polls
<static>  
The short date format string
<static>  
Site.status
The trust level of a site
<static>  
Site.stories
<static>  
Site.tagline
An arbitrary text describing a site
<static>  
Site.tags
<static>  
Site.timeZone
The time and date settings of a site
Method Summary
Method Attributes Method Name and Description
 
age_macro(param)
 
 
callback(ref)
 
 
 
<static>  
<static>  
Site.getByName(name)
<static>  
<static>  
 
 
 
 
<static>  
Site.getModes()
<static>  
<static>  
Site.getPageModes()
 
getPermission(action)
 
 
<static>  
Site.getStatus()
 
getTags(type, group)
 
 
getXml(collection)
 
 
<static>  
Site.remove(site)
<static>  
Site.require(mode)
 
 
 
update(data)
Methods borrowed from class HopObject:
addTag, checkbox_macro, created_macro, creator_macro, getFormValue, getTitle, handleMetadata, input_macro, kind_macro, link_filter, link_macro, log, macro_macro, 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
Site(name, title)
A Site object is the basic container of Antville.
Parameters:
{String} name
A unique identifier also used in the URL of a site
{String} title
An arbitrary string branding a site
Field Detail
<static> {Tag[]} Site.$tags

<static> {Archive} Site.archive

<static> {String} Site.archiveMode
The way the archive of a site is displayed

<static> {String} Site.commentMode
The way comments of a site are displayed

<static> {Date} Site.created
The date and time of site creation

<static> {User} Site.creator
A reference to a user who created a site

<static> {Files} Site.files

<static> {Tags} Site.galleries

<static> {Images} Site.images

<static> {Layout} Site.layout

<static> {String} Site.locale
The place and language settings of a site

<static> {String} Site.longDateFormat
The long date format string

<static> {Members} Site.members

<static> {Metadata} Site.metadata

<static> {String} Site.mode
The access level of a site

<static> {Date} Site.modified
The date and time when a site was last modified

<static> {User} Site.modifier
A reference to a user who modified a site

<static> {String} Site.notificationMode
The way notifications are sent from a site

<static> {Date} Site.notified
The date and time of the last notification sent to the owners of a site

<static> {String} Site.pageMode
The way stories of a site are displayed

<static> {Number} Site.pageSize
The amount of stories to be displayed simultaneously

<static> {Polls} Site.polls

<static> {String} Site.shortDateFormat
The short date format string

<static> {String} Site.status
The trust level of a site

<static> {Stories} Site.stories

<static> {String} Site.tagline
An arbitrary text describing a site

<static> {Tags} Site.tags

<static> {String} Site.timeZone
The time and date settings of a site
Method Detail
age_macro(param)
Parameters:
{Object} param

calendar_macro(param)
Parameters:
{Object} param

callback(ref)
Parameters:
{Object} ref

deleted_macro()

diskspace_macro()

{String[]} getAdminHeader(name)
Parameters:
{String} name
Returns:
{String[]}

<static> {String[]} Site.getArchiveModes()
Returns:
{String[]}
See:
defineConstants

<static> {Site} Site.getByName(name)
Parameters:
{String} name
Returns:
{Site}

<static> {String[]} Site.getCallbackModes()
Returns:
{String[]}
See:
defineConstants

<static> {String[]} Site.getCommentModes()
Returns:
{String[]}
See:
defineConstants

{float} getDiskSpace()
Returns:
{float}

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

{java.util.Locale} getLocale()
Returns:
{java.util.Locale}

{HopObject} getMacroHandler(name)
Parameters:
{String} name
Returns:
{HopObject}

<static> {String[]} Site.getModes()
Returns:
{String[]}
See:
defineConstants

<static> {String[]} Site.getNotificationModes()
Returns:
{String[]}
See:
defineConstants

<static> {String[]} Site.getPageModes()
Returns:
{String[]}
See:
defineConstants

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

{helma.File} getStaticFile(tail)
Parameters:
{String} tail
Returns:
{helma.File}

{String} getStaticUrl(tail)
Parameters:
{String} tail
Returns:
{String}

<static> {String[]} Site.getStatus()
Returns:
{String[]}
See:
defineConstants

{Tag[]} getTags(type, group)
Parameters:
{String} type
{String} group
Returns:
{Tag[]}

{java.util.TimeZone} getTimeZone()
Returns:
{java.util.TimeZone}

getXml(collection)
Parameters:
{Story[]} collection

processHref(href)
Parameters:
{String} href

referrers_macro()

<static> Site.remove(site)
Parameters:
{Site} site

<static> {Boolean} Site.require(mode)
Parameters:
{String} mode
Returns:
{Boolean}

spamfilter_macro()

stories_macro()

update(data)
Parameters:
{Object} data

Documentation generated by JsDoc Toolkit 2.3.2 on Sat Jan 16 2010 00:41:43 GMT+0100 (CET)