Uses of Interface
de.espirit.firstspirit.client.plugin.toolbar.ToolbarContext
Package
Description
Provides interfaces and types for client toolbar plugins.
This package provides types, interfaces and classes, that are to be used to integrate client plugins via the
This package provides types, interfaces and classes, that are to be used to integrate client plugins via the
public hotspot
of FirstSpirit into the toolbar of the java client.Provides interfaces and types for web client toolbar plugins.
This package provides types, interfaces and classes, that are to be used to integrate web client plugins via the
This package provides types, interfaces and classes, that are to be used to integrate web client plugins via the
public hotspot
of FirstSpirit into the toolbar of the web client.-
Uses of ToolbarContext in de.espirit.firstspirit.client.plugin.toolbar
Modifier and TypeMethodDescriptionvoid
ExecutableGroupingToolbarItem.execute
(@NotNull ToolbarContext context) Executes an operation associated with this toolbar item considering the given context.void
ExecutableToolbarItem.execute
(@NotNull ToolbarContext context) Executes an operation associated with this toolbar item considering the given context.@Nullable Icon
JavaClientToolbarItem.getIcon
(@NotNull ToolbarContext context) Returns the icon of this item ornull
if this item has no icon.
The recommended dimensions for this icon are: Within25x25 px
for java client toolbar button19x19
intoolbar sub items
Ensure to deliver icons of the same dimension in all methods delivering icons (icon
,pressed
,roll over
)@NotNull String
JavaClientToolbarItem.getLabel
(@NotNull ToolbarContext context) Provide the label for this item.@Nullable Icon
JavaClientToolbarItem.getPressedIcon
(@NotNull ToolbarContext context) Returns the icon in pressed state for this item ornull
if this item has no pressed icon.
If this method deliversnull
thenormal icon
will be used.@Nullable Icon
JavaClientToolbarItem.getRollOverIcon
(@NotNull ToolbarContext context) Returns an optional roll-over-icon of this item ornull
if thenormal icon
should be used.
The recommended dimensions for this icon are: Within25x25 px
for java client toolbar button19x19
intoolbar sub items
Ensure to deliver icons of the same dimension in all methods delivering icons (icon
,pressed
,roll over
) The hover background will be rendered from FirstSpirit.@Nullable Icon
ToggleableToolbarItem.getSelectedIcon
(@NotNull ToolbarContext context) Returns the icon of this item in selected state ornull
if thepressed icon
should be used.
The recommended dimensions for this icon is within25x25 px
.boolean
JavaClientToolbarItem.isEnabled
(@NotNull ToolbarContext context) Indicate, whether this item is enabled wrt. the given context.boolean
JavaClientToolbarItem.isVisible
(@NotNull ToolbarContext context) Indicates the visibility of this item wrt. the given context.void
ToggleableToolbarItem.setSelected
(@NotNull ToolbarContext context, boolean selected) Sets the selection mode of this item. -
Uses of ToolbarContext in de.espirit.firstspirit.webedit.plugin.toolbar
Modifier and TypeMethodDescriptionvoid
ExecutableToolbarActionsItem.execute
(@NotNull ToolbarContext context) Executes an operation associated with this item, taking into consideration the given context.ClientScriptProvidingToolbarActionsItem.getIconPath
(@NotNull ToolbarContext context) Returns a URL for the button item's icon graphic that will be shown in the WebClient.@Nullable String
ExecutableToolbarActionsItem.getIconPath
(@NotNull ToolbarContext context) Returns a URL for an icon graphic associated with this item.@NotNull String
ClientScriptProvidingToolbarActionsItem.getLabel
(@NotNull ToolbarContext context) Provides a label for this item wrt. the given context.@NotNull String
ExecutableToolbarActionsItem.getLabel
(@NotNull ToolbarContext context) Provides a label for this item.ClientScriptProvidingToolbarActionsItem.getScript
(ToolbarContext context) Returns client script code that will be executed within the WebClient interface.boolean
WebeditToolbarItem.isEnabled
(@NotNull ToolbarContext context) Indicates, whether this item is enabled wrt. the given context.boolean
WebeditToolbarItem.isVisible
(@NotNull ToolbarContext context) Indicates the visibility of this item wrt. the given context.