de.espirit.firstspirit.webedit.plugin

Interface ClientScriptProvidingItem<C extends BaseContext>

All Known Subinterfaces:

ClientScriptProvidingInlineEditItem, ClientScriptProvidingToolbarActionsItem

public interface ClientScriptProvidingItem<C extends BaseContext>

Item providing a native script for client-side execution.

Since:

5.0.103

Method Summary

Methods

Modifier and Type	Method and Description
String	getIconPath(C context) Provides the resource path to this item's icon.
String	getLabel(C context) Provides a label for this item wrt. the given context.
String	getScript(C context) Returns script code, that will be executed on client-side.

Method Detail

getLabel

@NotNull
String getLabel(@NotNull
                      C context)

Provides a label for this item wrt. the given context.

Parameters:

context - The context to be considered for providing a label.

Returns:

The resulting label.

Since:

5.0.103

getIconPath

@Nullable
String getIconPath(@NotNull
                          C context)

Provides the resource path to this item's icon.

Parameters:

context - The context to be considered for providing the path.

Returns:

A resource path to the item or null, if the item has no icon.

Since:

5.0.103

getScript

@Nullable
String getScript(C context)

Returns script code, that will be executed on client-side.

Parameters:

context - The plug-in context.

Returns:

Native client script code or null.

Since:

5.0.103