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 Details

  • Method Details

    • getTabId

      @Deprecated(since="20.03") public String getTabId()
      Deprecated.
      20.03 Ersetzt durch getPositions()
      Liefert die Id des ersten Tabs, welchem der Button zugeordnet wurde.
      Returns:
      Tab Id

    • getBandId

      @Deprecated(since="20.03") public String getBandId()
      Deprecated.
      20.03 Ersetzt durch getPositions()
      Liefert die Id des ersten Bandes, 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

    • addPosition

      public RibbonPosition addPosition(String tabId, String bandId)
      Fügt dem Button die neue Position hinzu.
      Parameters:
      tabId - Tab Id
      bandId - Band Id
      Since:
      20.03

    • getPositions

      public List<RibbonPosition> getPositions()
      Gibt eine Liste der RibbonButtonPositions des Buttons zurck
      Returns:
      unmodifiableList RibbonPosition
      Since:
      20.03

    • 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. *

      Als Parameter wird dem Callback eine List mit IndexedElement, oder spezielleren Objekten je nach Ansicht, übergeben. void execute(List<IndexedElement> selection)

      Parameters:
      callbackFunction - JavaScript Funktion, welche aufgerufen wird wenn die Funktion ausgeführt wird.
      thisScope - "this" Scope der Funktion
      Since:
      21.00.000 Neuer Callback-Parameter selection

    • execute

      public void execute(List<IndexedElement> selection)
      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.

      Parameters:
      selection -

    • 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

      @Deprecated(since="20.03") public int getOrdinal()
      Deprecated.
      20.03 Ersetzt durch #getOrdinal()
      Setzt eine Zahl fr die Sortierung der Skriptbuttons.

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

      Returns:
      Ordnungszahl
      Since:
      10.05.000

    • setOrdinal

      @Deprecated(since="20.03") public void setOrdinal(int ordinal)
      Deprecated.
      20.03 Ersetzt durch #setOrdinal()
      Setzt eine Zahl fr die Sortierung der Skriptbuttons.

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

      Parameters:
      ordinal - Ordnungszahl
      Since:
      10.05.000

    • setDefaultPinState

      public void setDefaultPinState(boolean defaultPinState)
      Setzt den Standardwert, ob der Button im Menüband angeheftet ist oder nicht.

      Dies gilt nur, wenn der Zustand nicht durch die Einstellungen des Benutzers überschrieben wird

      Parameters:
      defaultPinState - TRUE um den Button anzuheften
      Since:
      20.01

    • getDefaultPinState

      public boolean getDefaultPinState()
      Liefert den Standardwert, ob der Button im Menüband angeheftet ist oder nicht.

      Dies gilt nur, wenn der Zustand nicht durch die Einstellungen des Benutzers überschrieben wird

      Returns:
      Standard-Angeheftet-Zustand des Buttons
      Since:
      20.01

    • toString

      public String toString()
      Overrides:
      toString in class Object