de.elo.client.scripting.components
Class ExtraView

java.lang.Object
  extended by de.elo.client.scripting.interfaces.ViewAdapter
      extended by de.elo.client.scripting.components.ExtraView

public class ExtraView
extends ViewAdapter

Überschrift: ExtraView

Beschreibung: Ein zusätzlicher Funktionsbereich.

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

Since:
8.01.000

Constructor Summary
ExtraView(de.elo.client.maindialog.Workspace workspace, java.lang.String viewName, boolean closeable, de.elo.client.scripting.internal.tree.ExtraNavigationView view, javax.swing.JComponent navigationComponent)
          Normaler Konstruktor
 
Method Summary
 java.lang.String getActivateEvent()
           
 java.util.Enumeration<?> getAllSelected()
          Liefert alle selektierten Elemente.
 IndexedElement getFirstSelected()
          Liefert das erste selektierte Element.
 java.lang.String getName()
          Gibt den Namen der Ansicht zurück.
 int getSelectionCount()
          Liefert die Anzahl an selektieren Elementen dieser Ansicht.
 java.lang.String getTaskGroupName()
           
 boolean hasSelection()
          Prüft ob mindestens ein Element in diesem Funktionsbereich selektiert wurde.
 void refresh()
          Aktualisiert den Inhalt dieser Ansicht.
 void setActivateEvent(java.lang.String eventActivation)
          Setzt das Scripting-Event, welches beim Aktivieren (zur Ansicht schalten) dieses Funktionsbereichs gesendet werden soll.
 void setContextTaskGroup(java.lang.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.
 
Methods inherited from class de.elo.client.scripting.interfaces.ViewAdapter
show
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExtraView

public ExtraView(de.elo.client.maindialog.Workspace workspace,
                 java.lang.String viewName,
                 boolean closeable,
                 de.elo.client.scripting.internal.tree.ExtraNavigationView view,
                 javax.swing.JComponent navigationComponent)
Normaler Konstruktor

Parameters:
workspace -
viewName -
closeable -
view -
navigationComponent -
Method Detail

setActivateEvent

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

Parameters:
eventActivation -

getActivateEvent

public java.lang.String getActivateEvent()

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(java.lang.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 java.lang.String getTaskGroupName()

setIcon

public void setIcon(ArchiveDocument iconDocument)
             throws java.lang.Exception
Setzt das Icon für die Schaltfläche zu diesem Funktionsbereich. Das Icon muss ein PNG in der Größe 24x24 Pixel mit Alphatransparenz sein.

Parameters:
iconDocument - Archiveintrag des Icons
Throws:
java.lang.Exception

getAllSelected

public java.util.Enumeration<?> getAllSelected()
                                        throws java.lang.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:
java.lang.Exception

getFirstSelected

public IndexedElement getFirstSelected()
                                throws java.lang.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:
java.lang.Exception

getName

public java.lang.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", "Tasks", "Intray".

Specified by:
getName in class ViewAdapter
Returns:
String

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