com.ephox.editlive.applet.parameters
Interface Parameters

public interface Parameters

Provides access to applet parameters in Advanced API plugins.

Instance available via ELJBean.getAppletParameters(), however use ELJBean.isEditorRunningAsApplet() first to check if an applet is in use.

Since:

7.5

Method Summary

boolean	exists(String name) Determine if a parameter was set on the applet.
String	get(String name) Returns the raw parameter value
String[]	getArray(String name) Splits a parameter value on the '|' character and returns the resulting array
String[]	getArray(String name, String delimiterRegex) Uses String.split(String) to split a parameter value with the given regular expression
boolean	getBoolean(String name) Calls getBoolean(String, boolean) with a default value of false
boolean	getBoolean(String name, boolean defaultValue) Uses Boolean.valueOf(String) to parse the parameter value.
String	getOr(String name, String defaultValue) Returns the raw parameter value, or defaultValue if the parameter is null.

Method Detail

exists

boolean exists(String name)

Determine if a parameter was set on the applet. Also logs the parameter value at debug level.

get

String get(String name)

Returns the raw parameter value

getOr

String getOr(String name,
             String defaultValue)

Returns the raw parameter value, or defaultValue if the parameter is null.

getArray

String[] getArray(String name)

Splits a parameter value on the '|' character and returns the resulting array

getArray

String[] getArray(String name,
                  String delimiterRegex)

Uses String.split(String) to split a parameter value with the given regular expression

getBoolean

boolean getBoolean(String name)

Calls getBoolean(String, boolean) with a default value of false

getBoolean

boolean getBoolean(String name,
                   boolean defaultValue)

Uses Boolean.valueOf(String) to parse the parameter value. If the value does not exist, returns the default value.