org.autoplot.jythonsupport.JythonUtil.ScriptDescriptor

Object containing a description of a script, containing its parameters and title describing it.


getDescription

getDescription( ) → String

sentence or paragraph documenting the script.

Returns:

a String

[search for examples] [view on GitHub] [view on old javadoc] [view source]


getIconURL

getIconURL( ) → String

the web address of an icon for the script.

Returns:

a String

[search for examples] [view on GitHub] [view on old javadoc] [view source]


getLabel

getLabel( ) → String

a short label, suitable for a menu item.

Returns:

a short label, suitable for a menu item.

[search for examples] [view on GitHub] [view on old javadoc] [view source]


getParams

getParams( ) → java.util.List

the list of the script parameters, containing the type and default values.

Returns:

a java.util.List

[search for examples] [view on GitHub] [view on old javadoc] [view source]


getTitle

getTitle( ) → String

a one-line title, suitable for a GUI heading.

Returns:

a one-line title, suitable for a GUI heading.

[search for examples] [view on GitHub] [view on old javadoc] [view source]