PerlDoc

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

Perl Module:

---

Parent package: Foswiki::Plugins
Child packages:

More ...Less ...

• Foswiki::Plugins::JQueryPlugin::ANIMATE - This is the perl stub for the animate plugin.
• Foswiki::Plugins::JQueryPlugin::BLOCKUI - This is the perl stub for the jquery.blockUI plugin.
• Foswiki::Plugins::JQueryPlugin::BROWSER - This is the perl stub for the jquery.empty plugin.
• Foswiki::Plugins::JQueryPlugin::BUTTON - This is the perl stub for the jquery.button plugin.
• Foswiki::Plugins::JQueryPlugin::CHILI - This is the perl stub for the jquery.chili plugin.
• Foswiki::Plugins::JQueryPlugin::COOKIE - This is the perl stub for the jquery.cookie plugin.
• Foswiki::Plugins::JQueryPlugin::CYCLE - This is the perl stub for the jquery.cycle plugin.
• Foswiki::Plugins::JQueryPlugin::CombineService - combines the js and css files of a set of jQuery modules into a single js and css file
• Foswiki::Plugins::JQueryPlugin::EASING - This is the perl stub for the jquery.easing plugin.
• Foswiki::Plugins::JQueryPlugin::EMPTY - This is the perl stub for the jquery.empty plugin.
• Foswiki::Plugins::JQueryPlugin::FARBTASTIC - This is the perl stub for the jquery.farbtastic plugin.
• Foswiki::Plugins::JQueryPlugin::FLUIDFONT - This is the perl stub for the jquery.fluidfont plugin.
• Foswiki::Plugins::JQueryPlugin::FOCUS - This is the perl stub for the jquery.focus plugin.
• Foswiki::Plugins::JQueryPlugin::FONTAWESOME - This is the perl stub for the fontawesome plugin.
• Foswiki::Plugins::JQueryPlugin::FORM - This is the perl stub for the jquery.form plugin.
• Foswiki::Plugins::JQueryPlugin::FOSWIKI - This is the perl stub for the jquery.foswiki plugin.
• Foswiki::Plugins::JQueryPlugin::HOVERINTENT - This is the perl stub for the jquery.hoverIntent plugin.
• Foswiki::Plugins::JQueryPlugin::I18N - This is the perl stub for the jquery.i18n plugin.
• Foswiki::Plugins::JQueryPlugin::IMAGESLOADED - This is the perl stub for the imagesloaded plugin.
• Foswiki::Plugins::JQueryPlugin::INNERFADE - This is the perl stub for the jquery.innerfade plugin.
• Foswiki::Plugins::JQueryPlugin::IconService - Singleton class that handles all sorts of icons, image as well as font icons
• Foswiki::Plugins::JQueryPlugin::LOADER
• Foswiki::Plugins::JQueryPlugin::LOCALSCROLL - This is the perl stub for the jquery.localscroll plugin.
• Foswiki::Plugins::JQueryPlugin::MASKEDINPUT - This is the perl stub for the jquery.maskedinput plugin.
• Foswiki::Plugins::JQueryPlugin::MASONRY - This is the perl stub for the jquery.masonry plugin.
• Foswiki::Plugins::JQueryPlugin::METADATA - This is the perl stub for the jquery.metadata plugin.
• Foswiki::Plugins::JQueryPlugin::MIGRATE - This is the perl stub for the jquery.migrate plugin.
• Foswiki::Plugins::JQueryPlugin::MOUSEWHEEL
• Foswiki::Plugins::JQueryPlugin::OBSERVER
• Foswiki::Plugins::JQueryPlugin::PNOTIFY - This is the perl stub for the jquery.pnotify plugin.
• Foswiki::Plugins::JQueryPlugin::POPUPWINDOW - This is the perl stub for the jquery.popupwindow plugin.
• Foswiki::Plugins::JQueryPlugin::Plugin - abstract class for a jQuery plugin
• Foswiki::Plugins::JQueryPlugin::Plugins - Container for jQuery and plugins
• Foswiki::Plugins::JQueryPlugin::QUERYOBJECT - This is the perl stub for the jquery.queryobject plugin.
• Foswiki::Plugins::JQueryPlugin::RENDER
• Foswiki::Plugins::JQueryPlugin::SCROLLTO - This is the perl stub for the jquery.scrollto plugin.
• Foswiki::Plugins::JQueryPlugin::SERIALSCROLL - This is the perl stub for the jquery.serialScroll plugin.
• Foswiki::Plugins::JQueryPlugin::SHRINKURLS - This is the perl stub for the jquery.shrinkurl plugin.
• Foswiki::Plugins::JQueryPlugin::SLIMBOX - This is the perl stub for the slimbox2 plugin.
• Foswiki::Plugins::JQueryPlugin::SPRINTF
• Foswiki::Plugins::JQueryPlugin::STARS - This is the perl stub for the jquery star STARS plugin.
• Foswiki::Plugins::JQueryPlugin::SUPERFISH - This is the perl stub for the jquery.superfish plugin.
• Foswiki::Plugins::JQueryPlugin::TABPANE - This is the perl stub for the jquery.tabpane plugin.
• Foswiki::Plugins::JQueryPlugin::TEXTBOXLIST - This is the perl stub for the jquery.textboxlist plugin.
• Foswiki::Plugins::JQueryPlugin::TREEVIEW - This is the perl stub for the jquery.treeview plugin.
• Foswiki::Plugins::JQueryPlugin::UI - This is the perl stub for the jquery.ui
• Foswiki::Plugins::JQueryPlugin::VALIDATE - This is the perl stub for the jquery.validate plugin.
• Foswiki::Plugins::JQueryPlugin::VIEW
• Foswiki::Plugins::JQueryPlugin::WIKIWORD - This is the perl stub for the jquery.wikiword plugin.

internal package Foswiki::Plugins::JQueryPlugin

Container for jQuery and plugins

initPlugin($topic, $web, $user) → $boolean

finish up the plugins container

createPlugin($pluginName, …) → $plugin

API to create a jQuery plugin. Instantiating it adds all required javascript and css files to the html page header.

createTheme($themeName) → $boolean

API to load a jQuery UI theme. Returns true if the theme has been loaded successfully.

registerPlugin($pluginName, $class) → $plugin

API to register a jQuery plugin. This is of use for other Foswiki plugins to register their javascript modules as a jQuery plugin. Registering a plugin 'foobar' will make it available via %JQREQUIRE{"foobar"}%.

Class will default to 'Foswiki::Plugins::JQueryPlugin::FOOBAR,

The FOOBAR.pm stub must be derived from Foswiki::Plugins::JQueryPlugin::Plugin class.

registerTheme($themeName, $url)

API to register a jQuery theme. this is of use for other Foswiki plugins to register their theme. Registering a theme 'foobar' will make it available via %JQTHEME{"foobar"}%.

The $url parameter will default to '/pub/System/JQueryPlugin/ui/$themeName/jquery-ui.css'.

handleButton($session, $params, $topic, $web) → $result

Handles the =%BUTTON% tag.

handleRestTmpl($session, $params, $topic, $web) → $result

Handles the tmpl rest handler

getCombineService() → $combineService

returns a singleton instance of a Foswiki::Plugins::JQueryPlugin::CombineService

handlePopUpWindow($session, $params, $topic, $web) → $result

Handles the =%POPUPWINDOW% tag.

handleTabPane($session, $params, $topic, $web) → $result

Handles the =%TABPANE% tag.

handleTab($session, $params, $topic, $web) → $result

Handles the =%TAB% tag.

handleEndTab($session, $params, $topic, $web) → $result

Handles the =%ENDTAB% tag.

handleEndTabPane($session, $params, $topic, $web) → $result

Handles the =%ENDTABPANE% tag.

handleJQueryRequire($session, $params, $topic, $web) → $result

Handles the =%JQREQUIRE% tag.

handleJQueryTheme($session, $params, $topic, $web) → $result

Handles the =%JQTHEME% tag.

handleJQueryIconPath($session, $params, $topic, $web) → $result

Handles the =%JQICONPATH% tag.

handleJQueryIcon($session, $params, $topic, $web) → $result

Handles the =%JQICON% tag.

getIconService() → $combineService

returns a singleton instance of a Foswiki::Plugins::JQueryPlugin::IconService

handleJQueryPlugins($session, $params, $topic, $web) → $result

Handles the =%JQPLUGINS% tag.