Package de.elo.client.scripting.components

Class 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

Since:
8.01.000

  • Constructor Summary

    Constructors 
    Constructor Description
    ExtraView​(Workspace workspace, String viewName, ExtraNavigationView view, JComponent navigationComponent)
    Interner Konstruktor.

  • Method Summary

    Modifier and Type Method Description
    ScriptRunner.CallbackContext getActivateCallback()
    Deprecated.
    Nur für interne Nutzung
    String getActivateEvent()
    Liefert das Event zurück, das bei der Aktivierung dieser Ansicht gefeuert wird.
    Enumeration<?> getAllSelected()
    Liefert alle selektierten Elemente.
    IndexedElement getFirstSelected()
    Liefert das erste selektierte Element.
    String getName()
    Gibt den Namen der Ansicht zurück.
    JComponent getNavigationComponent()
    Liefert die grafische Komponente der Ansicht zurück.
    int getSelectionCount()
    Liefert die Anzahl an selektieren Elementen dieser Ansicht.
    String getTaskGroupName()
    Liefert die Bezeichnung der Ribbon-Gruppe für diese Ansicht zurück.
    String getViewId()
    Liefert den eindeutigen Bezeichner für diesen Funktionsbereich.
    boolean hasSelection()
    Prüft ob mindestens ein Element in diesem Funktionsbereich selektiert wurde.
    void refresh()
    Aktualisiert den Inhalt dieser Ansicht.
    void setActivateCallback​(BaseFunction callbackFunction, ScriptableObject thisScope)
    Setzt eine Callback-Funktion, welche beim Aktivieren (zur Ansicht schalten) dieses Funktionsbereichs aufgerufen werden soll.
    void setActivateEvent​(String eventActivation)
    Setzt das Scripting-Event, welches beim Aktivieren (zur Ansicht schalten) dieses Funktionsbereichs gesendet werden soll.
    void setContextTaskGroup​(String taskGroupName)
    Setzt eine Ribbon-Task-Gruppe, welche immer dann eingeblendet wird, wenn diese Ansicht aktiv ist.
    void setHasPreview​(boolean hasPreview)
    Legt fest, ob in diesem Funktionsbereich der Vorschaubereich verwendet werden soll.
    void setIcon​(ArchiveDocument iconDocument)
    Setzt das Icon für die Schaltfläche zu diesem Funktionsbereich.
    void setViewId​(String id)
    Setzt einen eindeutiger Bezeichner für diesen Funktionsbereich, damit er von anderen Bereichen mit evtl. gleichem Namen unterschieden werden kann.

    Methods inherited from class ViewAdapter

    getAllSelectedArchiveElements, getColumnNames, getFirstSelectedArchiveElement, getOriginalName, getViewName, isShown, refreshArchive, setSortColumn, show

    Methods inherited from class Object

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

  • Constructor Details

    • ExtraView

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

  • Method Details

    • setActivateEvent

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

    • getActivateEvent

      public String getActivateEvent()
      Liefert das Event zurück, das bei der Aktivierung dieser Ansicht gefeuert wird.
      Returns:
      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.
      Parameters:
      callbackFunction - JavaScript Funktion, welche beim Aktivieren der Ansicht aufgerufen wird.
      thisScope - "this" Scope der Funktion
      Since:
      10.00.000

    • getActivateCallback

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

    • setHasPreview

      public void setHasPreview​(boolean hasPreview)
      Legt fest, ob in diesem Funktionsbereich der Vorschaubereich verwendet werden soll.
      Parameters:
      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.
      Parameters:
      taskGroupName - Name der Ribbon-Task-Group

    • getTaskGroupName

      public String getTaskGroupName()
      Liefert die Bezeichnung der Ribbon-Gruppe für diese Ansicht zurück.
      Returns:
      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.

      Parameters:
      iconDocument - Archiveintrag des Icons
      Throws:
      Exception - Wenn das Icon nicht aus der Datei geladen werden kann.
      Since:
      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.
      Parameters:
      id - Eindeutiger Bezeichner für diesen Funktionsbereich
      Since:
      8.04.000

    • getViewId

      public String getViewId()
      Liefert den eindeutigen Bezeichner für diesen Funktionsbereich.
      Returns:
      Eindeutiger Bezeichner für diesen Funktionsbereich
      Since:
      8.04.000

    • getAllSelected

      public Enumeration<?> getAllSelected() throws Exception
      Description copied from class: ViewAdapter
      Liefert alle selektierten Elemente.
      Specified by:
      getAllSelected in class ViewAdapter
      Returns:
      Aufzählung mit selektierten Elementen der Klasse IndexedElement.
      Throws:
      Exception - Wenn die Elemente nicht gelesen werden können.

    • getFirstSelected

      public IndexedElement getFirstSelected() throws Exception
      Description copied from class: ViewAdapter
      Liefert das erste selektierte Element.
      Specified by:
      getFirstSelected in class ViewAdapter
      Returns:
      Das erste selektierte Element oder null, falls keine Selektion vorhanden ist
      Throws:
      Exception - Wenn das Element nicht gelesen werden kann.

    • getName

      public String getName()
      Description copied from class: 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".
      Specified by:
      getName in class ViewAdapter
      Returns:
      String

    • getNavigationComponent

      public JComponent getNavigationComponent()
      Liefert die grafische Komponente der Ansicht zurück.
      Returns:
      Grafische Komponente der Ansicht
      Since:
      9.02.001

    • getSelectionCount

      public int getSelectionCount()
      Description copied from class: ViewAdapter
      Liefert die Anzahl an selektieren Elementen dieser Ansicht.
      Specified by:
      getSelectionCount in class ViewAdapter
      Returns:
      int Anzahl selektierte Elemente

    • hasSelection

      public boolean hasSelection()
      Description copied from class: ViewAdapter
      Prüft ob mindestens ein Element in diesem Funktionsbereich selektiert wurde.
      Specified by:
      hasSelection in class ViewAdapter
      Returns:
      True wenn eine Selektion vorhanden ist, sonst False

    • refresh

      public void refresh()
      Description copied from class: ViewAdapter
      Aktualisiert den Inhalt dieser Ansicht.
      Specified by:
      refresh in class ViewAdapter