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

Class RibbonScriptTab

Object
RibbonScriptTab
All Implemented Interfaces:
Comparable<RibbonScriptTab>
public class RibbonScriptTab
extends Object
implements Comparable<RibbonScriptTab>

Überschrift: RibbonScriptTab.

Beschreibung: Ein per Script erstelltes Ribbon-Tab.

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
    RibbonScriptTab​(int pos, String taskGroup, String tabId)
    Nur zur Internen verwendung.

  • Method Summary

    Modifier and Type Method Description
    int compareTo​(RibbonScriptTab o)  
    String getId()
    Liefert die Id dieses Tabs.
    int getPos()
    Liefert die Angabe, an welcher Position das Tab im Ribbon eingefügt werden soll.
    String getTaskGroup()
    Liefert die Id der Tab-Gruppe, welcher das Tab zugeordnet ist.
    String getTitle()
    Liefert den Titel des Tabs, welcher im Ribbon angezeigt wird.
    boolean isVisible​(List<IndexedElement> selectedItems)
    Liefert, ob dieser ScriptButton gerade aktiv ist.
    void setTitle​(String title)
    Setzt den Titel des Tabs, welcher im Ribbon angezeigt wird.
    void setVisibleCallback​(BaseFunction callbackFunction, ScriptableObject thisScope)
    Setzt eine JavaScript-Funktion als Callback, über welche gesteuert wird ob dieser Tab angezeigt wird.

    Methods inherited from class Object

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

  • Constructor Details

  • Method Details

    • compareTo

      public int compareTo​(RibbonScriptTab o)
      Specified by:
      compareTo in interface Comparable<RibbonScriptTab>

    • getTitle

      public String getTitle()
      Liefert den Titel des Tabs, welcher im Ribbon angezeigt wird.
      Returns:
      Titel

    • setTitle

      public void setTitle​(String title)
      Setzt den Titel des Tabs, welcher im Ribbon angezeigt wird.
      Parameters:
      title - Titel

    • getTaskGroup

      public String getTaskGroup()
      Liefert die Id der Tab-Gruppe, welcher das Tab zugeordnet ist.
      Returns:
      Gruppen Id oder null, falls das Tab keiner Gruppe zugeordnet ist.

    • getPos

      public int getPos()
      Liefert die Angabe, an welcher Position das Tab im Ribbon eingefügt werden soll.
      Returns:
      Position

    • getId

      public String getId()
      Liefert die Id dieses Tabs.
      Returns:
      Tab Id

    • setVisibleCallback

      public void setVisibleCallback​(BaseFunction callbackFunction, ScriptableObject thisScope)
      Setzt eine JavaScript-Funktion als Callback, über welche gesteuert wird ob dieser Tab angezeigt wird.

      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 isVisible(List<IndexedElement> selection)

      Parameters:
      callbackFunction - JavaScript Funktion, welche bei Selektionsänderungen aufgerufen wird.
      thisScope - "this" Scope der Funktion
      Since:
      12.00.000

    • isVisible

      public boolean isVisible​(List<IndexedElement> selectedItems)
      Liefert, ob dieser ScriptButton gerade aktiv ist.

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

      Parameters:
      selectedItems - Aktuelle Selektion, wird an das Callback übergeben.
      Returns:
      FALSE, falls ein Callback hinterlegt wurde und dieses die Funktion deaktiviert.
      Since:
      12.00.000