internal package
Foswiki::Plugins::JQueryPlugin
Container for jQuery and plugins
init()
initialize plugin container
ObjectMethod
createPlugin( $pluginName, ... ) → $plugin
Helper method to establish plugin dependencies. See
load()
.
ObjectMethd createTheme ($themeName, $url) -> $boolean
Helper method to switch on a theme. Returns true
if
$themeName
has been loaded successfully. Note that a previously
loaded theme will be replaced with the new one as there can only
be one theme per html page. The $url parameter optionally specifies
from where to load the theme. It defaults to the url registered
in
configure
for the named theme.
ObjectMethod
registerPlugin( $pluginName, $class ) → $descriptor
Helper method to register a plugin.
ObjectMethod
registerTheme( $themeName, $url ) → $descriptor
Helper method to register a theme.
ObjectMethod
finish
finalizer
ObjectMethod
load ( $pluginName ) → $plugin
Loads a plugin and runs its initializer.
parameters
-
$pluginName
: name of plugin
returns
-
$plugin
: returns the plugin object or false if instantiating the plugin failed
Helper function to expand standard escape sequences
$percnt
,
$nop
,
$n
and
$dollar
.
-
$format
: format string to be expaneded
-
%params
: optional hash array containing further key-value pairs to be expanded as well, that is all occurences of $key
will be replaced by its value
as defined in %params
-
$string
: returns the resulting text
ClassMethod
getPlugins () → @plugins
returns a list of all known plugins
ClassMethod
getRandom () → $integer
returns a random positive integer between 1 and 10000.
this can be used to
generate html element IDs which are not
allowed to clash within the same html page,
even not when it got extended via ajax.