de.elo.client.scripting.dialog
Class List

java.lang.Object
  de.elo.client.scripting.dialog.List

public class List
extends java.lang.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-2011

Since:

7.00.008

Constructor Summary

List(javax.swing.JList list, de.elo.client.maindialog.Workspace workspace)
Normaler Konstruktor.

Method Summary

void	addChangeEvent(java.lang.String eventName) Fügt ein Scripting-Event hinzu, welches aufgerufen wird, wenn sich die Selektion in der Liste ändert.
void	addData(int index, java.lang.Object data) Fügt einen neuen Einträge an einer bestimmten Stelle in die Liste ein.
java.util.AbstractList	getData() Liefert die enthaltenen Daten als AbstactList-Objekt.
java.lang.Object	getElementAt(int index) Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.
java.lang.Object	getFirstSelected() Liefert den ersten ausgewählen Eintrag der Liste.
java.lang.Object[]	getSelected() Liefert die ausgewählen 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 selektierten Einträge innerhalb der Liste.
void	repaint() Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.
void	setData(java.util.List<java.lang.Object> data) Setzt die Einträge der Liste.
void	setData(java.lang.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(java.lang.Object selectedObject) Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.

Methods inherited from class java.lang.Object

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

Constructor Detail

List

public List(javax.swing.JList list,
            de.elo.client.maindialog.Workspace workspace)

Normaler Konstruktor.

Parameters:

list - Swing-Liste

workspace - Aktueller Arbeitsbereich

Method Detail

setData

public void setData(java.lang.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,
                    java.lang.Object data)

Fügt einen neuen Einträge an einer bestimmten Stelle in die Liste ein.

Parameters:

index - Position in der Liste.

data - Einzufügender Eintrag.

Since:

8.01.000

getData

public java.util.AbstractList getData()

Liefert die enthaltenen Daten als AbstactList-Objekt.

Returns:

Daten

Since:

8.01.000

setData

public void setData(java.util.List<java.lang.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 java.lang.Object getFirstSelected()

Liefert den ersten ausgewählen Eintrag der Liste.

Returns:

Der erste ausgewählte Eintrag oder null falls kein Eintrag ausgewählt ist

Since:

7.00.008

getSelected

public java.lang.Object[] getSelected()

Liefert die ausgewählen 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.

Since:

8.01.000

getSelectedIndices

public int[] getSelectedIndices()

Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.

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 java.lang.Object getElementAt(int index)

Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.

Since:

8.01.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(java.lang.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 selektierten 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.

Since:

8.01.000

repaint

public void repaint()

Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.

Since:

8.01.000

setSelected

public void setSelected(java.lang.Object selectedObject)

Deprecated. UNDER CONSTRUCTION, do not use this function, it may change.

Since:

8.01.000