internal package Foswiki::Plugins::JQueryPlugin::Plugin

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

internal package Foswiki::Plugins::JQueryPlugin::Plugin

abstract class for a jQuery plugin

ClassMethod new( $class, ... )

  • $class: Plugin class
  • ...: additional properties to be added to the object. i.e.
    • name => 'pluginName' (default unknown)
    • author => 'pluginAuthor' (default unknown)
    • version => 'pluginVersion' (default unknown)
    • summary => 'pluginSummary' (default undefined)
    • documentation => 'pluginDocumentation' (default JQuery<Name>)
    • homepage => 'pluginHomepage' (default unknown)
    • debug => 0 or 1 (default $Foswiki::cfg{JQueryPlugin}{Debug})

ClassMethod init( )

add jQuery plugin to web and make sure all its dependencies are fulfilled.

ClassMethod getSummary()

returns the summary text for this plugin. this is either the summary property of the class or the summary section of the plugin's documentation topic.

Topic revision: r1 - 19 Apr 2011, ProjectContributor
This site is powered by FoswikiCopyright © CC-BY-SA by the contributing authors. All material on this collaboration platform is copyrighted under CC-BY-SA by the contributing authors unless otherwise noted.
Ideas, requests, problems regarding Foswiki? Send feedback