Package de.elo.client.scripting.components.ribbon

Class RibbonScriptButton

Object

RibbonScriptButton

public class RibbonScriptButton
extends Object

Überschrift: RibbonScriptButton.

Beschreibung: Ein per Script erstellten Ribbon-Button.

Ribbon-Erweiterungen müssen im Event ScriptEvents.SimpleScriptEvent.ExpandRibbon vorgenommen werden. Später angelegte Tabs, Bänder, Buttons oder Text- und Icon-Änderungen können nicht mehr berücksichtigt werden.

Copyright: Copyright (c) ELO Digital Office GmbH 2016

Since:

10.00.000

Constructor Summary

Constructors

Constructor	Description
RibbonScriptButton(String tabId, String bandId, String buttonId, int fctNr)	Nur zur Internen verwendung.

Method Summary

Modifier and Type	Method	Description
void	asTile(boolean asTile)	Setzt, ob der Button auch als Kachel im Menü angelegt werden soll.
void	execute()	Führt die mit setCallback(BaseFunction, ScriptableObject) hinterlegte JavaScript-Funktion direkt aus, falls eine hinterlegt wurde.
String	getBandId()	Liefert die Id des Bands, welchem der Button zugeordnet wurde.
int	getFctNr()	Liefert die interne Funktionsnummer.
String	getIconPath()	Liefert den Pfad zu dem Icon, welches von diesem Button verwendet werden soll.
String	getId()	Liefert die Id dieses Buttons.
int	getOrdinal()	Setzt eine Zahl für die Sortierung der Skriptbuttons.
int	getPriority()	Liefert die Anzeigepriorität des Buttons.
String	getSearchKeywords()	Liefert die Suchbegriffe für die Ribbon-Suche.
String	getTabId()	Liefert die Id des Tabs, welchem der Button zugeordnet wurde.
String	getTileIconName()	Liefert den Namen des Icons, welches für die Anzeige der Kachel verwendet werden soll.
String	getTitle()	Liefert den Titel des Buttons.
String	getTooltip()	Liefert den Tooltip des Buttons.
boolean	isEnabled()	Deprecated. 12.00.000: Ersetzt durch isEnabled(List).
boolean	isEnabled(List<IndexedElement> selectedItems)	Liefert, ob dieser ScriptButton gerade aktiv ist.
boolean	isTile()	Liefert die Information, ob der Button auch als Kachel angelegt werden soll.
void	setCallback(BaseFunction callbackFunction, ScriptableObject thisScope)	Fügt ein Scripting-Callback hinzu, welches beim Ausführen der Funktion aufgerufen wird.
void	setEnabledCallback(BaseFunction callbackFunction, ScriptableObject thisScope)	Setzt eine JavaScript-Funktion als Callback, über welche gesteuert wird ob dieser ScriptButton ausgeführt werden kann.
void	setIconName(String iconName)	Gibt an, welches Icon der Button verwenden soll.
void	setOrdinal(int ordinal)	Setzt eine Zahl für die Sortierung der Skriptbuttons.
void	setPriority(int priority)	Setzt die Anzeige-Priorität des Buttons.
void	setSearchKeywords(String searchKeywords)	Setzt die Suchbegriffe für die Ribbon-Suche.
void	setTileIconName(String iconName)	Legt fest, welches Icon für die Kachel verwendet werden soll.
void	setTitle(String title)	Setzt den Titel des Buttons.
void	setTooltip(String tooltip)	Setzt den Tooltip des Buttons.
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RibbonScriptButton

public RibbonScriptButton(String tabId,
                          String bandId,
                          String buttonId,
                          int fctNr)
                   throws IllegalArgumentException

Nur zur Internen verwendung. Verwenden sie RibbonAdapter.addButton(String, String, String).

Parameters:

tabId - Tab Id

bandId - Band Id

buttonId - Button Id

fctNr - Funktionsnummer

Throws:

IllegalArgumentException - Wenn nicht erlaubte Zeichen in der buttonId verwendet werden.

Method Detail

getTabId

public String getTabId()

Liefert die Id des Tabs, welchem der Button zugeordnet wurde.

Returns:

Tab Id

getBandId

public String getBandId()

Liefert die Id des Bands, welchem der Button zugeordnet wurde.

Returns:

Band Id

getId

public String getId()

Liefert die Id dieses Buttons.

Returns:

Button Id

getFctNr

public int getFctNr()

Liefert die interne Funktionsnummer.

Bitte verwenden Sie getId() zur eindeutigen Identifikation des ScriptButtons. Die Funktionsnummer wird vom System zugeteilt.

Returns:

Funktionsnummer

getPriority

public int getPriority()

Liefert die Anzeigepriorität des Buttons.

Returns:

Anzeigepriorität

setPriority

public void setPriority(int priority)

Setzt die Anzeige-Priorität des Buttons.

Gültige Werte sind 1 (hohe Priorität) bis 3 (niedrige Priorität).

Parameters:

priority - Anzeigepriorität

getTitle

public String getTitle()

Liefert den Titel des Buttons.

Returns:

Titel

setTitle

public void setTitle(String title)

Setzt den Titel des Buttons.

Parameters:

title - Titel

getTooltip

public String getTooltip()

Liefert den Tooltip des Buttons.

Returns:

Tooltip

setTooltip

public void setTooltip(String tooltip)

Setzt den Tooltip des Buttons.

Parameters:

tooltip - Tooltip

getIconPath

public String getIconPath()

Liefert den Pfad zu dem Icon, welches von diesem Button verwendet werden soll.

Returns:

Icon Path

setIconName

public void setIconName(String iconName)

Gibt an, welches Icon der Button verwenden soll.

Das Icon muss im selben Ordner liegen, wie das Script welches den Button erstellt.

Zur optimalen Darstellung sollte das Icon als ICO mit mindestens 32px und 64px Ebenen zur verfügung gestellt werden und zusätzlich ein Icon mit dem Postfix "_16" für die kleinere Darstellung mit weniger Details und 16px und 32px Ebenen. Andere Grafikformate sind möglich.

Parameters:

iconName - Kurzbezeichnung des Icons

setCallback

public void setCallback(BaseFunction callbackFunction,
                        ScriptableObject thisScope)

Fügt ein Scripting-Callback hinzu, welches beim Ausführen der Funktion aufgerufen wird.

Parameters:

callbackFunction - JavaScript Funktion, welche aufgerufen wird wenn die Funktion ausgeführt wird.

thisScope - "this" Scope der Funktion

execute

public void execute()

Führt die mit setCallback(BaseFunction, ScriptableObject) hinterlegte JavaScript-Funktion direkt aus, falls eine hinterlegt wurde.

Bei aufruf dieser Methode wird der Enabled-Zustand der Funktion nicht überprüft und auch keine Funktions-Start/Ende Events gefeuert.

setEnabledCallback

public void setEnabledCallback(BaseFunction callbackFunction,
                               ScriptableObject thisScope)

Setzt eine JavaScript-Funktion als Callback, über welche gesteuert wird ob dieser ScriptButton ausgeführt werden kann.

Das Callback muss entweder einen Boolean (TRUE, FALSE) als Rückgabewert liefern. Als Parameter wird dem Callback eine List mit IndexedElement, oder spezielleren Objekten je nach Ansicht, übergeben. boolean isEnabled(List<IndexedElement> selection)

Wenn WorkspaceAdapter.setScriptButtonEnabled(int, boolean), WorkspaceAdapter.setScriptButtonEnabled(int, String) oder WorkspaceAdapter.setScriptButtonEnabled(int, boolean, boolean, boolean, boolean, boolean, boolean) verwendet wird, wird das Callback nicht verwendet. Diese Aktivierungsregeln übersteuern das Callback.

Parameters:

callbackFunction - JavaScript Funktion, welche aufgerufen wird wenn die Funktion ausgeführt wird.

thisScope - "this" Scope der Funktion

Since:

12.00.000 Neuer Callback-Parameter selection

isEnabled

@Deprecated
public boolean isEnabled()

Deprecated.

12.00.000: Ersetzt durch isEnabled(List). Die Selektion wird mit an das Callback übergeben.

Liefert, ob dieser ScriptButton gerade aktiv ist.

Bei der Verwendung von aktivierungsregeln wird dieser Rückgabewert nicht verwendet, siehe setEnabledCallback(BaseFunction, ScriptableObject).

Returns:

FALSE, falls ein Callback hinterlegt wurde und dieses die Funktion deaktiviert.

isEnabled

public boolean isEnabled(List<IndexedElement> selectedItems)

Liefert, ob dieser ScriptButton gerade aktiv ist.

Bei der Verwendung von aktivierungsregeln wird dieser Rückgabewert nicht verwendet, siehe setEnabledCallback(BaseFunction, ScriptableObject).

Parameters:

selectedItems - Aktuelle Selektion, wird an das Callback übergeben.

Returns:

FALSE, falls ein Callback hinterlegt wurde und dieses die Funktion deaktiviert.

getSearchKeywords

public String getSearchKeywords()

Liefert die Suchbegriffe für die Ribbon-Suche.

Returns:

Suchbegriffe

setSearchKeywords

public void setSearchKeywords(String searchKeywords)

Setzt die Suchbegriffe für die Ribbon-Suche.

Mit diesen Suchbegriffen kann der Script Button in der Ribbon-Suche gefunden werden. Die Suchbegriffe sollten durch einen Pipe "|" getrennt werden.

Parameters:

searchKeywords - Suchbegriffe

isTile

public boolean isTile()

Liefert die Information, ob der Button auch als Kachel angelegt werden soll.

Returns:

TRUE, wenn der Button auch als Kachel angelegt werden soll.

asTile

public void asTile(boolean asTile)

Setzt, ob der Button auch als Kachel im Menü angelegt werden soll.

Wenn die Funktion als Kachel verfügbar ist, sollte sie immer ausführbar sein und keinen speziellen Kontext benötigen (isEnabled() immer TRUE).

Zur optimalen Darstellung muss im ELOwf ein schwarzes, invertierbares Icon hinterlegt und mit setTileIconName(String) gesetzt werden.

Parameters:

asTile - TRUE, damit der Button auch als Kachel angelegt wird.

getTileIconName

public String getTileIconName()

Liefert den Namen des Icons, welches für die Anzeige der Kachel verwendet werden soll.

Returns:

IconName

setTileIconName

public void setTileIconName(String iconName)

Legt fest, welches Icon für die Kachel verwendet werden soll.

Das Icon muss im ELOwf abgelegt werden und sollte zur optimalen Darstellung ein schwarzes, invertierbares Icon sein.

Parameters:

iconName - Name des Icons

getOrdinal

public int getOrdinal()

Setzt eine Zahl für die Sortierung der Skriptbuttons.

Die Zahl gibt die Reihenfolge der Buttons innerhalb eines Bandes und selber Priorität vor.

Returns:

Ordnungszahl

Since:

10.05.000

setOrdinal

public void setOrdinal(int ordinal)

Setzt eine Zahl für die Sortierung der Skriptbuttons.

Die Zahl gibt die Reihenfolge der Buttons innerhalb eines Bandes und selber Priorität vor.

Parameters:

ordinal - Ordnungszahl

Since:

10.05.000

toString

public String toString()

Overrides:

toString in class Object