Package com.jalios.jcms.wysiwyg

Class PluginConfiguration

java.lang.Object

com.jalios.jcms.wysiwyg.PluginConfiguration

All Implemented Interfaces:

java.lang.Comparable<PluginConfiguration>

public class PluginConfiguration
extends java.lang.Object
implements java.lang.Comparable<PluginConfiguration>

Constructor Summary

Constructors

Constructor	Description
PluginConfiguration(java.lang.String id, java.lang.String path)

Method Summary

Modifier and Type	Method	Description
int	compareTo(PluginConfiguration other)
boolean	equals(java.lang.Object obj)
java.lang.String	getBasePath()	Returns the Plugin base folder path.
java.lang.String	getCss()	Returns the Plugin CSS path or null if the file doesn't exist.
java.lang.String	getId()	Returns the plugin ID
java.lang.String	getLanguagePath(java.lang.String lang)	Returns the JS lang file path from the given language. If the JS lang file is not found for the given language, it uses the JS lang file with the main language of the site. If the JS lang file is not found for the main language, it uses the english JS lang.
java.lang.String	getPath()	Returns the JavaScript file path of the plugin.
int	hashCode()
void	init()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginConfiguration

public PluginConfiguration(java.lang.String id,
                           java.lang.String path)

Method Detail

init

public void init()

getId

public java.lang.String getId()

Returns the plugin ID

Returns:

The plugin ID

getPath

public java.lang.String getPath()

Returns the JavaScript file path of the plugin.

Returns:

The JS file path

getBasePath

public java.lang.String getBasePath()

Returns the Plugin base folder path.

Returns:

The Plugin base folder path

getCss

public java.lang.String getCss()

Returns the Plugin CSS path or null if the file doesn't exist.

Returns:

The Plugin CSS file path

getLanguagePath

public java.lang.String getLanguagePath(java.lang.String lang)

Returns the JS lang file path from the given language.
If the JS lang file is not found for the given language, it uses the JS lang file with the main language of the site.
If the JS lang file is not found for the main language, it uses the english JS lang.

Parameters:

lang - language of the JS lang file to find

Returns:

The JS lang file path

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(PluginConfiguration other)

Specified by:

compareTo in interface java.lang.Comparable<PluginConfiguration>