Package de.elo.client.scripting.interfaces

Class RibbonAdapter

Object
RibbonAdapter
public class RibbonAdapter extends Object

Überschrift: RibbonAdapter.

Beschreibung: Kapselt den Zugriff auf die Ribbons gegenüber dem Script. Im Scripting verfügbar als "ribbon".

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.

Beispiel, ELO 12.00.000: 
 
 function allFolders(selectedItems){
   if(selectedItems.size() == 0) return false;
   for(var i = 0; i < selectedItems.size(); i++){
      if(!selectedItems.get(i).isStructure()){
         return false;
      }
   }
   return true;
}

function atleastOneFolder(selectedItems){
   for(var i = 0; i < selectedItems.size(); i++){
      if(selectedItems.get(i).isStructure()){
         return true;
      }
   }
   return false;
}

function eloExpandRibbon(){
      var tab = ribbon.addTab(11, null, "tab1");
      tab.setTitle("Visible on folders");
      tab.setVisibleCallback(atleastOneFolder, this);
   
      var band = ribbon.addBand(tab.getId(), "1", "band1");
      band.setTitle("Band 1");
      
      var button = ribbon.addButton(tab.getId(), band.getId(), "button1");
      button.setOrdinal(1);
      button.setTitle("Button 1");
      button.setEnabledCallback(allFolders, this);
      button.setCallback(function(){ log.info("button clicked!"); }, this);
}

Copyright: Copyright (c) ELO Digital Office GmbH 2018

Since:
10.00.000

  • Constructor Details

    • RibbonAdapter

      public RibbonAdapter(Workspace workspace, ScriptButtonManager buttonManager)
      Konstruktor.
      Parameters:
      workspace - Aktueller Arbeitsbereich
      buttonManager - Script Button Manager

  • Method Details

    • addTab

      public RibbonScriptTab addTab(int pos, String taskGroup, String newTabId)
      Fügt ein neuen Ribbon-Tab ein.

      Die Tab Id muss eindeutig sein und darf auch nicht bereits vom Client verwendet werden, damit Bänder und Buttons korrekt zugeordnet werden können.

      Parameters:
      pos - Position der Script-Tabs. 0-9 vor Start, 11-19 nach Start, 21-29 nach Dokument, ...
      taskGroup - Tabgruppe, oder null falls der Tab immer sichtbar sein soll.
      newTabId - Tab-ID für die Zuordnung von Buttons und Bändern.
      Returns:
      Scripting Ribbon Tab.

    • getTab

      public RibbonScriptTab getTab(String tabId)
      Liefert den ScriptTab mit der angegebenen Id.
      Parameters:
      tabId - Tab Id
      Returns:
      Button oder NULL, falls kein ScriptTab mit dieser Id existiert.

    • getTabs

      public List<RibbonScriptTab> getTabs()
      Liefert eine Liste aller ScriptTabs.
      Returns:
      Liste der Tabs
      Since:
      12.16, 20.12, 21.03.001

    • addBand

      public RibbonScriptBand addBand(String tabId, int pos, String newBandId)
      Fügt ein neues Band in einen Ribbon-Tab ein.

      Die Kombination aus Tab Id und Band Id muss eindeutig sein und darf auch nicht bereits vom Client verwendet werden, damit die Buttons korrekt zugeordnet werden können.

      Parameters:
      tabId - ID des Tabs, in welches das Band eingefügt werden soll.
      pos - Position der Script-Bänder dieses Tabs. 0-9 für die ersten Positionen, 11-19 für Positionen nach dem ersten Standard-Band, 21-29 nach dem zweiten Standard-Band, ...
      newBandId - Band-ID für die Zuordnung von Buttons.
      Returns:
      Scripting Ribbon Band.

    • getBand

      public RibbonScriptBand getBand(String tabId, String bandId)
      Liefert das ScriptBand mit der Band Id aus dem angegebenen Tab.
      Parameters:
      tabId - Tab Id
      bandId - Band Id
      Returns:
      Band oder NULL, falls kein ScriptBand mit dieser Id im angegebenen Tab existiert.

    • getBands

      public List<RibbonScriptBand> getBands()
      Liefert eine Liste aller Script Bänder.
      Returns:
      Liste der Gruppen
      Since:
      12.16, 20.12, 21.03.001

    • addButton

      public RibbonScriptButton addButton(String tabId, String bandId, String buttonId)
      Füt einen neuen Button in ein Ribbon-Band ein.

      Die Button Id muss eindeutig sein und darf auch nicht in anderen Tabs oder Bändern verwendet werden.

      Eine Auflistung der Funktionen und ihren Positionen im Ribbon befindet sich hier und in der Java Client Scripting Dokumentation.

      Parameters:
      tabId - Id des Tabs, in welches der Button eingefügt werden soll.
      bandId - Id des Bands, in welches der Button eingefügt werden soll.
      buttonId - Id des Buttons, nur Buchstaben, Ziffern sowie - und _ erlaubt.
      Returns:
      ScriptButton

    • getButton

      public RibbonScriptButton getButton(String buttonId)
      Liefert den ScriptButton mit der angegebenen Id.
      Parameters:
      buttonId - Button Id
      Returns:
      Button oder NULL, falls kein ScriptButton mit dieser Id existiert.

    • getButtons

      public List<RibbonScriptButton> getButtons()
      Liefert eine Liste aller ScriptButtons.
      Returns:
      Liste der Buttons
      Since:
      12.16, 20.12, 21.03.001