Klasse ExtraView

Object
ViewAdapter
ExtraView

public class ExtraView extends ViewAdapter

Überschrift: ExtraView

Beschreibung: Ein zusätzlicher Funktionsbereich.

Copyright: Copyright (c) ELO Digital Office GmbH 2011-2016

Seit:
8.01.000
  • Konstruktordetails

    • ExtraView

      public ExtraView(Workspace workspace, String viewName, ExtraNavigationView view, JComponent navigationComponent) throws Exception
      Interner Konstruktor.
      Parameter:
      workspace - Aktueller Arbeitsbereich
      viewName - Name der Ansicht
      view - Interne Komponente für einen zusätzlichen Funktionsbereich
      navigationComponent - Grafische Komponente der Ansicht
      Löst aus:
      Exception - Wenn das Icon nicht geladen werden konnte.
  • Methodendetails

    • setActivateEvent

      public void setActivateEvent(String eventActivation)
      Setzt das Scripting-Event, welches beim Aktivieren (zur Ansicht schalten) dieses Funktionsbereichs gesendet werden soll.
      Parameter:
      eventActivation - Skripting-Event
    • getActivateEvent

      public String getActivateEvent()
      Liefert das Event zurück, das bei der Aktivierung dieser Ansicht gefeuert wird.
      Gibt zurück:
      Scripting-Event
    • setActivateCallback

      public void setActivateCallback(BaseFunction callbackFunction, ScriptableObject thisScope)
      Setzt eine Callback-Funktion, welche beim Aktivieren (zur Ansicht schalten) dieses Funktionsbereichs aufgerufen werden soll.
      Parameter:
      callbackFunction - JavaScript Funktion, welche beim Aktivieren der Ansicht aufgerufen wird.
      thisScope - "this" Scope der Funktion
      Seit:
      10.00.000
    • getActivateCallback

      @Deprecated public ScriptRunner.CallbackContext getActivateCallback()
      Veraltet.
      Nur für interne Nutzung
      Liefert das Callback zurück, das bei der Aktivierung dieser Ansicht gefeuert wird.
      Gibt zurück:
      Callback
    • setHasPreview

      public void setHasPreview(boolean hasPreview)
      Legt fest, ob in diesem Funktionsbereich der Vorschaubereich verwendet werden soll.
      Parameter:
      hasPreview - True für Vorschaubereich verwenden, False für keinen Vorschaubereich.
    • setContextTaskGroup

      public void setContextTaskGroup(String taskGroupName)
      Setzt eine Ribbon-Task-Gruppe, welche immer dann eingeblendet wird, wenn diese Ansicht aktiv ist.
      Parameter:
      taskGroupName - Name der Ribbon-Task-Group
    • getTaskGroupName

      public String getTaskGroupName()
      Liefert die Bezeichnung der Ribbon-Gruppe für diese Ansicht zurück.
      Gibt zurück:
      Bezeichnung der Ribbon-Gruppe oder null
    • setIcon

      public void setIcon(ArchiveDocument iconDocument) throws Exception
      Setzt das Icon für die Schaltfläche zu diesem Funktionsbereich.

      Das Icon sollte Ebenen mit 24px (kleine Kachel) und 48px (große Kachel) haben, sowie 96px für den Einsatz auf Retina Displays.

      Parameter:
      iconDocument - Archiveintrag des Icons
      Löst aus:
      Exception - Wenn das Icon nicht aus der Datei geladen werden kann.
      Seit:
      8.01.000 PNG, 9.02.000 ICO Unterstützung
    • setViewId

      public void setViewId(String id)
      Setzt einen eindeutiger Bezeichner für diesen Funktionsbereich, damit er von anderen Bereichen mit evtl. gleichem Namen unterschieden werden kann.
      Parameter:
      id - Eindeutiger Bezeichner für diesen Funktionsbereich
      Seit:
      8.04.000
    • getViewId

      public String getViewId()
      Liefert den eindeutigen Bezeichner für diesen Funktionsbereich.
      Gibt zurück:
      Eindeutiger Bezeichner für diesen Funktionsbereich
      Seit:
      8.04.000
    • getAllSelected

      public Enumeration<?> getAllSelected() throws Exception
      Beschreibung aus Klasse kopiert: ViewAdapter
      Liefert alle selektierten Elemente.
      Angegeben von:
      getAllSelected in Klasse ViewAdapter
      Gibt zurück:
      Aufzählung mit selektierten Elementen der Klasse IndexedElement.
      Löst aus:
      Exception - Wenn die Elemente nicht gelesen werden können.
    • getFirstSelected

      public IndexedElement getFirstSelected() throws Exception
      Beschreibung aus Klasse kopiert: ViewAdapter
      Liefert das erste selektierte Element.
      Angegeben von:
      getFirstSelected in Klasse ViewAdapter
      Gibt zurück:
      Das erste selektierte Element oder null, falls keine Selektion vorhanden ist
      Löst aus:
      Exception - Wenn das Element nicht gelesen werden kann.
    • getName

      public String getName()
      Beschreibung aus Klasse kopiert: ViewAdapter
      Gibt den Namen der Ansicht zurück. Bei Archivansichten ist das der Name des Root-Elements, bei anderen Ansichten der Name der Ansicht "Archive: (Rootname)", "Checkout", "Clipboard", "Search", "Task", "Intray".
      Angegeben von:
      getName in Klasse ViewAdapter
      Gibt zurück:
      String
    • getNavigationComponent

      public JComponent getNavigationComponent()
      Liefert die grafische Komponente der Ansicht zurück.
      Gibt zurück:
      Grafische Komponente der Ansicht
      Seit:
      9.02.001
    • getSelectionCount

      public int getSelectionCount()
      Beschreibung aus Klasse kopiert: ViewAdapter
      Liefert die Anzahl an selektieren Elementen dieser Ansicht.
      Angegeben von:
      getSelectionCount in Klasse ViewAdapter
      Gibt zurück:
      int Anzahl selektierte Elemente
    • hasSelection

      public boolean hasSelection()
      Beschreibung aus Klasse kopiert: ViewAdapter
      Prüft ob mindestens ein Element in diesem Funktionsbereich selektiert wurde.
      Angegeben von:
      hasSelection in Klasse ViewAdapter
      Gibt zurück:
      True wenn eine Selektion vorhanden ist, sonst False
    • refresh

      public void refresh()
      Beschreibung aus Klasse kopiert: ViewAdapter
      Aktualisiert den Inhalt dieser Ansicht.
      Angegeben von:
      refresh in Klasse ViewAdapter