Package de.elo.client.scripting.dialog

Class List

Object
List
public class List
extends Object

Überschrift: List

Beschreibung: Eine List von Einträgem zur Verwendung im GridDialog des Internen Scripting. Per default kann nur ein Eintrag in der Liste ausgewählt werden. Mit setMultiselect() ist ein Umstellen auf Mehrfach-Auswahl möglich. UserName Objekte werden in der typischen Optik des Client mit Icon und Namen dargestellt.

Copyright: Copyright (c) ELO Digital Office GmbH 2010-2014

Since:
7.00.008

  • Constructor Summary

    Constructors 
    Constructor Description
    List​(JList<Object> list, Workspace workspace)
    Normaler Konstruktor.

  • Method Summary

    Modifier and Type Method Description
    void addChangeEvent​(String eventName)
    Fügt ein Scripting-Event hinzu, welches aufgerufen wird, wenn sich die Selektion in der Liste ändert.
    void addData​(int index, Object data)
    Fügt einen neuen Eintrag an einer bestimmten Stelle in die Liste ein.
    Enumeration<Object> getAllSelected()
    Liefert eine Liste mit allen selektierten Einträgen aus.
    AbstractList<Object> getData()
    Liefert die enthaltenen Daten als AbstactList-Objekt.
    Object getDataAt​(int index)
    Liefert den Eintrag an der angegebenen Stelle der Liste.
    Object getElementAt​(int index)
    Deprecated.
    Ersetzt durch getDataAt(int)
    Object getFirstSelected()
    Liefert den ersten ausgewählten Eintrag der Liste.
    Object[] getSelected()
    Liefert die ausgewählten Einträge der Liste.
    int getSelectedIndex()
    Deprecated.
    UNDER CONSTRUCTION, do not use this function, it may change.
    int[] getSelectedIndices()
    Deprecated.
    UNDER CONSTRUCTION, do not use this function, it may change.
    int getSelectionCount()
    Liefert die Anzahl an selektieren Einträgen in dieser Liste.
    boolean hasSelection()
    Prüft ob mindestens ein Eintrag selektiert wurde.
    void move​(int offset, int[] indices)
    Deprecated.
    UNDER CONSTRUCTION, do not use this function, it may change.
    void moveSelected​(int offset)
    Verschiebt die aktuell ausgewählten Einträge innerhalb der Liste.
    void removeData​(Object[] toRemove)
    Entfernt die Einträge aus der Liste.
    void repaint()
    Aktualisiert die Darstellung der Liste.
    void setData​(Object[] data)
    Setzt die Einträge der Liste.
    void setData​(List<Object> data)
    Setzt die Einträge der Liste.
    void setEnabled​(boolean enabled)
    Legt fest, ob die Liste aktiv ist (Listeneinträge können ausgewählt werden).
    void setMultiselect​(boolean multiselect)
    Legt fest, ob in der Liste mehrere Einträge ausgewählt werden dürfen.
    void setSelected​(Object selectedObject)
    Markiert einen einzelnen Einträge in der Liste als ausgewählt.
    void setSelected​(Object[] selectedObjects)
    Markiert Einträge in der Liste als ausgewählt.
    void setVisible​(boolean visible)
    Setzt die Sichtbarkeit der Liste.

    Methods inherited from class Object

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

  • Constructor Details

    • List

      public List​(JList<Object> list, Workspace workspace)
      Normaler Konstruktor.
      Parameters:
      list - Swing-Liste
      workspace - Aktueller Arbeitsbereich

  • Method Details

    • setData

      public void setData​(Object[] data)
      Setzt die Einträge der Liste. Wenn die Liste aus UserName-Objekten besteht, wird die Optik der Liste entsprechend angepasst. Bei JComponent-Objekten werden diese direkt als Listeneinträge dargestellt, ansonsten wir toString() benutzt.
      Parameters:
      data - Listeneinträge als ein Array
      Since:
      7.00.008

    • addData

      public void addData​(int index, Object data)
      Fügt einen neuen Eintrag an einer bestimmten Stelle in die Liste ein.
      Parameters:
      index - Position in der Liste.
      data - Einzufügender Listeneintrag.
      Since:
      8.01.000

    • removeData

      public void removeData​(Object[] toRemove)
      Entfernt die Einträge aus der Liste.
      Parameters:
      toRemove - Zu entfernende Einträge
      Since:
      8.04.000

    • getData

      public AbstractList<Object> getData()
      Liefert die enthaltenen Daten als AbstactList-Objekt.
      Returns:
      Daten
      Since:
      8.01.000

    • setData

      public void setData​(List<Object> data)
      Setzt die Einträge der Liste. Wenn die Liste aus UserName-Objekten besteht, wird die Optik der Liste entsprechend angepasst. Bei JComponent-Objekten werden diese direkt als Listeneinträge dargestellt, ansonsten wir toString() benutzt.
      Parameters:
      data - Listeneinträge als eine Liste
      Since:
      7.00.008

    • getFirstSelected

      public Object getFirstSelected()
      Liefert den ersten ausgewählten Eintrag der Liste.
      Returns:
      Der erste ausgewählte Eintrag oder null falls kein Eintrag ausgewählt ist
      Since:
      7.00.008

    • getAllSelected

      public Enumeration<Object> getAllSelected()
      Liefert eine Liste mit allen selektierten Einträgen aus.
      Returns:
      Aufzählung der selektieren Einträge.
      Since:
      10.00.000

    • getSelected

      public Object[] getSelected()
      Liefert die ausgewählten Einträge der Liste.
      Returns:
      Liste mit ausgewählten Einträgen
      Since:
      7.00.008

    • getSelectedIndex

      public int getSelectedIndex()
      Deprecated.
      UNDER CONSTRUCTION, do not use this function, it may change.
      Returns:
      Selektierten Index
      Since:
      8.01.000

    • getSelectedIndices

      public int[] getSelectedIndices()
      Deprecated.
      UNDER CONSTRUCTION, do not use this function, it may change.
      Returns:
      Liste mit den selektierten Indizes
      Since:
      8.01.000

    • hasSelection

      public boolean hasSelection()
      Prüft ob mindestens ein Eintrag selektiert wurde.
      Returns:
      True wenn eine Selektion vorhanden ist, False wenn keine Selektion vorhanden ist.
      Since:
      8.01.000

    • getSelectionCount

      public int getSelectionCount()
      Liefert die Anzahl an selektieren Einträgen in dieser Liste.
      Returns:
      Anzahl selektierte Einträge
      Since:
      8.01.000

    • getElementAt

      public Object getElementAt​(int index)
      Deprecated.
      Ersetzt durch getDataAt(int)
      Liefert den Eintrag an der angegebenen Stelle der Liste.
      Parameters:
      index - Position in der Liste.
      Returns:
      Listeneintrag
      Since:
      8.01.000

    • getDataAt

      public Object getDataAt​(int index)
      Liefert den Eintrag an der angegebenen Stelle der Liste.
      Parameters:
      index - Position in der Liste.
      Returns:
      Listeneintrag oder null, falls diese Stelle in der Liste nicht vorhanden ist.
      Since:
      8.04.000

    • setEnabled

      public void setEnabled​(boolean enabled)
      Legt fest, ob die Liste aktiv ist (Listeneinträge können ausgewählt werden).
      Parameters:
      enabled - True wenn die Auswahl in der Liste geändert werden kann, False wenn die Auswahl nicht änderbar ist
      Since:
      7.00.008

    • setMultiselect

      public void setMultiselect​(boolean multiselect)
      Legt fest, ob in der Liste mehrere Einträge ausgewählt werden dürfen.
      Parameters:
      multiselect - True wenn eine Mehrfach-Auswahl möglich sein soll, False wenn nur ein einzelner Eintrag selektiert werden darf
      Since:
      7.00.008

    • addChangeEvent

      public void addChangeEvent​(String eventName)
      Fügt ein Scripting-Event hinzu, welches aufgerufen wird, wenn sich die Selektion in der Liste ändert.
      Parameters:
      eventName - Name des Scripting-Events
      Since:
      7.00.008

    • moveSelected

      public void moveSelected​(int offset)
      Verschiebt die aktuell ausgewählten Einträge innerhalb der Liste.
      Parameters:
      offset - Der Betrag um den verschoben werden soll: negative Werte verschieben nach oben, positive nach unten.
      Since:
      8.01.000

    • move

      public void move​(int offset, int[] indices)
      Deprecated.
      UNDER CONSTRUCTION, do not use this function, it may change.
      Parameters:
      offset - Versatz
      indices - Liste mit Indizes
      Since:
      8.01.000

    • repaint

      public void repaint()
      Aktualisiert die Darstellung der Liste. Dies ist notwendig, wenn sich die sichtbaren Bereiche geändert haben, z.B. der Text eines Labels in der Liste.
      Since:
      8.01.000

    • setSelected

      public void setSelected​(Object selectedObject)
      Markiert einen einzelnen Einträge in der Liste als ausgewählt.
      Parameters:
      selectedObject - Der auszuwählende Eintrag
      Since:
      8.01.000

    • setSelected

      public void setSelected​(Object[] selectedObjects)
      Markiert Einträge in der Liste als ausgewählt.
      Parameters:
      selectedObjects - Die auszuwählenden Einträge
      Since:
      8.04.000

    • setVisible

      public void setVisible​(boolean visible)
      Setzt die Sichtbarkeit der Liste.
      Parameters:
      visible - True für sichtbar, False für unsichtbar.
      Since:
      8.01.006